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:

[legend]

Collaboration diagram for genie::NuclearModelMap:

[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 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	LoadConfig (void)
const NuclearModelI *	SelectModel (const Target &t) const

Private Attributes
const NuclearModelI *	fDefGlobModel
	default basic model (should work for all nuclei)
map< int, const NuclearModelI * >	fRefinedModels
	refinements for specific elements

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::FermiMomentumTable &	FermiMomentumTable () 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)
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::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,...)
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

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 \at cern.ch> University of Liverpool

Created:\n May 07, 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 NuclearModelMap.h.

Constructor & Destructor Documentation

◆ NuclearModelMap() [1/2]

NuclearModelMap::NuclearModelMap ( )

Definition at line 43 of file NuclearModelMap.cxx.

                                 :
NuclearModelI("genie::NuclearModelMap")
{
 
}

References genie::NuclearModelI::NuclearModelI().

◆ NuclearModelMap() [2/2]

NuclearModelMap::NuclearModelMap ( string config )

Definition at line 49 of file NuclearModelMap.cxx.

                                              :
NuclearModelI("genie::NuclearModelMap", config)
{
 
}

References genie::NuclearModelI::NuclearModelI().

◆ ~NuclearModelMap()

NuclearModelMap::~NuclearModelMap ( )

virtual

Definition at line 55 of file NuclearModelMap.cxx.

{
 
}

Member Function Documentation

◆ Configure() [1/2]

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.

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

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

◆ Configure() [2/2]

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.

{
  Algorithm::Configure(config);
 
  Registry * algos = AlgConfigPool::Instance() -> GlobalParameterList() ;
  Registry r( "NuclearModelMap", false ) ;
 
  // copy in local pool relevant configurations
  RgIMap entries = algos -> GetItemMap();
  const std::string keyStart = "NuclearModel";
  for( RgIMap::const_iterator it = entries.begin(); it != entries.end(); ++it ) {
 
    if( it -> first.compare(0, keyStart.size(), keyStart.c_str()) == 0 ) {
      r.Set( it -> first, algos -> GetAlg(it->first ) ) ;
    }
 
  }
 
  Algorithm::Configure(r) ;
 
  this->LoadConfig();
}

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

◆ FermiMomentum()

double NuclearModelMap::FermiMomentum	(	const Target &	t,
		int	nucleon_pdg ) const

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 93 of file NuclearModelMap.cxx.

                                                                               {
 
  const NuclearModelI * nm = this->SelectModel(t);
  return nm -> FermiMomentum( t, nucleon_pdg ) ;
 
}

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

Referenced by FermiMomentum().

◆ GenerateNucleon() [1/2]

bool genie::NuclearModelMap::GenerateNucleon ( const Target & t ) const

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 48 of file NuclearModelMap.h.

                                                {
    return GenerateNucleon(t,0.0);
  }

References GenerateNucleon().

◆ GenerateNucleon() [2/2]

bool NuclearModelMap::GenerateNucleon	(	const Target &	t,
		double	hitNucleonRadius ) const

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 60 of file NuclearModelMap.cxx.

{
  const NuclearModelI * nm = this->SelectModel(target);
  if(!nm) return false;
 
  bool ok = nm->GenerateNucleon(target,hitNucleonRadius);
 
  fCurrRemovalEnergy = nm->RemovalEnergy();
  const TVector3& p  = nm->Momentum3();
  fCurrMomentum.SetXYZ(p.Px(), p.Py(), p.Pz());
  fFermiMoverInteractionType = nm->GetFermiMoverInteractionType();
 
  return ok;
}

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

Referenced by GenerateNucleon().

◆ LoadConfig()

void NuclearModelMap::LoadConfig ( void )

privatevirtual

Reimplemented from genie::NuclearModelI.

Definition at line 137 of file NuclearModelMap.cxx.

{
 
  fDefGlobModel = 0;
  // load default global model (should work for all nuclei)
  RgAlg dgmodel ;
  GetParam( "NuclearModel", dgmodel ) ;
 
  LOG("Nuclear", pINFO)
    << "Default global nuclear model: " << dgmodel;
  fDefGlobModel = dynamic_cast<const NuclearModelI *> ( this -> SubAlg( "NuclearModel" ) ) ;
  assert(fDefGlobModel);
 
  // We're looking for keys that match this string
  const std::string keyStart = "NuclearModel@Pdg=";
  // Looking in both of these registries
  RgIMap entries = GetConfig().GetItemMap();
 
  for(RgIMap::const_iterator it = entries.begin(); it != entries.end(); ++it){
    const std::string& key = it->first;
    // Does it start with the right string?
    if(key.compare(0, keyStart.size(), keyStart.c_str()) == 0){
      // The rest is the PDG code
      const int pdg = atoi(key.c_str()+keyStart.size());
      const int Z = pdg::IonPdgCodeToZ(pdg);
      //const int A = pdg::IonPdgCodeToA(pdg);
 
      RgAlg rgmodel = GetConfig().GetAlg(key) ;
      LOG("Nuclear", pNOTICE)
        << "Nucleus =" << pdg
        << " -> refined nuclear model: " << rgmodel;
      const NuclearModelI * model =
        dynamic_cast<const NuclearModelI *> (
          this -> SubAlg(key) ) ;
      assert(model);
      fRefinedModels.insert(map<int,const NuclearModelI*>::value_type(Z,model));
    }
  }
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  for (map<int,const NuclearModelI*>::iterator it = fRefinedModels.begin();
      it != fRefinedModels.end(); ++it) {
    LOG("Nuclear", pDEBUG)
      << "Z = " << (*it).first << "; model = " << (*it).second;
  }
#endif
}

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

Referenced by Configure(), and Configure().

◆ LocalFermiMomentum()

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.

                                                                                   {
 
  const NuclearModelI * nm = this->SelectModel(t);
  return nm -> LocalFermiMomentum( t, nucleon_pdg, radius ) ;
 
}

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

Referenced by LocalFermiMomentum().

◆ ModelType()

NuclearModel_t NuclearModelMap::ModelType ( const Target & t ) const

virtual

Implements genie::NuclearModelI.

Definition at line 85 of file NuclearModelMap.cxx.

{
  const NuclearModelI * nm = this->SelectModel(target);
  if(!nm) return kNucmUndefined;
 
  return nm->ModelType(target);
}

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

◆ Prob() [1/2]

double genie::NuclearModelMap::Prob	(	double	p,
		double	w,
		const Target &	t ) const

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 51 of file NuclearModelMap.h.

                                                           {
    return Prob(p,w,t,0.0);
  }

References Prob().

◆ Prob() [2/2]

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.

{
  const NuclearModelI * nm = this->SelectModel(target);
  if(!nm) return 0;
 
  return nm->Prob(p,w,target,hitNucRadius);
}

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

Referenced by Prob().

◆ SelectModel()

const NuclearModelI * NuclearModelMap::SelectModel ( const Target & t ) const

private

Definition at line 186 of file NuclearModelMap.cxx.

{
  int Z = t.Z();
 
  map<int,const NuclearModelI*>::const_iterator it = fRefinedModels.find(Z);
 
  if(it != fRefinedModels.end()) return it->second;
  else return fDefGlobModel;
}

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

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

Member Data Documentation

◆ fDefGlobModel

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

◆ fRefinedModels

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:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NuclearModelMap() [1/2]

◆ NuclearModelMap() [2/2]

◆ ~NuclearModelMap()

Member Function Documentation

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ FermiMomentum()

◆ GenerateNucleon() [1/2]

◆ GenerateNucleon() [2/2]

◆ LoadConfig()

◆ LocalFermiMomentum()

◆ ModelType()

◆ Prob() [1/2]

◆ Prob() [2/2]

◆ SelectModel()

Member Data Documentation

◆ fDefGlobModel

◆ fRefinedModels