Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model describing the distribution of nucleons within a nuclei. More...

#include "/cvmfs/nova.opensciencegrid.org/externals/genie/v3_00_06_p01/Linux64bit+2.6-2.12-e17-debug/GENIE-Generator/src/Physics/NuclearState/NuclearModelI.h"

Inheritance diagram for genie::NuclearModelI:

Public Member Functions
virtual	~NuclearModelI ()

virtual bool	GenerateNucleon (const Target &) const =0

virtual bool	GenerateNucleon (const Target &tgt, double hitNucleonRadius) const

virtual double	Prob (double p, double w, const Target &) const =0

virtual double	Prob (double p, double w, const Target &tgt, double hitNucleonRadius) const

virtual NuclearModel_t	ModelType (const Target &) const =0

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

virtual void	Configure (const Registry &config)

virtual void	Configure (string config)

virtual void	FindConfig (void)

virtual const Registry &	GetConfig (void) const

Registry *	GetOwnedConfig (void)

virtual const AlgId &	Id (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 Algorithm *	SubAlg (const RgKey &registry_key) const

void	AdoptConfig (void)

void	AdoptSubstructure (void)

virtual void	Print (ostream &stream) const
	Print algorithm info. More...

Protected Member Functions
	NuclearModelI ()

	NuclearModelI (std::string name)

	NuclearModelI (std::string name, std::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. 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...

Protected Attributes
double	fCurrRemovalEnergy

TVector3	fCurrMomentum

FermiMoverInteractionType_t	fFermiMoverInteractionType

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

AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool) More...

Detailed Description

Pure abstract base class. Defines the NuclearModelI interface to be implemented by any physics model describing the distribution of nucleons within a nuclei.

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

October 09, 2004

Important revisions after version 2.0.0 : @ Mar 18, 2016 - JJ (SD) Added option for GenerateNucleon() to be called with a target and a radius as the arguments. Currently used by LocalFGM. Calls GenerateNucleon() with the radius set to 0 for all other NuclearModelI implementations.

Definition at line 42 of file NuclearModelI.h.

Constructor & Destructor Documentation

virtual genie::NuclearModelI::~NuclearModelI ( )

inlinevirtual

Definition at line 45 of file NuclearModelI.h.

References GenerateNucleon(), ModelType(), Prob(), and w.

45 {};

genie::NuclearModelI::NuclearModelI ( )

inlineprotected

Definition at line 88 of file NuclearModelI.h.

     : Algorithm()
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     {};

genie::NuclearModelI::NuclearModelI ( std::string name )

inlineprotected

Definition at line 94 of file NuclearModelI.h.

     : Algorithm(name)
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     {};

genie::NuclearModelI::NuclearModelI	(	std::string	name,
		std::string	config
	)

inlineprotected

Definition at line 100 of file NuclearModelI.h.

     : Algorithm(name, config)
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     {};

Member Function Documentation

int Algorithm::AddLowRegistry	(	Registry *	rp,
		bool	owns = `true`
	)

protectedinherited

add registry with lowest priority, also update ownership

Definition at line 601 of file Algorithm.cxx.

Referenced by genie::EventGenerator::Configure().

                                                        {
 
   fConfVect.push_back( rp ) ;
   fOwnerships.push_back( own ) ;
 
   if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
   }
 
   return fConfVect.size() ;
 
 }

int Algorithm::AddTopRegisties	(	const vector< Registry * > &	rs,
		bool	owns = `false`
	)

protectedinherited

Add registries with top priority, also udated Ownerships.

Definition at line 653 of file Algorithm.cxx.

                                                                        {
 
   fConfVect.insert( fConfVect.begin(), rs.begin(), rs.end() ) ;
   
   fOwnerships.insert( fOwnerships.begin(), rs.size(), own ) ;
   
   if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
   }
 
   return fConfVect.size() ;  
 
 }

int Algorithm::AddTopRegistry	(	Registry *	rp,
		bool	owns = `true`
	)

protectedinherited

add registry with top priority, also update ownership

Definition at line 585 of file Algorithm.cxx.

Referenced by genie::EventGeneratorListAssembler::AssembleGeneratorList().

                                                        {  
 
   fConfVect.insert( fConfVect.begin(), rp ) ;
   fOwnerships.insert( fOwnerships.begin(), own ) ;
 
   if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
   }
 
   return fConfVect.size() ;
 
 }

void Algorithm::AdoptConfig ( void )

inherited

Clone the configuration registry looked up from the configuration pool and take its ownership

Definition at line 394 of file Algorithm.cxx.

References Configure(), GetConfig(), LOG, and pNOTICE.

Referenced by genie::Algorithm::AllowReconfig().

                                 {
 
   LOG("Algorithm", pNOTICE)
     << this->Id().Key() << " is taking ownership of its configuration";
   
   // if(fOwnsConfig) {
   //   LOG("Algorithm", pWARN)
   //     << this->Id().Key() << " already owns its configuration!";
   //   return;
   // }
 
   this->Configure( GetConfig() );
 }

void Algorithm::AdoptSubstructure ( void )

inherited

Take ownership of the algorithms subtructure (sub-algorithms,...) by copying them from the AlgFactory pool to the local pool Also bring all the configuration variables to the top level config Registry. This can be used to group together a series of algorithms & their configurations and extract (a clone of) this group from the shared pools. Having a series of algorithms/configurations behaving as a monolithic block, with a single point of configuration (the top level) is to be used when bits & pieces of GENIE are used in isolation for data fitting or reweighting

Definition at line 408 of file Algorithm.cxx.

References genie::AlgFactory::AdoptAlgorithm(), genie::Algorithm::AdoptSubstructure(), GetConfig(), genie::AlgFactory::Instance(), genie::kRgAlg, LOG, pDEBUG, pNOTICE, and genie::RegistryItemI::TypeInfo().

Referenced by genie::Algorithm::AdoptSubstructure(), genie::Algorithm::AllowReconfig(), main(), and testReconfigInOwnedModules().

 {
 // Take ownership of the algorithms subtructure (sub-algorithms,..) by copying 
 // them from the AlgFactory pool to the local pool. Also bring all the 
 // configuration variables to the top level. See the header for more details.
 // A secial naming convention is required for configuration parameter keys 
 // for parameters belonging to sub-algorithms (or sub-algorithms of these 
 // sub-algorithms and so on...). 
 // The convention is: "sub-alg-key/sub-sub-alg-key/.../original name"
 // This is a recursive method: The AdoptSubtructure()of all sub-algorithms is
 // invoked.
 //
   LOG("Algorithm", pNOTICE) 
      << "Algorithm: " << this->Id().Key() << " is adopting its substructure";
 
 //  Registry deep_config;
 //  deep_config.UnLock();
 //  deep_config.SetName(this->Id().Key());
 
   //  deep_config.SetName(this->Id().Config() + ";D");
   //  fID.SetConfig(this->Id().Config() + ";D");
 
   if(fOwnsSubstruc) this->DeleteSubstructure();
 
   fOwnedSubAlgMp = new AlgMap;
   fOwnsSubstruc  = true;
 
   AlgFactory * algf = AlgFactory::Instance();
 
   const RgIMap & rgmap = GetConfig().GetItemMap();
 
   RgIMapConstIter iter = rgmap.begin();
   for( ; iter != rgmap.end(); ++iter) {
 
     RgKey reg_key = iter->first;
     RegistryItemI * ri = iter->second;
 
     if(ri->TypeInfo() == kRgAlg) {
         LOG("Algorithm", pDEBUG) 
                  << "Found sub-algorithm pointed to by " << reg_key;
         RgAlg reg_alg = fConfig->GetAlg(reg_key);
         AlgId id(reg_alg);
 
         LOG("Algorithm", pDEBUG) << "Adopting sub-algorithm = " << id.Key();
         Algorithm * subalg = algf->AdoptAlgorithm(id.Name(),id.Config());
         subalg->AdoptSubstructure();
 
         LOG("Algorithm", pDEBUG) << "Adding sub-algorithm to local pool";
         AlgMapPair key_alg_pair(reg_key, subalg);
         fOwnedSubAlgMp->insert(key_alg_pair);
 
     }
 
   }
 
 
   if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
   }
 
 }

virtual bool genie::Algorithm::AllowReconfig ( void ) const

inlinevirtualinherited

Allow reconfigration after initializaton? Algorithms may opt-out, if reconfiguration is not necessary, to improve event reweighting speed.

Definition at line 106 of file Algorithm.h.

Referenced by genie::AlgFactory::ForceReconfiguration().

106 { return fAllowReconfig; }

genie::Algorithm::fAllowReconfig

bool fAllowReconfig

Definition: Algorithm.h:153

AlgCmp_t Algorithm::Compare ( const Algorithm * alg ) const

virtualinherited

Compare with input algorithm.

Definition at line 294 of file Algorithm.cxx.

References genie::AlgId::Config(), genie::Algorithm::Id(), genie::kAlgCmpDiffAlg, genie::kAlgCmpDiffConfig, genie::kAlgCmpIdentical, genie::kAlgCmpUnknown, and genie::AlgId::Name().

Referenced by genie::Algorithm::AllowReconfig().

 {
 // Compares itself with the input algorithm
 
   string alg1    = this->Id().Name();
   string config1 = this->Id().Config();
   string alg2    = algo->Id().Name();
   string config2 = algo->Id().Config();
 
   if(alg1 == alg2)
   {
     if(config1 == config2) return kAlgCmpIdentical;
     else                   return kAlgCmpDiffConfig;
   }
   else return kAlgCmpDiffAlg;
 
   return kAlgCmpUnknown;
 }

void Algorithm::Configure ( const Registry & config )

virtualinherited

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

Definition at line 70 of file Algorithm.cxx.

References gen_flatrecord::config, Configure(), genie::Algorithm::Id(), genie::AlgId::Key(), LOG, genie::Registry::Name(), genie::Registry::NEntries(), pERROR, and pNOTICE.

 {
 // Configure the Algorithm using the input configuration Registry
 
   LOG("Algorithm", pNOTICE) << "Input configuration: " << config;
 
   if ( config.NEntries() <= 0 ) {
 
     LOG("Algorithm", pNOTICE) "Registry " << config.Name() << " is empty. Not added to " << fID.Name();
     return; 
   }
 
   Registry* rp = ExtractLocalConfig( config ) ;
   if ( rp ) { 
    
     MergeTopRegistry( *rp ) ;
     LOG("Algorithm", pNOTICE) << fID.Name() << " merged with external configuration: " << *rp;
     
     // The memory handled by this pointer has been copied and needs to be cleared
     delete rp ;
   }
 
   if(!fOwnsSubstruc) return;              // doesn't own substructure
   if(fOwnedSubAlgMp->size()==0) return;   // no sub-algorithms
 
   LOG("Algorithm", pNOTICE) << "Configuring algorithms stored at local pool";
 
   // loop over local pool algorithms
 
   for( AlgMapIter alg_iter = fOwnedSubAlgMp->begin(); 
        alg_iter != fOwnedSubAlgMp->end(); ++alg_iter) {
     
     string      alg_key = alg_iter->first;
     Algorithm * alg     = alg_iter->second;
     
     if(!alg) {
       LOG("Algorithm", pERROR) 
         << "Key: " << alg_key << " points to a null algorithm at local pool";
       continue; 
     }
 
     LOG("Algorithm", pNOTICE) << "Configuring sub-alg: " << alg->Id().Key();
     
     rp = ExtractLowerConfig( config, alg_key ) ;
     if ( rp ) { 
       
       alg -> Configure( *rp ) ;
       
       delete rp ;
       
     }
     
   }
 
 }

void Algorithm::Configure ( string config )

virtualinherited

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

Definition at line 126 of file Algorithm.cxx.

 {
 // Configure the Algorithm looking up at the ConfigPool singleton for a
 // configuration Registry corresponding to the input named parameter set.
 
   fID.SetConfig(config);
   this->FindConfig();
 }

void Algorithm::DeleteConfig ( void )

protectedinherited

Definition at line 471 of file Algorithm.cxx.

References MECModelEnuComparisons::i.

Referenced by genie::Algorithm::AllowReconfig().

 {
   // there is nothing to delete if the configuration is not owned but is 
   // rather looked up from the configuration pool
   //
   
   for ( unsigned int i = 0 ; i < fConfVect.size() ; ++i ) {
     if ( fOwnerships[i] ) {
       delete fConfVect[i] ;
     }
   }
 
   fConfVect.clear() ;
   fOwnerships.clear() ;
 
   // delete owned configuration registry
 
   if(fConfig) {
     delete fConfig; 
     fConfig=0;
   }
 
 }

void Algorithm::DeleteSubstructure ( void )

protectedinherited

Definition at line 496 of file Algorithm.cxx.

Referenced by genie::Algorithm::AllowReconfig().

 {
   // there is nothing to delete if the sub-algorithms are not owned but rather
   // taken from the AlgFactory's pool
   //
   if(!fOwnsSubstruc) return;
 
   // delete local algorithm pool
   //
   AlgMapIter iter = fOwnedSubAlgMp->begin();
   for( ; iter != fOwnedSubAlgMp->end(); ++iter) {
     Algorithm * alg = iter->second;
     if(alg) {
       delete alg;
       alg=0;
     }
   }
   delete fOwnedSubAlgMp;
   fOwnedSubAlgMp = 0;
 }

Registry * Algorithm::ExtractLocalConfig ( const Registry & in ) const

protectedinherited

Split an incoming configuration Registry into a block valid for this algorithm Ownership of the returned registry belongs to the algo

Definition at line 518 of file Algorithm.cxx.

References genie::RegistryItemI::Clone(), genie::Registry::GetItemMap(), genie::Registry::Name(), and confusionMatrixTree::out.

Referenced by genie::Algorithm::AllowReconfig().

                                                                     {
 
   const RgIMap & rgmap = in.GetItemMap();
   Registry * out = new Registry( in.Name(), false );
   
   for( RgIMapConstIter reg_iter = rgmap.begin(); 
        reg_iter != rgmap.end(); ++reg_iter ) {
 
     RgKey reg_key = reg_iter->first;
     if( reg_key.find( '/' ) != string::npos) continue; 
 
     // at this point
     // this key is referred to the local algorithm
     // it has to be copied in out;
       
     RegistryItemI * ri = reg_iter->second;
     RgIMapPair key_item_pair( reg_key, ri->Clone() );
     out -> Set(key_item_pair);
 
   }
 
   if ( out -> NEntries() <= 0 ) {
     delete out ;
     out = 0 ;
   }
 
   return out ;
 }

Registry * Algorithm::ExtractLowerConfig	(	const Registry &	in,
		const string &	alg_key
	)		const

protectedinherited

Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.

Definition at line 549 of file Algorithm.cxx.

References genie::RegistryItemI::Clone(), genie::Registry::GetItemMap(), genie::Registry::Name(), and confusionMatrixTree::out.

Referenced by genie::Algorithm::AllowReconfig().

                                                                                             {
 
   const RgIMap & rgmap = in.GetItemMap();
   Registry * out = new Registry( in.Name(), false );
   
   for( RgIMapConstIter reg_iter = rgmap.begin(); 
        reg_iter != rgmap.end(); ++reg_iter ) {
     
     RgKey reg_key = reg_iter->first;
     if( reg_key.find(alg_key+"/") == string::npos) continue; 
 
     // at this point
     // this key is referred to the sub-algorithm
     // indicated by alg_key: it has to be copied in out;
       
     int new_key_start = reg_key.find_first_of('/')+1;
     RgKey new_reg_key = reg_key.substr( new_key_start, reg_key.length() );
   
     RegistryItemI * ri = reg_iter->second;
     RgIMapPair key_item_pair(new_reg_key, ri->Clone());
     out -> Set(key_item_pair);
 
   }
 
   if ( out -> NEntries() <= 0 ) {
     delete out ;
     out = 0 ;
   }
   
   return out ;
   
 }

void Algorithm::FindConfig ( void )

virtualinherited

Lookup configuration from the config pool Similar logic from void Configure(string)

Definition at line 135 of file Algorithm.cxx.

References gen_flatrecord::config, exit(), genie::AlgConfigPool::FindRegistry(), genie::Registry::GetItemMap(), genie::Registry::GetString(), MECModelEnuComparisons::i, genie::AlgConfigPool::Instance(), it, genie::Registry::ItemIsLocal(), parse_dependency_file_t::list, LOG, pDEBUG, pFATAL, time_estimates::pool, pWARN, moon_position_table_new3::second, genie::utils::str::Split(), string, and APDHVSetting::temp.

 {
 // Finds its configration Registry from the ConfigPool and gets a pointer to
 // it. If the Registry comes from the ConfigPool then the Algorithm does not
 // own its configuration (the ConfigPool singleton keeps the ownership and the
 // responsibility to -eventually- delete all the Registries it instantiates
 // by parsing the XML config files).
 
   DeleteConfig() ;
 
   AlgConfigPool * pool = AlgConfigPool::Instance();
 
   Registry * config = 0 ;
 
   // load the Default config if config is not the default
   if ( fID.Config() != "Default" ) {
     config = pool -> FindRegistry( fID.Name(), "Default" );
     if ( config ) {
       if ( config -> NEntries() > 0 ) {
         AddTopRegistry( config, false ) ;
         LOG("Algorithm", pDEBUG) << "\n" << *config;
       }
     }
   } 
 
   // Load the right config 
   config = pool->FindRegistry(this);
 
   if(!config)
     // notify & keep whatever config Registry was used before.
     LOG("Algorithm", pWARN)
        << "No Configuration available for "
        << this->Id().Key() << " at the ConfigPool";
   else {
     if ( config -> NEntries() > 0 ) {
       AddTopRegistry( config, false ) ;
       LOG("Algorithm", pDEBUG) << "\n" << config;
     }
   }
   
   const string common_key_root = "Common" ;
   std::map<string, string> common_lists;
 
   // Load Common Parameters if key that start with "Common" is found
   for ( unsigned int i = 0 ; i < fConfVect.size() ; ++i ) {
     const Registry & temp = * fConfVect[i] ;
     for ( RgIMapConstIter it = temp.GetItemMap().begin() ; it !=  temp.GetItemMap().end() ; ++it ) {
       
       // check if it is a "Common" entry
       if ( it -> first.find( common_key_root ) == 0 ) {
         // retrieve the type of the common entry
         std::string type = it -> first.substr(common_key_root.size() ) ;
         
         if ( temp.ItemIsLocal( it -> first ) ) {
           
           string temp_list = temp.GetString( it -> first ) ;
           if ( temp_list.length() > 0 ) {
             common_lists[type] = temp_list ;
           }
         }
       }
       
     }
     
   } // loop over the local registries
 
 
   for ( std::map<string, string>::const_iterator it = common_lists.begin() ;
         it != common_lists.end() ; ++it ) {
 
     vector<string> list = str::Split( it -> second , "," ) ;
 
     for ( unsigned int i = 0; i < list.size(); ++i ) {
 
       config = pool -> CommonList( it -> first, list[i] ) ;
 
       if ( ! config ) {
         LOG("Algorithm", pFATAL)
           << "No Commom parameters available for " << it -> first << " list "
           << list[i] << " at the ConfigPool";
 
             exit( 78 ) ;
       }
       else  {
             AddLowRegistry( config, false ) ;
             LOG("Algorithm", pDEBUG) << "Loading " 
                                      << it -> first << " registry " 
                                      << list[i] << " \n" << config;
       }
 
     }
 
   }
 
 
   // Load Tunable from CommonParameters 
   // only if the option is specified in RunOpt
   config = pool -> CommonList( "Param", "Tunable" ) ;
   if ( config ) {
     if ( config -> NEntries() > 0 ) {
       AddTopRegistry( config, false ) ;
       LOG("Algorithm", pDEBUG) << "Loading Tunable registry \n" << config;
     }
   }
   else {
     // notify & keep whatever config Registry was used before.
     LOG("Algorithm", pWARN)
       << "No Tunable parameter set available at the ConfigPool";
   }
 
   if ( fConfig ) {
     delete fConfig ;
     fConfig = 0 ;
   }
 
 }

virtual bool genie::NuclearModelI::GenerateNucleon ( const Target & ) const

pure virtual

Implemented in genie::LocalFGM, genie::NuclearModelMap, genie::FGMBodekRitchie, genie::SpectralFunc1d, genie::EffectiveSF, and genie::SpectralFunc.

Referenced by genie::HNIntranuke2018::AbsorbHN(), genie::HNIntranuke2018::ElasHN(), genie::utils::intranuke::Equilibrium(), genie::HNIntranuke2018::GammaInelasticHN(), genie::NucleonDecayPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateFermiMomentum(), genie::NNBarOscPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::NuclearModelMap::GenerateNucleon(), genie::HAIntranuke::Inelastic(), genie::HAIntranuke2018::Inelastic(), genie::HAIntranuke::InelasticHA(), genie::HAIntranuke2018::InelasticHA(), genie::LwlynSmithQELCCPXSec::Integral(), genie::NewQELXSec::Integrate(), genie::FermiMover::KickHitNucleon(), main(), genie::utils::intranuke::PreEquilibrium(), genie::QELEventGenerator::ProcessEventRecord(), genie::utils::intranuke::ThreeBodyKinematics(), genie::utils::intranuke2018::ThreeBodyKinematics(), and ~NuclearModelI().

bool NuclearModelI::GenerateNucleon	(	const Target &	tgt,
		double	hitNucleonRadius
	)		const

virtual

Reimplemented in genie::LocalFGM, and genie::NuclearModelMap.

Definition at line 39 of file NuclearModelI.cxx.

   {
     return GenerateNucleon(tgt);
   }

const Registry & Algorithm::GetConfig ( void ) const

virtualinherited

Get configuration registry Evaluate the summary of the configuration and returns it The summary of a configuration is a merge of all the registries known to the algorithm (see Configure() methods) but every parameter is appearing only once and in case of repetitions, only the parameter from the registry with the highest prioriry is considered.

Definition at line 254 of file Algorithm.cxx.

References febshutoff_auto::end, genie::Algorithm::GetConfig(), MECModelEnuComparisons::i, LOG, pDEBUG, r(), and moon_position_table_new3::second.

Referenced by genie::EventGeneratorListAssembler::AssembleGeneratorList(), GetAlgorithms(), genie::Algorithm::GetConfig(), genie::GRV98LO::GRV98LO(), genie::NewQELXSec::Integrate(), genie::LHAPDF5::LHAPDF5(), genie::IBDXSecMap::LoadConfig(), genie::Decayer::LoadConfig(), genie::PythiaHadronization::LoadConfig(), genie::FGMBodekRitchie::LoadConfig(), genie::NuclearModelMap::LoadConfig(), genie::SmithMonizUtils::LoadConfig(), main(), genie::AlgFactory::Print(), TestPythiaTauDecays(), testReconfigInOwnedModules(), and genie::P33PaschosLalakulichPXSec::XSec().

                                                 {
 
   if ( fConfig ) return * fConfig ;
 
   const_cast<Algorithm*>( this ) -> fConfig = new Registry( fID.Key() + "_summary", false ) ;
   
   // loop and append 
   // understand the append mechanism
   for ( unsigned int i = 0 ; i < fConfVect.size(); ++i ) {
     fConfig -> Append( * fConfVect[i] ) ;
   } 
 
   if ( fOwnsSubstruc ) {
 
     for ( AlgMapConstIter iter = fOwnedSubAlgMp -> begin() ;
           iter != fOwnedSubAlgMp -> end() ; ++iter ) {
 
       Algorithm * subalg = iter -> second ;
 
       LOG("Algorithm", pDEBUG) << "Appending config from " << iter -> first << " -> " << subalg -> Id() ;
       const Registry & r = subalg->GetConfig();
       RgKey prefix = iter -> first + "/";
       fConfig -> Append(r,prefix);
 
     }
 
   } //if owned substructure
 
   return * fConfig ;
 }

FermiMoverInteractionType_t genie::NuclearModelI::GetFermiMoverInteractionType ( void ) const

inline

Definition at line 72 of file NuclearModelI.h.

References fFermiMoverInteractionType.

Referenced by genie::NuclearModelMap::GenerateNucleon(), and genie::FermiMover::KickHitNucleon().

   {
     return fFermiMoverInteractionType;
   }

Registry * Algorithm::GetOwnedConfig ( void )

inherited

Returns the pointer of the summary registry, see previous method Gives access to the summary so it could be changed. The usage of this method is deprecated as it is mantained only for back compatibility. If you need to add or chage a parter (or more), use the AddTopRegistry() instead

Definition at line 287 of file Algorithm.cxx.

References GetConfig().

Referenced by genie::TransverseEnhancementFFModel::LoadConfig(), and genie::EffectiveSF::LoadConfig().

 {
   
   GetConfig() ;
   return fConfig;
 }

template<class T >

bool genie::Algorithm::GetParam	(	const RgKey &	name,
		T &	p,
		bool	is_top_call = `true`
	)		const

protectedinherited

Ideal access to a parameter value from the vector of registries Returns true if the value is found and the parameters is set

template<class T >

bool genie::Algorithm::GetParamDef	(	const RgKey &	name,
		T &	p,
		const T &	def
	)		const

protectedinherited

Ideal access to a parameter value from the vector of registries, With default value. Returns true if the value is set from the registries, false if the value is the default

template<class T >

bool genie::Algorithm::GetParamVect	(	const std::string &	comm_name,
		std::vector< T > &	v,
		unsigned int	max,
		bool	is_top_call = `true`
	)		const

protectedinherited

Handle to load vectors of parameters It looks for different registry item with name comm_name0, comm_name1, etc...

virtual AlgStatus_t genie::Algorithm::GetStatus ( void ) const

inlinevirtualinherited

Get algorithm status.

Definition at line 101 of file Algorithm.h.

References genie::Algorithm::fStatus.

101 { return fStatus; }

genie::Algorithm::fStatus

AlgStatus_t fStatus

algorithm execution status

Definition: Algorithm.h:166

virtual const AlgId& genie::Algorithm::Id ( void ) const

inlinevirtualinherited

Get algorithm ID.

Definition at line 98 of file Algorithm.h.

References genie::Algorithm::fID.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::QELEventGeneratorSM::AccessCacheBranch2(), genie::QELEventGeneratorSM::AccessCacheBranchDiffv(), genie::InteractionListAssembler::AssembleInteractionList(), genie::XSecAlgorithmMap::BuildMap(), genie::InteractionGeneratorMap::BuildMap(), genie::XSecSplineList::BuildSplineKey(), genie::DISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCache::CacheBranchName(), genie::DMDISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCacheFast::CacheBranchName(), genie::Algorithm::Compare(), genie::RESKinematicsGenerator::ComputeMaxXSec(), genie::COHElKinematicsGenerator::ComputeMaxXSec(), genie::SKKinematicsGenerator::ComputeMaxXSec(), genie::COHKinematicsGenerator::ComputeMaxXSec(), genie::Algorithm::Configure(), genie::GEVGDriver::CreateSplines(), genie::QPMDISPXSec::DISRESJoinSuppressionFactor(), genie::QPMDMDISPXSec::DMDISRESJoinSuppressionFactor(), genie::AlgConfigPool::FindRegistry(), genie::AlgFactory::ForceReconfiguration(), genie::GEVGDriver::GenerateEvent(), GetAlgorithms(), genie::LwlynSmithQELCCPXSec::Integral(), genie::NievesQELCCPXSec::Integral(), genie::COHXSec::Integrate(), genie::QPMDISPXSec::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), genie::EventGenerator::LoadConfig(), genie::EventGeneratorListAssembler::LoadGenerator(), main(), genie::COHKinematicsGenerator::MaxXSec_AlvarezRuso(), genie::XSecAlgorithmMap::Print(), genie::InteractionGeneratorMap::Print(), genie::AlgFactory::Print(), genie::COHHadronicSystemGenerator::ProcessEventRecord(), genie::COHPrimaryLeptonGenerator::ProcessEventRecord(), genie::COHKinematicsGenerator::ProcessEventRecord(), genie::MECGenerator::ProcessEventRecord(), genie::EventGenerator::ProcessEventRecord(), genie::KNOPythiaHadronization::SelectHadronizer(), TestPythiaTauDecays(), and genie::GEVGDriver::UseSplines().

98 { return fID; }

genie::Algorithm::fID

AlgId fID

algorithm name and configuration set

Definition: Algorithm.h:156

void Algorithm::Initialize ( void )

protectedinherited

Definition at line 343 of file Algorithm.cxx.

Referenced by genie::Algorithm::AllowReconfig().

 {
 // Algorithm initialization
 //
   fAllowReconfig  = true;
   fOwnsSubstruc   = false;
   fConfig         = 0;
   fOwnedSubAlgMp  = 0;
 }

int Algorithm::MergeTopRegistry ( const Registry & r )

protectedinherited

Merge with top level registry if first reg of the vector is owned Otherwise an owned copy is added as a top registry

Definition at line 618 of file Algorithm.cxx.

                                                       {
 
   if ( fOwnerships.empty() ) {
 
         // this algorithm is not configured right now, the incoming registry is the only configuration
     Registry * p = new Registry( r ) ;
         AddTopRegistry( p ) ;
 
         return 1 ;
   }
 
   if ( fOwnerships[0] ) {
         //the top registry is owned: it can be changed with no consequences for other algorithms
     fConfVect[0] -> Merge( r ) ;
   }
   else {
         // The top registry is not owned so it cannot be changed
         // The registry will be added with top priority
 
         Registry * p = new Registry( r ) ;
         AddTopRegistry( p ) ;
   }
 
   // The configuration has changed so the summary is not updated anymore and must be deleted
   if ( fConfig ) {
      delete fConfig ;
      fConfig = 0 ;
   }
 
   return fConfVect.size() ;
 }

virtual NuclearModel_t genie::NuclearModelI::ModelType ( const Target & ) const

pure virtual

Implemented in genie::LocalFGM, genie::NuclearModelMap, genie::FGMBodekRitchie, genie::SpectralFunc1d, genie::EffectiveSF, and genie::SpectralFunc.

Referenced by genie::FermiMover::KickHitNucleon(), genie::LwlynSmithQELCCPXSec::LoadConfig(), genie::NievesQELCCPXSec::LoadConfig(), genie::PauliBlocker::LoadModelType(), genie::NuclearModelMap::ModelType(), genie::utils::nuclear::NuclQELXSecSuppression(), and ~NuclearModelI().

double genie::NuclearModelI::Momentum ( void ) const

inline

Definition at line 62 of file NuclearModelI.h.

References fCurrMomentum.

   {
     return fCurrMomentum.Mag();
   }

const TVector3& genie::NuclearModelI::Momentum3 ( void ) const

inline

Definition at line 67 of file NuclearModelI.h.

References fCurrMomentum.

Referenced by genie::HNIntranuke2018::AbsorbHN(), genie::utils::BindHitNucleon(), genie::HNIntranuke2018::ElasHN(), genie::utils::intranuke::Equilibrium(), genie::HNIntranuke2018::GammaInelasticHN(), genie::NucleonDecayPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateFermiMomentum(), genie::NNBarOscPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::NuclearModelMap::GenerateNucleon(), genie::HAIntranuke::Inelastic(), genie::HAIntranuke2018::Inelastic(), genie::HAIntranuke::InelasticHA(), genie::HAIntranuke2018::InelasticHA(), genie::LwlynSmithQELCCPXSec::Integral(), genie::FermiMover::KickHitNucleon(), main(), genie::utils::intranuke::PreEquilibrium(), genie::utils::intranuke::ThreeBodyKinematics(), and genie::utils::intranuke2018::ThreeBodyKinematics().

   {
     return fCurrMomentum;
   }

void Algorithm::Print ( ostream & stream ) const

virtualinherited

Print algorithm info.

Definition at line 323 of file Algorithm.cxx.

References GetConfig(), and r().

Referenced by genie::Algorithm::AllowReconfig(), and genie::operator<<().

 {
   // print algorithm name & parameter-set
   stream << "\nAlgorithm Key: "  << this->fID.Key();
   stream << " - Owns Substruc: " << ((fOwnsSubstruc) ? "[true]" : "[false]");
 
   // print algorithm configuration
   const Registry & r = this->GetConfig();
   stream << r;
 
   if(fOwnsSubstruc) {
     AlgMapConstIter iter = fOwnedSubAlgMp->begin();
     for(; iter!=fOwnedSubAlgMp->end(); ++iter) {
       Algorithm * alg = iter->second;
       stream << "<Next algorithm is owned by : " << this->fID.Key() << ">";
       stream << *alg;
     }
   }
 }

virtual double genie::NuclearModelI::Prob	(	double	p,
		double	w,
		const Target &
	)		const

pure virtual

Implemented in genie::LocalFGM, genie::NuclearModelMap, genie::FGMBodekRitchie, genie::SpectralFunc1d, genie::EffectiveSF, and genie::SpectralFunc.

Referenced by genie::QELEventGenerator::ComputeMaxXSec(), genie::NuclearModelMap::Prob(), and ~NuclearModelI().

double NuclearModelI::Prob	(	double	p,
		double	w,
		const Target &	tgt,
		double	hitNucleonRadius
	)		const

virtual

Reimplemented in genie::LocalFGM, and genie::NuclearModelMap.

Definition at line 45 of file NuclearModelI.cxx.

   {
     return Prob(p,w,tgt);
   }

double genie::NuclearModelI::RemovalEnergy ( void ) const

inline

Definition at line 57 of file NuclearModelI.h.

References fCurrRemovalEnergy.

Referenced by genie::utils::BindHitNucleon(), genie::NucleonDecayPrimaryVtxGenerator::GenerateFermiMomentum(), genie::NNBarOscPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::NuclearModelMap::GenerateNucleon(), genie::FermiMover::KickHitNucleon(), and main().

   {
     return fCurrRemovalEnergy;
   }

void Algorithm::SetId ( const AlgId & id )

virtualinherited

Set algorithm ID.

Definition at line 313 of file Algorithm.cxx.

Referenced by genie::Algorithm::AllowReconfig().

 {
   fID.Copy(id);
 }

void Algorithm::SetId	(	string	name,
		string	config
	)

virtualinherited

Definition at line 318 of file Algorithm.cxx.

 {
   fID.SetId(name, config);
 }

void genie::NuclearModelI::SetMomentum3 ( const TVector3 & mom ) const

inline

Definition at line 78 of file NuclearModelI.h.

References fCurrMomentum.

Referenced by genie::QELEventGenerator::ComputeMaxXSec(), genie::NewQELXSec::Integrate(), and genie::QELEventGenerator::ProcessEventRecord().

   {
     fCurrMomentum = mom;
   };

void genie::NuclearModelI::SetRemovalEnergy ( double E ) const

inline

Definition at line 82 of file NuclearModelI.h.

References E, and fCurrRemovalEnergy.

