genie::PetersonFragm Class Reference

The Peterson fragmentation function. Is a concrete implementation of the FragmentationFunctionI interface. More...

#include <PetersonFragm.h>

Inheritance diagram for genie::PetersonFragm:

Collaboration diagram for genie::PetersonFragm:

Public Member Functions
	PetersonFragm ()
	PetersonFragm (string config)
	~PetersonFragm ()
double	Value (double z) const
	implement the FragmentationFunctionI interface
double	GenerateZ (void) const
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::FragmentationFunctionI
virtual	~FragmentationFunctionI ()
Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Private Member Functions
void	BuildFunction (void)

Private Attributes
TF1 *	fFunc

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)
Protected Member Functions inherited from genie::FragmentationFunctionI
	FragmentationFunctionI ()
	FragmentationFunctionI (string name)
	FragmentationFunctionI (string name, string config)
Protected Member Functions inherited from genie::Algorithm
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.
Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Detailed Description

The Peterson fragmentation function. Is a concrete implementation of the FragmentationFunctionI interface.

References:\n C.Peterson et al., Phys.Rev.D23, 56 (1981)

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n June 15, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 31 of file PetersonFragm.h.

Constructor & Destructor Documentation

PetersonFragm() [1/2]

PetersonFragm::PetersonFragm

(

)

Definition at line 19 of file PetersonFragm.cxx.

                             :
FragmentationFunctionI("genie::PetersonFragm")
{
 
}

References genie::FragmentationFunctionI::FragmentationFunctionI().

PetersonFragm() [2/2]

PetersonFragm::PetersonFragm

(

string

config

)

Definition at line 25 of file PetersonFragm.cxx.

                                          :
FragmentationFunctionI("genie::PetersonFragm", config)
{
  this->BuildFunction();
}

References BuildFunction(), and genie::FragmentationFunctionI::FragmentationFunctionI().

~PetersonFragm()

PetersonFragm::~PetersonFragm

(

)

Definition at line 31 of file PetersonFragm.cxx.

{
  delete fFunc;
}

References fFunc.

Member Function Documentation

BuildFunction()

void PetersonFragm::BuildFunction ( void )

private

Definition at line 63 of file PetersonFragm.cxx.

{
  fFunc = new TF1("fFunc",genie::utils::frgmfunc::peterson_func,0,1,2);
 
  fFunc->SetParNames("Norm","Epsilon");
  // stop ROOT from deleting this object of its own volition
  gROOT->GetListOfFunctions()->Remove(fFunc);
 
  double N = -1. ;
  GetParam( "PetFrag-Norm", N, false ) ;
 
  //The xml files says that Epsilon is not optional, while the
  //orignal behaviour of this function assigned a 0 default value
  //if the xml file was not providing such a number.
  // Original behaviour maintained
  double e = 0. ;
  GetParam( "PetFrag-Epsilon", e, false ) ;
 
  // if the normalization parameter was left negative, explicitly normalize
  // the fragmentation function
  if(N<0) {
    N=1;
    fFunc->SetParameters(N,e);
    double I = fFunc->Integral(0,1);
    assert(I>0);
    N = 1./I;
  }
  fFunc->SetParameters(N,e);
}

References e, fFunc, genie::Algorithm::GetParam(), and genie::utils::frgmfunc::peterson_func().

Referenced by Configure(), Configure(), and PetersonFragm().

Configure() [1/2]

void PetersonFragm::Configure ( const Registry & config )

virtual

methods overloading the Algorithm() interface implementation to build the fragmentation function from configuration data

Reimplemented from genie::Algorithm.

Definition at line 51 of file PetersonFragm.cxx.

{
  Algorithm::Configure(config);
  this->BuildFunction();
}

References BuildFunction(), and genie::Algorithm::Configure().

Configure() [2/2]

void PetersonFragm::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 57 of file PetersonFragm.cxx.

{
  Algorithm::Configure(config);
  this->BuildFunction();
}

References BuildFunction(), and genie::Algorithm::Configure().

GenerateZ()

double PetersonFragm::GenerateZ ( void ) const

virtual

Implements genie::FragmentationFunctionI.

Definition at line 44 of file PetersonFragm.cxx.

{
// Return a random number using the fragmentation function as PDF
 
  return fFunc->GetRandom();
}

References fFunc.

Value()

double PetersonFragm::Value ( double z ) const

virtual

implement the FragmentationFunctionI interface

Implements genie::FragmentationFunctionI.

Definition at line 36 of file PetersonFragm.cxx.

{
// Evaluate the fragmentation function
 
  if(z<0 || z>1) return 0;
  return fFunc->Eval(z);
}

References fFunc.

Member Data Documentation

fFunc

TF1* genie::PetersonFragm::fFunc

private

Definition at line 49 of file PetersonFragm.h.

Referenced by BuildFunction(), GenerateZ(), Value(), and ~PetersonFragm().

---

The documentation for this class was generated from the following files:

• PetersonFragm.h
• PetersonFragm.cxx