GENIEGenerator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for genie::PetersonFragm:
Collaboration graph
[legend]

Public Member Functions

 PetersonFragm ()
 
 PetersonFragm (string config)
 
 ~PetersonFragm ()
 
double Value (double z) const
 implement the FragmentationFunctionI interface More...
 
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 RegistryGetConfig (void) const
 
RegistryGetOwnedConfig (void)
 
virtual const AlgIdId (void) const
 Get algorithm ID. More...
 
virtual AlgStatus_t GetStatus (void) const
 Get algorithm status. More...
 
virtual bool AllowReconfig (void) const
 
virtual AlgCmp_t Compare (const Algorithm *alg) const
 Compare with input algorithm. More...
 
virtual void SetId (const AlgId &id)
 Set algorithm ID. More...
 
virtual void SetId (string name, string config)
 
const AlgorithmSubAlg (const RgKey &registry_key) const
 
void AdoptConfig (void)
 
void AdoptSubstructure (void)
 
virtual void Print (ostream &stream) const
 Print algorithm info. More...
 

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)
 
RegistryExtractLocalConfig (const Registry &in) const
 
RegistryExtractLowerConfig (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. More...
 
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. More...
 
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. More...
 
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 More...
 
int AddLowRegistry (Registry *rp, bool owns=true)
 add registry with lowest priority, also update ownership More...
 
int MergeTopRegistry (const Registry &r)
 
int AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
 Add registries with top priority, also udated Ownerships. More...
 
- Protected Attributes inherited from genie::Algorithm
bool fAllowReconfig
 
bool fOwnsSubstruc
 true if it owns its substructure (sub-algs,...) More...
 
AlgId fID
 algorithm name and configuration set More...
 
vector< Registry * > fConfVect
 
vector< bool > fOwnerships
 ownership for every registry in fConfVect More...
 
AlgStatus_t fStatus
 algorithm execution status More...
 
AlgMapfOwnedSubAlgMp
 local pool for owned sub-algs (taken out of the factory pool) More...
 

Detailed Description

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

References:
C.Peterson et al., Phys.Rev.D23, 56 (1981)
Author
Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool
Created:
June 15, 2004
License:
Copyright (c) 2003-2024, 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::PetersonFragm ( )

Definition at line 19 of file PetersonFragm.cxx.

19  :
20 FragmentationFunctionI("genie::PetersonFragm")
21 {
22 
23 }
PetersonFragm::PetersonFragm ( string  config)

Definition at line 25 of file PetersonFragm.cxx.

References BuildFunction().

25  :
26 FragmentationFunctionI("genie::PetersonFragm", config)
27 {
28  this->BuildFunction();
29 }
PetersonFragm::~PetersonFragm ( )

Definition at line 31 of file PetersonFragm.cxx.

References fFunc.

32 {
33  delete fFunc;
34 }

Member Function Documentation

void PetersonFragm::BuildFunction ( void  )
private

Definition at line 63 of file PetersonFragm.cxx.

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

Referenced by Configure(), and PetersonFragm().

64 {
65  fFunc = new TF1("fFunc",genie::utils::frgmfunc::peterson_func,0,1,2);
66 
67  fFunc->SetParNames("Norm","Epsilon");
68  // stop ROOT from deleting this object of its own volition
69  gROOT->GetListOfFunctions()->Remove(fFunc);
70 
71  double N = -1. ;
72  GetParam( "PetFrag-Norm", N, false ) ;
73 
74  //The xml files says that Epsilon is not optional, while the
75  //orignal behaviour of this function assigned a 0 default value
76  //if the xml file was not providing such a number.
77  // Original behaviour maintained
78  double e = 0. ;
79  GetParam( "PetFrag-Epsilon", e, false ) ;
80 
81  // if the normalization parameter was left negative, explicitly normalize
82  // the fragmentation function
83  if(N<0) {
84  N=1;
85  fFunc->SetParameters(N,e);
86  double I = fFunc->Integral(0,1);
87  assert(I>0);
88  N = 1./I;
89  }
90  fFunc->SetParameters(N,e);
91 }
double peterson_func(double *x, double *par)
The Peterson fragmentation function.
const double e
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const
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.

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

52 {
53  Algorithm::Configure(config);
54  this->BuildFunction();
55 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
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.

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

58 {
59  Algorithm::Configure(config);
60  this->BuildFunction();
61 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
double PetersonFragm::GenerateZ ( void  ) const
virtual

Implements genie::FragmentationFunctionI.

Definition at line 44 of file PetersonFragm.cxx.

References fFunc.

45 {
46 // Return a random number using the fragmentation function as PDF
47 
48  return fFunc->GetRandom();
49 }
double PetersonFragm::Value ( double  z) const
virtual

implement the FragmentationFunctionI interface

Implements genie::FragmentationFunctionI.

Definition at line 36 of file PetersonFragm.cxx.

References fFunc.

37 {
38 // Evaluate the fragmentation function
39 
40  if(z<0 || z>1) return 0;
41  return fFunc->Eval(z);
42 }

Member Data Documentation

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: