Maps specific nuclei to appropriate cross section models. More...

#include <IBDXSecMap.h>

Inheritance diagram for genie::IBDXSecMap:

Collaboration diagram for genie::IBDXSecMap:

Public Member Functions
	IBDXSecMap ()
	IBDXSecMap (string config)
virtual	~IBDXSecMap ()
double	XSec (const Interaction *i, KinePhaseSpace_t k) const
	Compute the cross section for the input interaction.
double	Integral (const Interaction *i) const
bool	ValidProcess (const Interaction *i) const
	Can this cross section algorithm handle the input process?
bool	ValidKinematics (const Interaction *i) const
	Is the input kinematical point a physically allowed one?
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::XSecAlgorithmI
virtual	~XSecAlgorithmI ()
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.

Protected Member Functions
const XSecAlgorithmI *	SelectModel (const Target &t) const
Protected Member Functions inherited from genie::XSecAlgorithmI
	XSecAlgorithmI ()
	XSecAlgorithmI (string name)
	XSecAlgorithmI (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)
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.

Private Member Functions
void	LoadConfig (void)

Private Attributes
bool	fIsotopesUseSameModel
const XSecAlgorithmI *	fDefaultModel
std::map< int, const XSecAlgorithmI * >	fRefinedModels

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

Maps specific nuclei to appropriate cross section models.

Author: Corey Reed <cjreed \at nikhef.nl> Nikhef

Created:\n February 4, 2010

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 25 of file IBDXSecMap.h.

Constructor & Destructor Documentation

◆ IBDXSecMap() [1/2]

genie::IBDXSecMap::IBDXSecMap ( )

References genie::XSecAlgorithmI::XSecAlgorithmI().

◆ IBDXSecMap() [2/2]

IBDXSecMap::IBDXSecMap ( string config )

Definition at line 32 of file IBDXSecMap.cxx.

                                    :
   XSecAlgorithmI("genie::IBDXSecMap", config),
   fDefaultModel(0)
{
 
}

References fDefaultModel, and genie::XSecAlgorithmI::XSecAlgorithmI().

◆ ~IBDXSecMap()

IBDXSecMap::~IBDXSecMap ( )

virtual

Definition at line 39 of file IBDXSecMap.cxx.

{
 
}

Member Function Documentation

◆ Configure() [1/2]

void IBDXSecMap::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 45 of file IBDXSecMap.cxx.

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

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

◆ Configure() [2/2]

void IBDXSecMap::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 51 of file IBDXSecMap.cxx.

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

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

◆ Integral()

double IBDXSecMap::Integral ( const Interaction * i ) const

virtual

Integrate the model over the kinematic phase space available to the input interaction (kinematical cuts can be included)

Implements genie::XSecAlgorithmI.

Definition at line 123 of file IBDXSecMap.cxx.

{
   const XSecAlgorithmI* xs = this->SelectModel(i->InitState().Tgt());
   if (xs!=0) {
      return xs->Integral(i);
   } else {
      LOG("IBD", pERROR) << "No IBD XSec model found for target "
                         << i->InitState().TgtPdg();
      return 0;
   }
}

References genie::Interaction::InitState(), genie::XSecAlgorithmI::Integral(), LOG, pERROR, SelectModel(), genie::InitialState::Tgt(), genie::InitialState::TgtPdg(), and genie::XSecAlgorithmI::XSecAlgorithmI().

◆ LoadConfig()

void IBDXSecMap::LoadConfig ( void )

private

Definition at line 57 of file IBDXSecMap.cxx.

{
   // build the default xsec model according to the options contained
   // in IBDXSecMap.xml and/or UserPhysicsOptions.xml
 
   // load default global model (should work for all nuclei)
   RgAlg dgmodel ;
   GetParam( "IBDNucXSecModel", dgmodel ) ;
   LOG("IBD", pINFO)
      << "Default IBD cross section model: " << dgmodel;
 
   fDefaultModel =
      dynamic_cast<const XSecAlgorithmI*>( this -> SubAlg("IBDNucXSecModel") );
   assert(fDefaultModel!=0);
 
   // check whether to map according to specific isotopes
   GetParam("IsotopesUseSameModel", fIsotopesUseSameModel ) ;
 
   // load refined models for specific nuclei
   for(int Z=1; Z<140; Z++) {
     for(int A=Z; A<3*Z; A++) {
         std::ostringstream key;
         const int nucpdg = pdg::IonPdgCode(A,Z);
         key << "IBDNucXSecModel@Pdg=" << nucpdg;
         RgKey rgkey = key.str();
         if ( GetConfig().Exists(rgkey) )  {
                 RgAlg rgmodel = GetConfig().GetAlg(rgkey);
                 LOG("IBD", pNOTICE)
                 << "Nucleus =" << nucpdg
                         << " -> refined nuclear model: " << rgmodel;
                 const XSecAlgorithmI* model =
                                 dynamic_cast<const XSecAlgorithmI*>(this->SubAlg(rgkey));
                 assert(model);
                 const int mapkeyval = (fIsotopesUseSameModel) ? Z : nucpdg;
                 fRefinedModels.
                         insert(map<int,const XSecAlgorithmI*>::value_type(mapkeyval,
                                         model));
         }
     }
   }
}

References fDefaultModel, fIsotopesUseSameModel, fRefinedModels, genie::Registry::GetAlg(), genie::Algorithm::GetConfig(), genie::Algorithm::GetParam(), genie::pdg::IonPdgCode(), LOG, pINFO, pNOTICE, genie::Algorithm::SubAlg(), and genie::XSecAlgorithmI::XSecAlgorithmI().

Referenced by Configure(), and Configure().

◆ SelectModel()

const XSecAlgorithmI * IBDXSecMap::SelectModel ( const Target & t ) const

protected

Definition at line 99 of file IBDXSecMap.cxx.

{
   // search the map for the PDG code of the target
   // if a refined model is found, return it
   // otherwise return the default xsec model
 
   map<int,const XSecAlgorithmI*>::const_iterator it = fRefinedModels.find(t.Pdg());
 
   if(it != fRefinedModels.end()) return it->second;
   else return fDefaultModel;
}

References fDefaultModel, fRefinedModels, genie::Target::Pdg(), and genie::XSecAlgorithmI::XSecAlgorithmI().

Referenced by Integral(), ValidKinematics(), ValidProcess(), and XSec().

◆ ValidKinematics()

bool IBDXSecMap::ValidKinematics ( const Interaction * i ) const

virtual

Is the input kinematical point a physically allowed one?

Reimplemented from genie::XSecAlgorithmI.

Definition at line 147 of file IBDXSecMap.cxx.

{
   const XSecAlgorithmI* xs = this->SelectModel(i->InitState().Tgt());
   if (xs!=0) {
      return xs->ValidKinematics(i);
   } else {
      LOG("IBD", pERROR) << "No IBD XSec model found for target "
                         << i->InitState().TgtPdg();
      return 0;
   }
}

References genie::Interaction::InitState(), LOG, pERROR, SelectModel(), genie::InitialState::Tgt(), genie::InitialState::TgtPdg(), genie::XSecAlgorithmI::ValidKinematics(), and genie::XSecAlgorithmI::XSecAlgorithmI().

◆ ValidProcess()

bool IBDXSecMap::ValidProcess ( const Interaction * i ) const

virtual

Can this cross section algorithm handle the input process?

Implements genie::XSecAlgorithmI.

Definition at line 135 of file IBDXSecMap.cxx.

{
   const XSecAlgorithmI* xs = this->SelectModel(i->InitState().Tgt());
   if (xs!=0) {
      return xs->ValidProcess(i);
   } else {
      LOG("IBD", pERROR) << "No IBD XSec model found for target "
                         << i->InitState().TgtPdg();
      return 0;
   }
}

References genie::Interaction::InitState(), LOG, pERROR, SelectModel(), genie::InitialState::Tgt(), genie::InitialState::TgtPdg(), genie::XSecAlgorithmI::ValidProcess(), and genie::XSecAlgorithmI::XSecAlgorithmI().

◆ XSec()

double IBDXSecMap::XSec	(	const Interaction *	i,
		KinePhaseSpace_t	k ) const

virtual

Compute the cross section for the input interaction.

Implements genie::XSecAlgorithmI.

Definition at line 111 of file IBDXSecMap.cxx.

{
   const XSecAlgorithmI* xs = this->SelectModel(i->InitState().Tgt());
   if (xs!=0) {
      return xs->XSec(i, k);
   } else {
      LOG("IBD", pERROR) << "No IBD XSec model found for target "
                         << i->InitState().TgtPdg();
      return 0;
   }
}

References genie::Interaction::InitState(), LOG, pERROR, SelectModel(), genie::InitialState::Tgt(), genie::InitialState::TgtPdg(), genie::XSecAlgorithmI::XSec(), and genie::XSecAlgorithmI::XSecAlgorithmI().

Member Data Documentation

◆ fDefaultModel

const XSecAlgorithmI* genie::IBDXSecMap::fDefaultModel

private

Definition at line 50 of file IBDXSecMap.h.

Referenced by IBDXSecMap(), LoadConfig(), and SelectModel().

◆ fIsotopesUseSameModel

bool genie::IBDXSecMap::fIsotopesUseSameModel

private

Definition at line 49 of file IBDXSecMap.h.

Referenced by LoadConfig().

◆ fRefinedModels

std::map<int, const XSecAlgorithmI*> genie::IBDXSecMap::fRefinedModels

private

Definition at line 51 of file IBDXSecMap.h.

Referenced by LoadConfig(), and SelectModel().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IBDXSecMap() [1/2]

◆ IBDXSecMap() [2/2]

◆ ~IBDXSecMap()

Member Function Documentation

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ Integral()

◆ LoadConfig()

◆ SelectModel()

◆ ValidKinematics()

◆ ValidProcess()

◆ XSec()

Member Data Documentation

◆ fDefaultModel

◆ fIsotopesUseSameModel

◆ fRefinedModels