GENIEGenerator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
genie::FragmentationFunctionI Class Referenceabstract

Pure abstract base class. Defines the FragmentationFunctionI interface to be implemented by any algorithmic class implementing a fragmentation function. More...

#include <FragmentationFunctionI.h>

Inheritance diagram for genie::FragmentationFunctionI:
Inheritance graph
[legend]
Collaboration diagram for genie::FragmentationFunctionI:
Collaboration graph
[legend]

Public Member Functions

virtual ~FragmentationFunctionI ()
 
virtual double Value (double z) const =0
 
virtual double GenerateZ (void) const =0
 
- Public Member Functions inherited from genie::Algorithm
virtual ~Algorithm ()
 
virtual void Configure (const Registry &config)
 
virtual void Configure (string config)
 
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...
 

Protected Member Functions

 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...
 

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 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

Pure abstract base class. Defines the FragmentationFunctionI interface to be implemented by any algorithmic class implementing a fragmentation function.

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 27 of file FragmentationFunctionI.h.

Constructor & Destructor Documentation

FragmentationFunctionI::~FragmentationFunctionI ( )
virtual

Definition at line 34 of file FragmentationFunctionI.cxx.

35 {
36 
37 }
FragmentationFunctionI::FragmentationFunctionI ( )
protected

Definition at line 16 of file FragmentationFunctionI.cxx.

16  :
17 Algorithm()
18 {
19 
20 }
FragmentationFunctionI::FragmentationFunctionI ( string  name)
protected

Definition at line 22 of file FragmentationFunctionI.cxx.

22  :
24 {
25 
26 }
const char * name
FragmentationFunctionI::FragmentationFunctionI ( string  name,
string  config 
)
protected

Definition at line 28 of file FragmentationFunctionI.cxx.

28  :
29 Algorithm(name, config)
30 {
31 
32 }
const char * name

Member Function Documentation

virtual double genie::FragmentationFunctionI::GenerateZ ( void  ) const
pure virtual
virtual double genie::FragmentationFunctionI::Value ( double  z) const
pure virtual

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