Referenced by genie::QELEventGenerator::ComputeMaxXSec(), genie::NewQELXSec::Integrate(), and genie::QELEventGenerator::ProcessEventRecord().

   {
     fCurrRemovalEnergy = E;
   }

const Algorithm * Algorithm::SubAlg ( const RgKey & registry_key ) const

inherited

Access the sub-algorithm pointed to by the input key, either from the local pool or from AlgFactory's pool

Definition at line 353 of file Algorithm.cxx.

References ana::assert(), genie::AlgFactory::GetAlgorithm(), genie::AlgFactory::Instance(), LOG, pERROR, and pINFO.

 {
 // Returns the sub-algorithm pointed to this algorithm's XML config file using
 // the the values of the key.
 // This method asserts the existence of these keys in the XML config.
 // Note: Since only 1 parameter is used, the key value should contain both the
 // algorithm name and its configuration set according to the usual scheme:
 // namespace::algorithm_name/configuration_set
 //
   LOG("Algorithm", pINFO)
     << "Fetching sub-alg within alg: " << this->Id().Key()
                                    << " pointed to by key: " << registry_key;
   
   //-- if the algorithm owns its substructure:
   //      return the sub-algorithm from the local pool
   //
   if(fOwnsSubstruc) {
     AlgMapConstIter iter = fOwnedSubAlgMp->find(registry_key);
     if(iter!=fOwnedSubAlgMp->end()) return iter->second;
     LOG("Algorithm", pERROR) 
       << "Owned sub-alg pointed to by key: " << registry_key 
       << " was not found within alg: " << this->Id().Key();
      return 0;
   }
 
   //-- if the algorithm does not own its substructure:
   //      return the sub-algorithm from the AlgFactory's pool
   RgAlg alg ;
   GetParam( registry_key, alg ) ;
 
   LOG("Algorithm", pINFO)
     << "Registry key: " << registry_key << " points to algorithm: " << alg;
   
   // retrieve the Algorithm object from the the Algorithm factory
   AlgFactory * algf = AlgFactory::Instance();
   const Algorithm * algbase = algf->GetAlgorithm(alg.name, alg.config);
   assert(algbase);
 
   return algbase;
 }

Member Data Documentation

bool genie::Algorithm::fAllowReconfig

protectedinherited

Definition at line 153 of file Algorithm.h.

Referenced by genie::Algorithm::AllowReconfig(), genie::Decayer::Configure(), genie::UnstableParticleDecayer::Configure(), genie::LHAPDF5::Configure(), and genie::LHAPDF6::Configure().

vector<Registry*> genie::Algorithm::fConfVect

protectedinherited

ideally these members should go private Registry will be access only through the GetParam method configurations registries from various sources the order of the vector is the precedence in case of repeated parameters position 0 -> Highest precedence

Definition at line 161 of file Algorithm.h.

TVector3 genie::NuclearModelI::fCurrMomentum

mutableprotected

Definition at line 108 of file NuclearModelI.h.

Referenced by genie::NuclearModelMap::GenerateNucleon(), genie::SpectralFunc::GenerateNucleon(), genie::LocalFGM::GenerateNucleon(), genie::EffectiveSF::GenerateNucleon(), genie::SpectralFunc1d::GenerateNucleon(), genie::FGMBodekRitchie::GenerateNucleon(), Momentum(), Momentum3(), and SetMomentum3().

double genie::NuclearModelI::fCurrRemovalEnergy

mutableprotected

Definition at line 105 of file NuclearModelI.h.

Referenced by genie::NuclearModelMap::GenerateNucleon(), genie::SpectralFunc::GenerateNucleon(), genie::LocalFGM::GenerateNucleon(), genie::EffectiveSF::GenerateNucleon(), genie::FGMBodekRitchie::GenerateNucleon(), genie::SpectralFunc1d::GenerateNucleon(), RemovalEnergy(), and SetRemovalEnergy().

FermiMoverInteractionType_t genie::NuclearModelI::fFermiMoverInteractionType

mutableprotected

Definition at line 109 of file NuclearModelI.h.

Referenced by genie::NuclearModelMap::GenerateNucleon(), genie::EffectiveSF::GenerateNucleon(), and GetFermiMoverInteractionType().

AlgId genie::Algorithm::fID

protectedinherited

algorithm name and configuration set

Definition at line 156 of file Algorithm.h.

Referenced by genie::Algorithm::Id().

AlgMap* genie::Algorithm::fOwnedSubAlgMp

protectedinherited

local pool for owned sub-algs (taken out of the factory pool)

Definition at line 167 of file Algorithm.h.

vector<bool> genie::Algorithm::fOwnerships

protectedinherited

ownership for every registry in fConfVect

Definition at line 164 of file Algorithm.h.

bool genie::Algorithm::fOwnsSubstruc

protectedinherited

true if it owns its substructure (sub-algs,...)

Definition at line 155 of file Algorithm.h.

AlgStatus_t genie::Algorithm::fStatus

protectedinherited

algorithm execution status

Definition at line 166 of file Algorithm.h.

Referenced by genie::Algorithm::GetStatus().

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

Physics/NuclearState/NuclearModelI.h
Physics/NuclearState/NuclearModelI.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation