Public Member Functions | Protected Member Functions | List of all members
genie::DecayModelI Class Referenceabstract

Pure abstract base class. Defines the DecayModelI interface to be implemented by any algorithmic class decaying a particle. More...

#include <DecayModelI.h>

Inheritance diagram for genie::DecayModelI:
genie::Algorithm

Public Member Functions

virtual ~DecayModelI ()
 
virtual bool IsHandled (int pdgc) const =0
 can this particle be decayed? More...
 
virtual void Initialize (void) const =0
 decayer initialization More...
 
virtual TClonesArray * Decay (const DecayerInputs_t &inp) const =0
 return a TClonesArray of TMCParticle objects (NOTE: all TMCParticle units in GeV^n [hbar=c=1]) More...
 
virtual double Weight (void) const =0
 last decay weight More...
 
virtual void InhibitDecay (int pdgc, TDecayChannel *dc=0) const =0
 inhibit input decay channel for the input particle (inhibit all decays if dc is null) More...
 
virtual void UnInhibitDecay (int pdgc, TDecayChannel *dc=0) const =0
 clear inhibit flags & re-enable all decay channel (enable all if dc is null) More...
 
- 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

 DecayModelI ()
 
 DecayModelI (string name)
 
 DecayModelI (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 >
bool GetParamVect (const std::string &comm_name, std::vector< T > &v, unsigned int max, 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

- 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< boolfOwnerships
 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 DecayModelI interface to be implemented by any algorithmic class decaying a particle.

Author
Costas Andreopoulos <costas.andreopoulos stfc.ac.uk> University of Liverpool & STFC Rutherford Appleton Lab

June 20, 2004

Copyright (c) 2003-2019, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org or see $GENIE/LICENSE

Definition at line 31 of file DecayModelI.h.

Constructor & Destructor Documentation

DecayModelI::~DecayModelI ( )
virtual

Definition at line 43 of file DecayModelI.cxx.

44 {
45 
46 }
DecayModelI::DecayModelI ( )
protected

Definition at line 25 of file DecayModelI.cxx.

25  :
26 Algorithm()
27 {
28 
29 }
DecayModelI::DecayModelI ( string  name)
protected

Definition at line 31 of file DecayModelI.cxx.

31  :
33 {
34 
35 }
static QCString name
Definition: declinfo.cpp:673
DecayModelI::DecayModelI ( string  name,
string  config 
)
protected

Definition at line 37 of file DecayModelI.cxx.

37  :
39 {
40 
41 }
static QCString name
Definition: declinfo.cpp:673
static Config * config
Definition: config.cpp:1054

Member Function Documentation

virtual TClonesArray* genie::DecayModelI::Decay ( const DecayerInputs_t inp) const
pure virtual

return a TClonesArray of TMCParticle objects (NOTE: all TMCParticle units in GeV^n [hbar=c=1])

virtual void genie::DecayModelI::InhibitDecay ( int  pdgc,
TDecayChannel *  dc = 0 
) const
pure virtual

inhibit input decay channel for the input particle (inhibit all decays if dc is null)

virtual void genie::DecayModelI::Initialize ( void  ) const
pure virtual

decayer initialization

virtual bool genie::DecayModelI::IsHandled ( int  pdgc) const
pure virtual

can this particle be decayed?

virtual void genie::DecayModelI::UnInhibitDecay ( int  pdgc,
TDecayChannel *  dc = 0 
) const
pure virtual

clear inhibit flags & re-enable all decay channel (enable all if dc is null)

virtual double genie::DecayModelI::Weight ( void  ) const
pure virtual

last decay weight


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