genie::FGMBodekRitchie Class Reference

The Bodek Richie Fermi Gass model. Implements the NuclearModelI interface. More...

#include <FGMBodekRitchie.h>

Inheritance diagram for genie::FGMBodekRitchie:

Collaboration diagram for genie::FGMBodekRitchie:

Public Member Functions
	FGMBodekRitchie ()
	FGMBodekRitchie (string config)
virtual	~FGMBodekRitchie ()
bool	GenerateNucleon (const Target &t) const
double	Prob (double mom, double w, const Target &t) const
NuclearModel_t	ModelType (const Target &) const
virtual double	FermiMomentum (const Target &t, int nucleon_pdg) const
void	Configure (const Registry &config)
void	Configure (string param_set)
virtual bool	GenerateNucleon (const Target &tgt, double hitNucleonRadius) const
virtual double	Prob (double p, double w, const Target &tgt, double hitNucleonRadius) const
Public Member Functions inherited from genie::NuclearModelI
virtual	~NuclearModelI ()
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	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
void	LoadConfig (void)
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.

Private Member Functions
TH1D *	ProbDistro (const Target &t) const

Private Attributes
map< string, TH1D * >	fProbDistroMap
map< int, double >	fNucRmvE
double	fPMax
double	fPCutOff
bool	fUseParametrization

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

The Bodek Richie Fermi Gass model. Implements the NuclearModelI interface.

References:\n

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n October 09, 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 35 of file FGMBodekRitchie.h.

Constructor & Destructor Documentation

FGMBodekRitchie() [1/2]

FGMBodekRitchie::FGMBodekRitchie

(

)

Definition at line 43 of file FGMBodekRitchie.cxx.

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

References genie::NuclearModelI::NuclearModelI().

FGMBodekRitchie() [2/2]

FGMBodekRitchie::FGMBodekRitchie

(

string

config

)

Definition at line 49 of file FGMBodekRitchie.cxx.

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

References genie::NuclearModelI::NuclearModelI().

~FGMBodekRitchie()

FGMBodekRitchie::~FGMBodekRitchie ( )

virtual

Definition at line 55 of file FGMBodekRitchie.cxx.

{
  map<string, TH1D*>::iterator iter = fProbDistroMap.begin();
  for( ; iter != fProbDistroMap.end(); ++iter) {
    TH1D * hst = iter->second;
    if(hst) {
      delete hst;
      hst=0;
    }
  }
  fProbDistroMap.clear();
}

References fProbDistroMap.

Member Function Documentation

Configure() [1/2]

void FGMBodekRitchie::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 229 of file FGMBodekRitchie.cxx.

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

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

Configure() [2/2]

void FGMBodekRitchie::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 235 of file FGMBodekRitchie.cxx.

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

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

FermiMomentum()

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

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 195 of file FGMBodekRitchie.cxx.

                                                                               {
 
  assert( pdg::IsProton(nucleon_pdg) || pdg::IsNeutron(nucleon_pdg) );
 
  if ( t.A()<6 || !fUseParametrization ) {
    //-- look up the Fermi momentum for this Target from tables
    return NuclearModelI::FermiMomentum( t, nucleon_pdg ) ;
  }
  else
  {
    //-- define the Fermi momentum for this Target
    double kF = nuclear::FermiMomentumForIsoscalarNucleonParametrization(t);
 
    //-- correct the Fermi momentum for the struck nucleon
    assert(t.HitNucIsSet());
 
    double A = (double) t.A() ;
    if( pdg::IsProton(nucleon_pdg) ) {
      double Z = (double) t.Z() ; 
      kF *= TMath::Power( 2*Z/A, 1./3.);
    }
    else {
      double N = (double) t.N() ;
      kF *= TMath::Power( 2*N/A, 1./3.);
    }
    
    LOG("BodekRitchie", pINFO) << "Corrected KF = " << kF;
    
    return kF ; 
 
  }
 
}

References genie::Target::A(), genie::NuclearModelI::FermiMomentum(), genie::utils::nuclear::FermiMomentumForIsoscalarNucleonParametrization(), fUseParametrization, genie::Target::HitNucIsSet(), genie::pdg::IsNeutron(), genie::pdg::IsProton(), LOG, genie::Target::N(), pINFO, and genie::Target::Z().

Referenced by ProbDistro().

GenerateNucleon() [1/2]

bool FGMBodekRitchie::GenerateNucleon ( const Target & t ) const

virtual

Implements genie::NuclearModelI.

Definition at line 68 of file FGMBodekRitchie.cxx.

{
  assert(target.HitNucIsSet());
 
  fCurrRemovalEnergy = 0;
  fCurrMomentum.SetXYZ(0,0,0);
 
  //-- set fermi momentum vector
  //
  TH1D * prob = this->ProbDistro(target);
  if ( ! prob ) {
    LOG("BodekRitchie", pNOTICE)
              << "Null nucleon momentum probability distribution";
    exit(1);
  }
  double p = prob->GetRandom();
  LOG("BodekRitchie", pINFO) << "|p,nucleon| = " << p;
 
  RandomGen * rnd = RandomGen::Instance();
 
  double costheta = -1. + 2. * rnd->RndGen().Rndm();
  double sintheta = TMath::Sqrt(1.-costheta*costheta);
  double fi       = 2 * kPi * rnd->RndGen().Rndm();
  double cosfi    = TMath::Cos(fi);
  double sinfi    = TMath::Sin(fi);
 
  double px = p*sintheta*cosfi;
  double py = p*sintheta*sinfi;
  double pz = p*costheta;
 
  fCurrMomentum.SetXYZ(px,py,pz);
 
  //-- set removal energy
  //
  if ( target.A() < 6 || ! fUseParametrization )
  {
     int Z = target.Z();
     map<int,double>::const_iterator it = fNucRmvE.find(Z);
     if(it != fNucRmvE.end()) fCurrRemovalEnergy = it->second;
     else fCurrRemovalEnergy = nuclear::BindEnergyPerNucleon(target);
  }
  else {
     fCurrRemovalEnergy = nuclear::BindEnergyPerNucleonParametrization(target);
  }
 
  return true;
}

References genie::Target::A(), genie::utils::nuclear::BindEnergyPerNucleon(), genie::utils::nuclear::BindEnergyPerNucleonParametrization(), genie::NuclearModelI::fCurrMomentum, genie::NuclearModelI::fCurrRemovalEnergy, fNucRmvE, fUseParametrization, genie::Target::HitNucIsSet(), genie::RandomGen::Instance(), genie::constants::kPi, LOG, pINFO, pNOTICE, ProbDistro(), genie::RandomGen::RndGen(), and genie::Target::Z().

GenerateNucleon() [2/2]

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

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 52 of file NuclearModelI.cxx.

  {
    return GenerateNucleon(tgt);
  }

LoadConfig()

void FGMBodekRitchie::LoadConfig ( void )

protectedvirtual

Reimplemented from genie::NuclearModelI.

Definition at line 241 of file FGMBodekRitchie.cxx.

{
 
  NuclearModelI::LoadConfig() ; 
  
  // Default value 4.0 from original paper by A. Bodek and J. L. Ritchie. Phys. Rev. D 23, 1070
  this->GetParamDef("MomentumMax", fPMax, 4.0);
  this->GetParam("RFG-MomentumCutOff", fPCutOff);
  this->GetParam("RFG-UseParametrization", fUseParametrization);
 
  assert(fPMax > 0 && fPCutOff > 0 && fPCutOff < fPMax);
 
  // Load removal energy for specific nuclei from either the algorithm's
  // configuration file or the UserPhysicsOptions file.
  // If none is used use Wapstra's semi-empirical formula.
  const std::string keyStart = "RFG-NucRemovalE@Pdg=";
 
  RgIMap entries = GetConfig().GetItemMap();
 
  for(RgIMap::const_iterator it = entries.begin(); it != entries.end(); ++it){
    const std::string& key = it->first;
    int pdg = 0;
    int Z = 0;
    if (0 == key.compare(0, keyStart.size(), keyStart.c_str())) {
      pdg = atoi(key.c_str() + keyStart.size());
      Z = pdg::IonPdgCodeToZ(pdg);
    }
    if (0 != pdg && 0 != Z) {
      ostringstream key_ss ;
      key_ss << keyStart << pdg;
      RgKey rgkey   = key_ss.str();
      double eb ;
      GetParam( rgkey, eb ) ;
      eb = TMath::Max(eb, 0.);
      LOG("BodekRitchie", pINFO)
        << "Nucleus: " << pdg << " -> using Eb =  " << eb << " GeV";
      fNucRmvE.insert(map<int,double>::value_type(Z,eb));
    }
  }
 
  LOG("BodekRitchie", pDEBUG)
    << "Finished LoadConfig";
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  for (map<int,double>::iterator it = fNucRmvE.begin(); it != fNucRmvE.end(); ++it) {
    LOG("BodekRitchie", pDEBUG)
      << "Z = " << (*it).first << "; eb = " << (*it).second;
  }
#endif
}

References fNucRmvE, fPCutOff, fPMax, fUseParametrization, genie::Algorithm::GetConfig(), genie::Registry::GetItemMap(), genie::Algorithm::GetParam(), genie::Algorithm::GetParamDef(), genie::pdg::IonPdgCodeToZ(), genie::NuclearModelI::LoadConfig(), LOG, pDEBUG, and pINFO.

Referenced by Configure(), and Configure().

ModelType()

NuclearModel_t genie::FGMBodekRitchie::ModelType ( const Target & ) const

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 48 of file FGMBodekRitchie.h.

  { 
    return kNucmFermiGas; 
  }

References genie::kNucmFermiGas.

Prob() [1/2]

double FGMBodekRitchie::Prob ( double mom, double w, const Target & t ) const

virtual

Implements genie::NuclearModelI.

Definition at line 116 of file FGMBodekRitchie.cxx.

{
  if(w<0) {
     TH1D * prob_distr = this->ProbDistro(target);
     int bin = prob_distr->FindBin(mom);
     double y  = prob_distr->GetBinContent(bin);
     double dx = prob_distr->GetBinWidth(bin);
     double prob = y*dx;
     return prob;
  }
  return 1;
}

References ProbDistro().

Prob() [2/2]

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

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 56 of file NuclearModelI.cxx.

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

ProbDistro()

TH1D * FGMBodekRitchie::ProbDistro ( const Target & t ) const

private

Definition at line 129 of file FGMBodekRitchie.cxx.

{
  //-- return stored /if already computed/
  map<string, TH1D*>::iterator it = fProbDistroMap.find(target.AsString());
  if(it != fProbDistroMap.end()) return it->second;
 
  LOG("BodekRitchie", pNOTICE)
             << "Computing P = f(p_nucleon) for: " << target.AsString();
  LOG("BodekRitchie", pNOTICE)
               << "P(cut-off) = " << fPCutOff << ", P(max) = " << fPMax;
 
  //-- get information for the nuclear target
  //int target_pdgc  = pdg::IonPdgCode(target.A(), target.Z());
  int nucleon_pdgc = target.HitNucPdg();
  assert( pdg::IsProton(nucleon_pdgc) || pdg::IsNeutron(nucleon_pdgc) );
 
  double KF = FermiMomentum( target, nucleon_pdgc ) ;
 
  double a  = 2.0;
  double C  = 4. * kPi * TMath::Power(KF,3) / 3.;
  double R  = 1. / (1.- KF/fPMax);
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  LOG("BodekRitchie", pDEBUG) << "a  = " << a;
  LOG("BodekRitchie", pDEBUG) << "C  = " << C;
  LOG("BodekRitchie", pDEBUG) << "R  = " << R;
#endif
 
  //-- create the probability distribution
 
  int npbins = (int) (1000*fPMax);
  TH1D * prob = new TH1D("", "", npbins, 0, fPMax);
  prob->SetDirectory(0);
 
  double dp = fPMax / (npbins-1);
  double iC = (C>0) ? 1./C : 0.;
  double kfa_pi_2 = TMath::Power(KF*a/kPi,2);
 
  for(int i = 0; i < npbins; i++) {
     double p  = i * dp;
     double p2 = TMath::Power(p,2);
 
     // calculate |phi(p)|^2
     double phi2 = 0;
     if (p <= KF)
        phi2 = iC * (1. - 6.*kfa_pi_2);
     else if ( p > KF && p < fPCutOff)
        phi2 = iC * (2*R*kfa_pi_2*TMath::Power(KF/p,4.));
 
     // calculate probability density : dProbability/dp
     double dP_dp = 4*kPi * p2 * phi2;
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
     LOG("BodekRitchie", pDEBUG) << "p = " << p << ", dP/dp = " << dP_dp;
#endif
     prob->Fill(p, dP_dp);
  }
 
  //-- normalize the probability distribution
  prob->Scale( 1.0 / prob->Integral("width") );
 
  //-- store
  fProbDistroMap.insert(
      map<string, TH1D*>::value_type(target.AsString(),prob));
 
  return prob;
}

References a, genie::Target::AsString(), FermiMomentum(), fPCutOff, fPMax, fProbDistroMap, genie::Target::HitNucPdg(), genie::pdg::IsNeutron(), genie::pdg::IsProton(), genie::constants::kPi, LOG, pDEBUG, and pNOTICE.

Referenced by GenerateNucleon(), and Prob().

Member Data Documentation

fNucRmvE

map<int, double> genie::FGMBodekRitchie::fNucRmvE

private

Definition at line 69 of file FGMBodekRitchie.h.

Referenced by GenerateNucleon(), and LoadConfig().

fPCutOff

double genie::FGMBodekRitchie::fPCutOff

private

Definition at line 72 of file FGMBodekRitchie.h.

Referenced by LoadConfig(), and ProbDistro().

fPMax

double genie::FGMBodekRitchie::fPMax

private

Definition at line 71 of file FGMBodekRitchie.h.

Referenced by LoadConfig(), and ProbDistro().

fProbDistroMap

map<string, TH1D *> genie::FGMBodekRitchie::fProbDistroMap

mutableprivate

Definition at line 67 of file FGMBodekRitchie.h.

Referenced by ProbDistro(), and ~FGMBodekRitchie().

fUseParametrization

bool genie::FGMBodekRitchie::fUseParametrization

private

Definition at line 73 of file FGMBodekRitchie.h.

Referenced by FermiMomentum(), GenerateNucleon(), and LoadConfig().

---

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

• FGMBodekRitchie.h
• FGMBodekRitchie.cxx