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::NuclearModelMap Class Reference

This class is a hook for nuclear models and allows associating each one of them with specific nuclei. Is a concrete implementation of the NuclearModelI interface. More...

#include <NuclearModelMap.h>

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

Public Member Functions

 NuclearModelMap ()
 
 NuclearModelMap (string config)
 
virtual ~NuclearModelMap ()
 
virtual bool GenerateNucleon (const Target &t, double hitNucleonRadius) const
 
virtual double Prob (double p, double w, const Target &t, double hitNucleonRadius) const
 
bool GenerateNucleon (const Target &t) const
 
double Prob (double p, double w, const Target &t) const
 
NuclearModel_t ModelType (const Target &t) const
 
virtual double FermiMomentum (const Target &t, int nucleon_pdg) const
 
virtual double LocalFermiMomentum (const Target &t, int nucleon_pdg, double radius) const
 
void Configure (const Registry &config)
 
void Configure (string config)
 
- Public Member Functions inherited from genie::NuclearModelI
virtual ~NuclearModelI ()
 
double RemovalEnergy (void) const
 
double Momentum (void) const
 
const TVector3 & Momentum3 (void) const
 
FermiMoverInteractionType_t GetFermiMoverInteractionType (void) const
 
void SetMomentum3 (const TVector3 &mom) const
 
void SetRemovalEnergy (double E) const
 
- 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 LoadConfig (void)
 
const NuclearModelISelectModel (const Target &t) const
 

Private Attributes

const NuclearModelIfDefGlobModel
 default basic model (should work for all nuclei) More...
 
map< int, const NuclearModelI * > fRefinedModels
 refinements for specific elements 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 Member Functions inherited from genie::NuclearModelI
 NuclearModelI ()
 
 NuclearModelI (std::string name)
 
 NuclearModelI (std::string name, std::string config)
 
const string & FermiMomentumTableName () const
 
const genie::FermiMomentumTableFermiMomentumTable () const
 
- 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::NuclearModelI
double fCurrRemovalEnergy
 
TVector3 fCurrMomentum
 
FermiMoverInteractionType_t fFermiMoverInteractionType
 
- 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

This class is a hook for nuclear models and allows associating each one of them with specific nuclei. Is a concrete implementation of the NuclearModelI interface.

Author
Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool
Created:
May 07, 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 NuclearModelMap.h.

Constructor & Destructor Documentation

NuclearModelMap::NuclearModelMap ( )

Definition at line 43 of file NuclearModelMap.cxx.

43  :
44 NuclearModelI("genie::NuclearModelMap")
45 {
46 
47 }
NuclearModelMap::NuclearModelMap ( string  config)

Definition at line 49 of file NuclearModelMap.cxx.

49  :
50 NuclearModelI("genie::NuclearModelMap", config)
51 {
52 
53 }
NuclearModelMap::~NuclearModelMap ( )
virtual

Definition at line 55 of file NuclearModelMap.cxx.

56 {
57 
58 }

Member Function Documentation

void NuclearModelMap::Configure ( const Registry config)
virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 108 of file NuclearModelMap.cxx.

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

109 {
110  Algorithm::Configure(config);
111  this->LoadConfig();
112 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void NuclearModelMap::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 114 of file NuclearModelMap.cxx.

References genie::Algorithm::Configure(), genie::AlgConfigPool::Instance(), LoadConfig(), and genie::Registry::Set().

115 {
116  Algorithm::Configure(config);
117 
118  Registry * algos = AlgConfigPool::Instance() -> GlobalParameterList() ;
119  Registry r( "NuclearModelMap", false ) ;
120 
121  // copy in local pool relevant configurations
122  RgIMap entries = algos -> GetItemMap();
123  const std::string keyStart = "NuclearModel";
124  for( RgIMap::const_iterator it = entries.begin(); it != entries.end(); ++it ) {
125 
126  if( it -> first.compare(0, keyStart.size(), keyStart.c_str()) == 0 ) {
127  r.Set( it -> first, algos -> GetAlg(it->first ) ) ;
128  }
129 
130  }
131 
133 
134  this->LoadConfig();
135 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
A registry. Provides the container for algorithm configuration parameters.
Definition: Registry.h:65
static AlgConfigPool * Instance()
map< RgKey, RegistryItemI * > RgIMap
Definition: Registry.h:45
double NuclearModelMap::FermiMomentum ( const Target t,
int  nucleon_pdg 
) const
virtual

Reimplemented from genie::NuclearModelI.

Definition at line 93 of file NuclearModelMap.cxx.

References SelectModel().

93  {
94 
95  const NuclearModelI * nm = this->SelectModel(t);
96  return nm -> FermiMomentum( t, nucleon_pdg ) ;
97 
98 }
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
virtual double FermiMomentum(const Target &t, int nucleon_pdg) const
const NuclearModelI * SelectModel(const Target &t) const
bool NuclearModelMap::GenerateNucleon ( const Target t,
double  hitNucleonRadius 
) const
virtual

Reimplemented from genie::NuclearModelI.

Definition at line 60 of file NuclearModelMap.cxx.

References genie::NuclearModelI::fCurrMomentum, genie::NuclearModelI::fCurrRemovalEnergy, genie::NuclearModelI::fFermiMoverInteractionType, genie::NuclearModelI::GenerateNucleon(), genie::NuclearModelI::GetFermiMoverInteractionType(), genie::NuclearModelI::Momentum3(), genie::NuclearModelI::RemovalEnergy(), and SelectModel().

Referenced by GenerateNucleon().

62 {
63  const NuclearModelI * nm = this->SelectModel(target);
64  if(!nm) return false;
65 
66  bool ok = nm->GenerateNucleon(target,hitNucleonRadius);
67 
69  const TVector3& p = nm->Momentum3();
70  fCurrMomentum.SetXYZ(p.Px(), p.Py(), p.Pz());
72 
73  return ok;
74 }
double RemovalEnergy(void) const
Definition: NuclearModelI.h:65
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
const TVector3 & Momentum3(void) const
Definition: NuclearModelI.h:75
FermiMoverInteractionType_t GetFermiMoverInteractionType(void) const
Definition: NuclearModelI.h:80
FermiMoverInteractionType_t fFermiMoverInteractionType
const NuclearModelI * SelectModel(const Target &t) const
virtual bool GenerateNucleon(const Target &) const =0
bool genie::NuclearModelMap::GenerateNucleon ( const Target t) const
inlinevirtual

Implements genie::NuclearModelI.

Definition at line 48 of file NuclearModelMap.h.

References GenerateNucleon().

48  {
49  return GenerateNucleon(t,0.0);
50  }
virtual bool GenerateNucleon(const Target &t, double hitNucleonRadius) const
void NuclearModelMap::LoadConfig ( void  )
privatevirtual

Reimplemented from genie::NuclearModelI.

Definition at line 137 of file NuclearModelMap.cxx.

References fDefGlobModel, fRefinedModels, genie::Registry::GetAlg(), genie::Algorithm::GetConfig(), genie::Registry::GetItemMap(), genie::Algorithm::GetParam(), genie::pdg::IonPdgCodeToZ(), LOG, pDEBUG, pINFO, pNOTICE, and genie::Algorithm::SubAlg().

Referenced by Configure().

138 {
139 
140  fDefGlobModel = 0;
141  // load default global model (should work for all nuclei)
142  RgAlg dgmodel ;
143  GetParam( "NuclearModel", dgmodel ) ;
144 
145  LOG("Nuclear", pINFO)
146  << "Default global nuclear model: " << dgmodel;
147  fDefGlobModel = dynamic_cast<const NuclearModelI *> ( this -> SubAlg( "NuclearModel" ) ) ;
148  assert(fDefGlobModel);
149 
150  // We're looking for keys that match this string
151  const std::string keyStart = "NuclearModel@Pdg=";
152  // Looking in both of these registries
153  RgIMap entries = GetConfig().GetItemMap();
154 
155  for(RgIMap::const_iterator it = entries.begin(); it != entries.end(); ++it){
156  const std::string& key = it->first;
157  // Does it start with the right string?
158  if(key.compare(0, keyStart.size(), keyStart.c_str()) == 0){
159  // The rest is the PDG code
160  const int pdg = atoi(key.c_str()+keyStart.size());
161  const int Z = pdg::IonPdgCodeToZ(pdg);
162  //const int A = pdg::IonPdgCodeToA(pdg);
163 
164  RgAlg rgmodel = GetConfig().GetAlg(key) ;
165  LOG("Nuclear", pNOTICE)
166  << "Nucleus =" << pdg
167  << " -> refined nuclear model: " << rgmodel;
168  const NuclearModelI * model =
169  dynamic_cast<const NuclearModelI *> (
170  this -> SubAlg(key) ) ;
171  assert(model);
172  fRefinedModels.insert(map<int,const NuclearModelI*>::value_type(Z,model));
173  }
174  }
175 
176 #ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
177  for (map<int,const NuclearModelI*>::iterator it = fRefinedModels.begin();
178  it != fRefinedModels.end(); ++it) {
179  LOG("Nuclear", pDEBUG)
180  << "Z = " << (*it).first << "; model = " << (*it).second;
181  }
182 #endif
183 }
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
const NuclearModelI * fDefGlobModel
default basic model (should work for all nuclei)
virtual const Registry & GetConfig(void) const
Definition: Algorithm.cxx:246
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE...
Definition: Messenger.h:96
const RgIMap & GetItemMap(void) const
Definition: Registry.h:161
#define pINFO
Definition: Messenger.h:62
map< int, const NuclearModelI * > fRefinedModels
refinements for specific elements
int IonPdgCodeToZ(int pdgc)
Definition: PDGUtils.cxx:55
#define pNOTICE
Definition: Messenger.h:61
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const
RgAlg GetAlg(RgKey key) const
Definition: Registry.cxx:488
#define pDEBUG
Definition: Messenger.h:63
map< RgKey, RegistryItemI * > RgIMap
Definition: Registry.h:45
const Algorithm * SubAlg(const RgKey &registry_key) const
Definition: Algorithm.cxx:345
double NuclearModelMap::LocalFermiMomentum ( const Target t,
int  nucleon_pdg,
double  radius 
) const
virtual

Reimplemented from genie::NuclearModelI.

Definition at line 100 of file NuclearModelMap.cxx.

References SelectModel().

101  {
102 
103  const NuclearModelI * nm = this->SelectModel(t);
104  return nm -> LocalFermiMomentum( t, nucleon_pdg, radius ) ;
105 
106 }
virtual double LocalFermiMomentum(const Target &t, int nucleon_pdg, double radius) const
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
const NuclearModelI * SelectModel(const Target &t) const
NuclearModel_t NuclearModelMap::ModelType ( const Target t) const
virtual

Implements genie::NuclearModelI.

Definition at line 85 of file NuclearModelMap.cxx.

References genie::kNucmUndefined, genie::NuclearModelI::ModelType(), and SelectModel().

86 {
87  const NuclearModelI * nm = this->SelectModel(target);
88  if(!nm) return kNucmUndefined;
89 
90  return nm->ModelType(target);
91 }
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
virtual NuclearModel_t ModelType(const Target &) const =0
const NuclearModelI * SelectModel(const Target &t) const
double NuclearModelMap::Prob ( double  p,
double  w,
const Target t,
double  hitNucleonRadius 
) const
virtual

Reimplemented from genie::NuclearModelI.

Definition at line 76 of file NuclearModelMap.cxx.

References genie::NuclearModelI::Prob(), and SelectModel().

Referenced by Prob().

78 {
79  const NuclearModelI * nm = this->SelectModel(target);
80  if(!nm) return 0;
81 
82  return nm->Prob(p,w,target,hitNucRadius);
83 }
Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model ...
Definition: NuclearModelI.h:46
virtual double Prob(double p, double w, const Target &) const =0
const NuclearModelI * SelectModel(const Target &t) const
double genie::NuclearModelMap::Prob ( double  p,
double  w,
const Target t 
) const
inlinevirtual

Implements genie::NuclearModelI.

Definition at line 51 of file NuclearModelMap.h.

References Prob().

51  {
52  return Prob(p,w,t,0.0);
53  }
virtual double Prob(double p, double w, const Target &t, double hitNucleonRadius) const
const NuclearModelI * NuclearModelMap::SelectModel ( const Target t) const
private

Definition at line 186 of file NuclearModelMap.cxx.

References fDefGlobModel, fRefinedModels, and genie::Target::Z().

Referenced by FermiMomentum(), GenerateNucleon(), LocalFermiMomentum(), ModelType(), and Prob().

187 {
188  int Z = t.Z();
189 
190  map<int,const NuclearModelI*>::const_iterator it = fRefinedModels.find(Z);
191 
192  if(it != fRefinedModels.end()) return it->second;
193  else return fDefGlobModel;
194 }
const NuclearModelI * fDefGlobModel
default basic model (should work for all nuclei)
int Z(void) const
Definition: Target.h:68
map< int, const NuclearModelI * > fRefinedModels
refinements for specific elements

Member Data Documentation

const NuclearModelI* genie::NuclearModelMap::fDefGlobModel
private

default basic model (should work for all nuclei)

Definition at line 69 of file NuclearModelMap.h.

Referenced by LoadConfig(), and SelectModel().

map<int, const NuclearModelI *> genie::NuclearModelMap::fRefinedModels
private

refinements for specific elements

Definition at line 70 of file NuclearModelMap.h.

Referenced by LoadConfig(), and SelectModel().


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