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

Inheritance diagram for genie::NuclearModelI:

[legend]

Collaboration diagram for genie::NuclearModelI:

[legend]

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

virtual double	FermiMomentum (const Target &, int nucleon_pdg) const

virtual double	LocalFermiMomentum (const Target &, int nucleon_pdg, double radius) const

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

virtual void	LoadConfig ()

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

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

Private Attributes
const genie::FermiMomentumTable *	fKFTable

string	fKFTableName

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)

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 <c.andreopoulos cern.ch> University of Liverpool

Created:: October 09, 2004

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

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.

@ Jul 2020 - Marco Roda Added fooks for FermiMomentum and LocalFermiMomentum

Definition at line 46 of file NuclearModelI.h.

Constructor & Destructor Documentation

virtual genie::NuclearModelI::~NuclearModelI ( )

inlinevirtual

Definition at line 49 of file NuclearModelI.h.

49 {};

genie::NuclearModelI::NuclearModelI ( )

inlineprotected

Definition at line 96 of file NuclearModelI.h.

     : Algorithm()
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     , fKFTable(nullptr)
     , fKFTableName("Unspecified")
     {};

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

inlineprotected

Definition at line 104 of file NuclearModelI.h.

     : Algorithm(name)
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     , fKFTable(nullptr)
     , fKFTableName("Unspecified")
     {};

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

inlineprotected

Definition at line 112 of file NuclearModelI.h.

     : Algorithm(name, config)
     , fCurrRemovalEnergy(0)
     , fCurrMomentum(0,0,0)
     , fFermiMoverInteractionType(kFermiMoveDefault)
     , fKFTable(nullptr)
     , fKFTableName("Unspecified")
     {};

Member Function Documentation

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

virtual

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

Definition at line 54 of file NuclearModelI.cxx.

References genie::Target::Pdg().

Referenced by genie::FGMBodekRitchie::FermiMomentum().

                                                                              {
 
   if ( ! fKFTable ) return 0. ; 
 
   return fKFTable->FindClosestKF( t.Pdg(), nucleon_pdg);
 
 }

const genie::FermiMomentumTable& genie::NuclearModelI::FermiMomentumTable ( ) const

inlineprotected

Definition at line 124 of file NuclearModelI.h.

References fKFTable.

124 { return *fKFTable ; }

genie::NuclearModelI::fKFTable

const genie::FermiMomentumTable * fKFTable

Definition: NuclearModelI.h:133

const string& genie::NuclearModelI::FermiMomentumTableName ( ) const

inlineprotected

Definition at line 123 of file NuclearModelI.h.

References fKFTableName.

123 { return fKFTableName; }

genie::NuclearModelI::fKFTableName

string fKFTableName

Definition: NuclearModelI.h:134

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::NNBarOscPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::NuclearModelMap::GenerateNucleon(), genie::QELEventGeneratorSuSA::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::DMELEventGenerator::ProcessEventRecord(), genie::utils::intranuke::ThreeBodyKinematics(), and genie::utils::intranuke2018::ThreeBodyKinematics().

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

virtual

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

Definition at line 40 of file NuclearModelI.cxx.

   {
     return GenerateNucleon(tgt);
   }

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

inline

Definition at line 80 of file NuclearModelI.h.

References fFermiMoverInteractionType.

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

   {
     return fFermiMoverInteractionType;
   }

void NuclearModelI::LoadConfig ( void )

protectedvirtual

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

Definition at line 72 of file NuclearModelI.cxx.

References genie::utils::xml::GetString(), genie::FermiMomentumTablePool::GetTable(), genie::FermiMomentumTablePool::Instance(), and genie::AlgConfigPool::Instance().

Referenced by genie::SpectralFunc::LoadConfig(), genie::SpectralFunc1d::LoadConfig(), genie::FGMBodekRitchie::LoadConfig(), genie::LocalFGM::LoadConfig(), and genie::EffectiveSF::LoadConfig().

                                {
 
   string fermi_table_key = "FermiMomentumTable" ;
 
   // first try to get the Fermi Momentum table from the specific model configurtaion
   if ( ! GetParam( fermi_table_key, fKFTableName, false ) ) {
 
     // if that fails, the information should come from the Global Config 
     Registry * algos = AlgConfigPool::Instance() -> GlobalParameterList() ;
     fKFTableName = algos -> GetString( fermi_table_key ) ;
     
   }
 
   FermiMomentumTablePool * kftp = FermiMomentumTablePool::Instance();
   fKFTable = kftp->GetTable(fKFTableName);
 
   // Note that model specifications can abvoid the usage of the table
   // but if this configuration is called it's necessary that the table is set.
   assert(fKFTable);
   
 }

double NuclearModelI::LocalFermiMomentum	(	const Target &	t,
		int	nucleon_pdg,
		double	radius
	)		const

virtual

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

Definition at line 64 of file NuclearModelI.cxx.

Referenced by genie::utils::BindHitNucleon().

                                                            {
   return FermiMomentum( t, nucleon_pdg ) ;
 
 }

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::LwlynSmithQELCCPXSec::LoadConfig(), genie::NievesQELCCPXSec::LoadConfig(), genie::PauliBlocker::LoadModelType(), genie::NuclearModelMap::ModelType(), and genie::utils::nuclear::NuclQELXSecSuppression().

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

inline

Definition at line 70 of file NuclearModelI.h.

References fCurrMomentum.

   {
     return fCurrMomentum.Mag();
   }

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

inline

Definition at line 75 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::NNBarOscPrimaryVtxGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateFermiMomentum(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::NuclearModelMap::GenerateNucleon(), genie::QELEventGeneratorSuSA::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;
   }

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::DMELEventGenerator::ComputeMaxXSec(), and genie::NuclearModelMap::Prob().

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

virtual

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

Definition at line 46 of file NuclearModelI.cxx.

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

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

inline

Definition at line 65 of file NuclearModelI.h.

References fCurrRemovalEnergy.

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

   {
     return fCurrRemovalEnergy;
   }

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

inline

Definition at line 86 of file NuclearModelI.h.

References fCurrMomentum.

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

   {
     fCurrMomentum = mom;
   };

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

inline

Definition at line 90 of file NuclearModelI.h.

References fCurrRemovalEnergy.

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

   {
     fCurrRemovalEnergy = E;
   }

Member Data Documentation

TVector3 genie::NuclearModelI::fCurrMomentum

mutableprotected

Definition at line 127 of file NuclearModelI.h.

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

double genie::NuclearModelI::fCurrRemovalEnergy

mutableprotected

Definition at line 126 of file NuclearModelI.h.

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

FermiMoverInteractionType_t genie::NuclearModelI::fFermiMoverInteractionType

mutableprotected

Definition at line 128 of file NuclearModelI.h.

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

const genie::FermiMomentumTable* genie::NuclearModelI::fKFTable

private

Definition at line 133 of file NuclearModelI.h.

Referenced by FermiMomentumTable().

string genie::NuclearModelI::fKFTableName

private

Definition at line 134 of file NuclearModelI.h.

Referenced by FermiMomentumTableName().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation