genie::SpectralFunc1d Class Reference

Simpler approach to using spectral functions. A beta version. Implements the NuclearModelI interface. More...

#include <SpectralFunc1d.h>

Inheritance diagram for genie::SpectralFunc1d:

Collaboration diagram for genie::SpectralFunc1d:

Public Member Functions
	SpectralFunc1d ()
	SpectralFunc1d (string config)
virtual	~SpectralFunc1d ()
bool	GenerateNucleon (const Target &t) const
double	Prob (double p, double w, const Target &t) const
NuclearModel_t	ModelType (const Target &) 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	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	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
void	CleanUp (void)

Private Attributes
bool	fUseRFGRemovalE
bool	fUseRFGMomentumCutoff
double	fPCutOff
map< int, Spline * >	fSFk
	All available spectral funcs integrated over removal energy.
map< int, Spline * >	fSFw
	Average nucleon removal as a function of pF - computed from the spectral function.
map< int, double >	fNucRmvE
	Removal energies as used in FG model.
map< int, double >	fMaxProb
	Max SF(k) probability used in rejection method.

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

Simpler approach to using spectral functions. A beta version. 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 SpectralFunc1d.h.

Constructor & Destructor Documentation

SpectralFunc1d() [1/2]

SpectralFunc1d::SpectralFunc1d

(

)

Definition at line 40 of file SpectralFunc1d.cxx.

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

References genie::NuclearModelI::NuclearModelI().

SpectralFunc1d() [2/2]

SpectralFunc1d::SpectralFunc1d

(

string

config

)

Definition at line 46 of file SpectralFunc1d.cxx.

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

References genie::NuclearModelI::NuclearModelI().

~SpectralFunc1d()

SpectralFunc1d::~SpectralFunc1d ( )

virtual

Definition at line 52 of file SpectralFunc1d.cxx.

{
  this->CleanUp();
}

References CleanUp().

Member Function Documentation

CleanUp()

void SpectralFunc1d::CleanUp ( void )

private

Definition at line 238 of file SpectralFunc1d.cxx.

{
  map<int, Spline*>::iterator spliter;
 
  for(spliter = fSFk.begin(); spliter != fSFk.end(); ++spliter) {
    Spline * spl = spliter->second;
    if(spl) delete spl;
  }
  for(spliter = fSFw.begin(); spliter != fSFw.end(); ++spliter) {
    Spline * spl = spliter->second;
    if(spl) delete spl;
  }
  fSFk.clear();
  fSFw.clear();
  fNucRmvE.clear();
  fMaxProb.clear();
}

References fMaxProb, fNucRmvE, fSFk, and fSFw.

Referenced by LoadConfig(), and ~SpectralFunc1d().

Configure() [1/2]

void SpectralFunc1d::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 145 of file SpectralFunc1d.cxx.

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

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

Configure() [2/2]

void SpectralFunc1d::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 151 of file SpectralFunc1d.cxx.

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

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

GenerateNucleon() [1/2]

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

virtual

Implements genie::NuclearModelI.

Definition at line 57 of file SpectralFunc1d.cxx.

{
  RandomGen * rnd = RandomGen::Instance();
  int Z = target.Z();
 
  map<int, double>::const_iterator  dbl_it;
  map<int, Spline*>::const_iterator spl_it;
 
  // Select fermi momentum from the integrated (over removal energies) s/f.
  //
  spl_it = fSFk.find(Z);
  dbl_it = fMaxProb.find(Z);
  if(spl_it == fSFk.end() || dbl_it == fMaxProb.end()) {
    fCurrRemovalEnergy = 0.;
    fCurrMomentum.SetXYZ(0.,0.,0.);
    return false;
  }
 
  double prob_max = dbl_it->second;
  LOG("SpectralFunc1", pDEBUG) << "Max probability = " << prob_max;
 
  double p = 0;
  unsigned int niter = 0;
  while(1) {
    if(niter > kRjMaxIterations) {
       LOG("SpectralFunc1", pWARN)
        << "Couldn't generate a hit nucleon after " << niter << " iterations";
       return false;
    }
    niter++;
 
    if(fUseRFGMomentumCutoff) p = fPCutOff * rnd->RndGen().Rndm();
    else p = rnd->RndGen().Rndm();
 
    double prob  = spl_it->second->Evaluate(p);
    double probg = prob_max * rnd->RndGen().Rndm();
    LOG("SpectralFunc1", pDEBUG) << "Trying p = " << p << " / prob = " << prob;
 
    bool accept = (probg<prob);
    if(accept) break;
  }
 
  LOG("SpectralFunc1", pINFO) << "|p,nucleon| = " << p;
 
  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
  // Do it either in the same way as in the FG model or by using the average
  // removal energy for the seleced pF as calculated from the s/f itself
  //
  if(fUseRFGRemovalE) {
    dbl_it = fNucRmvE.find(Z);
    if(dbl_it != fNucRmvE.end()) fCurrRemovalEnergy = dbl_it->second;
    else fCurrRemovalEnergy = nuclear::BindEnergyPerNucleon(target);
  } else {
    spl_it = fSFw.find(Z);
    if(spl_it==fSFw.end()) {
       fCurrRemovalEnergy = 0.;
       fCurrMomentum.SetXYZ(0.,0.,0.);
       return false;
    } else fCurrRemovalEnergy = spl_it->second->Evaluate(p);
  }
 
  return true;
}

References genie::utils::nuclear::BindEnergyPerNucleon(), genie::NuclearModelI::fCurrMomentum, genie::NuclearModelI::fCurrRemovalEnergy, fMaxProb, fNucRmvE, fPCutOff, fSFk, fSFw, fUseRFGMomentumCutoff, fUseRFGRemovalE, genie::RandomGen::Instance(), genie::constants::kPi, genie::controls::kRjMaxIterations, LOG, pDEBUG, pINFO, pWARN, 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 SpectralFunc1d::LoadConfig ( void )

protectedvirtual

Reimplemented from genie::NuclearModelI.

Definition at line 157 of file SpectralFunc1d.cxx.

{
  
  NuclearModelI::LoadConfig() ; 
 
  LOG("SpectralFunc1", pDEBUG) << "Loading coonfiguration for SpectralFunc1d";
 
  this->CleanUp();
 
  // Load spectral function data.
  // Hopefully analytical expressions will be available soon.
  // Currently I have spectral functions for C12 and Fe56 only.
  //
  string data_dir =
      string(gSystem->Getenv("GENIE")) + string("/data/evgen/nucl/spectral_functions/");
 
  string c12_sf1dk_file  = data_dir + "benhar-sf1dk-12c.data";
  string fe56_sf1dk_file = data_dir + "benhar-sf1dk-56fe.data";
  string c12_sf1dw_file  = data_dir + "benhar-sf1dw-12c.data";
  string fe56_sf1dw_file = data_dir + "benhar-sf1dw-56fe.data";
 
  Spline * spl = 0;
 
  spl = new Spline(c12_sf1dk_file);
  fSFk.insert(map<int, Spline*>::value_type(6,spl));
  spl = new Spline(fe56_sf1dk_file);
  fSFk.insert(map<int, Spline*>::value_type(26,spl));
 
  spl = new Spline(c12_sf1dw_file);
  fSFw.insert(map<int, Spline*>::value_type(6,spl));
  spl = new Spline(fe56_sf1dw_file);
  fSFw.insert(map<int, Spline*>::value_type(26,spl));
 
  // scan for max.
  map<int, Spline*>::const_iterator spliter;
  int    n    = 100;
  double pmin =  0.000;
  double dp   =  0.010;
  for(spliter = fSFk.begin(); spliter != fSFk.end(); ++spliter) {
    double prob_max = 0;
    int Z = spliter->first;
    spl = spliter->second;
    for(int i=0; i<n; i++) {
       double p = pmin + i*dp;
       prob_max = TMath::Max(prob_max, spl->Evaluate(p));
    }
    fMaxProb.insert(map<int,double>::value_type(Z,prob_max));
  }
 
  // Check whether to use the same removal energies as in the FG model or
  // to use the average removal energy for the selected fermi momentum
  // (computed from the spectral function itself)
  GetParam( "UseRFGRemovalE", fUseRFGRemovalE ) ;
 
  // Check whether to use the same momentum cutoff as in the FG model
  GetParam("UseRFGMomentumCutoff", fUseRFGMomentumCutoff ) ;
 
  //Get the momentum cutoff
  GetParam( "RFG-MomentumCutOff", fPCutOff ) ;
 
  // Removal energies as used in the FG model
  // 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.
  for(int Z=1; Z<140; Z++) {
    for(int A=Z; A<3*Z; A++) {
      ostringstream key;
      int pdgc = pdg::IonPdgCode(A,Z);
      key   << "RFG-NucRemovalE@Pdg="     << pdgc;
      RgKey rgkey   = key.str();
      double eb ;
      if ( GetParam( rgkey, eb, false ) ) {
        eb = TMath::Max(eb, 0.);
        LOG("BodekRitchie", pNOTICE)
          << "Nucleus: " << pdgc << " -> using Eb =  " << eb << " GeV";
        fNucRmvE.insert(map<int,double>::value_type(Z,eb));
      }
    }
  }
}

References CleanUp(), genie::Spline::Evaluate(), fMaxProb, fNucRmvE, fPCutOff, fSFk, fSFw, fUseRFGMomentumCutoff, fUseRFGRemovalE, genie::Algorithm::GetParam(), genie::pdg::IonPdgCode(), genie::NuclearModelI::LoadConfig(), LOG, pDEBUG, and pNOTICE.

Referenced by Configure(), and Configure().

ModelType()

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

inlinevirtual

is not really a spectral func model, just a FG model with different momentum distribution

Implements genie::NuclearModelI.

Definition at line 48 of file SpectralFunc1d.h.

  {
    return kNucmFermiGas; /// is not really a spectral func model, just a FG model with different momentum distribution
  }

References genie::kNucmFermiGas.

Prob() [1/2]

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

virtual

Implements genie::NuclearModelI.

Definition at line 133 of file SpectralFunc1d.cxx.

{
  if(fUseRFGMomentumCutoff) { if(p > fPCutOff) return 0; }
 
  int Z = target.Z();
  map<int, Spline*>::const_iterator spl_it = fSFk.find(Z);
 
  if(spl_it == fSFk.end()) return 0;
  else return TMath::Max(0.,spl_it->second->Evaluate(p));
}

References fPCutOff, fSFk, fUseRFGMomentumCutoff, and genie::Target::Z().

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

Member Data Documentation

fMaxProb

map<int, double> genie::SpectralFunc1d::fMaxProb

private

Max SF(k) probability used in rejection method.

Definition at line 74 of file SpectralFunc1d.h.

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

fNucRmvE

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

private

Removal energies as used in FG model.

Definition at line 73 of file SpectralFunc1d.h.

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

fPCutOff

double genie::SpectralFunc1d::fPCutOff

private

Definition at line 70 of file SpectralFunc1d.h.

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

fSFk

map<int, Spline *> genie::SpectralFunc1d::fSFk

private

All available spectral funcs integrated over removal energy.

Definition at line 71 of file SpectralFunc1d.h.

Referenced by CleanUp(), GenerateNucleon(), LoadConfig(), and Prob().

fSFw

map<int, Spline *> genie::SpectralFunc1d::fSFw

private

Average nucleon removal as a function of pF - computed from the spectral function.

Definition at line 72 of file SpectralFunc1d.h.

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

fUseRFGMomentumCutoff

bool genie::SpectralFunc1d::fUseRFGMomentumCutoff

private

Definition at line 69 of file SpectralFunc1d.h.

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

fUseRFGRemovalE

bool genie::SpectralFunc1d::fUseRFGRemovalE

private

Definition at line 68 of file SpectralFunc1d.h.

Referenced by GenerateNucleon(), and LoadConfig().

---

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

• SpectralFunc1d.h
• SpectralFunc1d.cxx