genie::SpectralFunc Class Reference

A realistic spectral function - based nuclear model. Is a concrete implementation of the NuclearModelI interface. More...

#include <SpectralFunc.h>

Inheritance diagram for genie::SpectralFunc:

Collaboration diagram for genie::SpectralFunc:

Public Member Functions
	SpectralFunc ()
	SpectralFunc (string config)
virtual	~SpectralFunc ()
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 config)
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
TGraph2D *	Convert2Graph (TNtupleD &data) const
TGraph2D *	SelectSpectralFunction (const Target &target) const

Private Attributes
TGraph2D *	fSfFe56
	Benhar's Fe56 SF.
TGraph2D *	fSfC12
	Benhar's C12 SF.

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

A realistic spectral function - based nuclear model. Is a concrete implementation of the NuclearModelI interface.

Author

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

Created:\n May 07, 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 31 of file SpectralFunc.h.

Constructor & Destructor Documentation

SpectralFunc() [1/2]

SpectralFunc::SpectralFunc

(

)

Definition at line 35 of file SpectralFunc.cxx.

                           :
NuclearModelI("genie::SpectralFunc")
{
  fSfFe56 = 0;
  fSfC12  = 0;
}

References fSfC12, fSfFe56, and genie::NuclearModelI::NuclearModelI().

SpectralFunc() [2/2]

SpectralFunc::SpectralFunc

(

string

config

)

Definition at line 42 of file SpectralFunc.cxx.

                                        :
NuclearModelI("genie::SpectralFunc", config)
{
  fSfFe56 = 0;
  fSfC12  = 0;
}

References fSfC12, fSfFe56, and genie::NuclearModelI::NuclearModelI().

~SpectralFunc()

SpectralFunc::~SpectralFunc ( )

virtual

Definition at line 49 of file SpectralFunc.cxx.

{
//if (fSfFe56) delete fSfFe56;
//if (fSfC12 ) delete fSfC12;
}

Member Function Documentation

Configure() [1/2]

void SpectralFunc::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 132 of file SpectralFunc.cxx.

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

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

Configure() [2/2]

void SpectralFunc::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 138 of file SpectralFunc.cxx.

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

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

Convert2Graph()

TGraph2D * SpectralFunc::Convert2Graph ( TNtupleD & data ) const

private

Definition at line 176 of file SpectralFunc.cxx.

{
  int np = sfdata.GetEntries();
  TGraph2D * sfgraph = new TGraph2D(np);
 
  sfdata.Draw("k:e:prob","","GOFF");
  assert(np==sfdata.GetSelectedRows());
  double * k = sfdata.GetV1();
  double * e = sfdata.GetV2();
  double * p = sfdata.GetV3();
 
  for(int i=0; i<np; i++) {
    double ki = k[i] * (units::MeV/units::GeV); // momentum
    double ei = e[i] * (units::MeV/units::GeV); // removal energy
    double pi = p[i] * TMath::Power(ki,2);      // probabillity
    sfgraph->SetPoint(i, ki,ei,pi);
  }
  return sfgraph;
}

References e, genie::units::GeV, and genie::units::MeV.

Referenced by LoadConfig().

GenerateNucleon() [1/2]

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

virtual

Implements genie::NuclearModelI.

Definition at line 55 of file SpectralFunc.cxx.

{
  TGraph2D * sf = this->SelectSpectralFunction(target);
 
  if(!sf) {
    fCurrRemovalEnergy = 0.;
    fCurrMomentum.SetXYZ(0.,0.,0.);
    return false;
  }
 
  double kmin    = sf->GetXmin(); // momentum range
  double kmax    = sf->GetXmax();
  double wmin    = sf->GetYmin(); // removal energy range
  double wmax    = sf->GetYmax();
  double probmax = sf->GetZmax(); // maximum probability
  probmax *= 1.1;
 
  double dk = kmax - kmin;
  double dw = wmax - wmin;
 
  LOG("SpectralFunc", pINFO) << "Momentum range = ["   << kmin << ", " << kmax << "]"; 
  LOG("SpectralFunc", pINFO) << "Rmv energy range = [" << wmin << ", " << wmax << "]";
 
  RandomGen * rnd = RandomGen::Instance();
 
  unsigned int niter = 0;
  while(1) {
    if(niter > kRjMaxIterations) {
       LOG("SpectralFunc", pWARN) 
           << "Couldn't generate a hit nucleon after " << niter << " iterations";
       return false;
    }
    niter++;
 
    // random pair
    double kc = kmin + dk * rnd->RndGen().Rndm();
    double wc = wmin + dw * rnd->RndGen().Rndm();
    LOG("SpectralFunc", pINFO) << "Trying p = " << kc << ", w = " << wc;
 
    // accept/reject
    double prob  = this->Prob(kc,wc, target);
    double probg = probmax * rnd->RndGen().Rndm();
    bool accept = (probg < prob);
    if(!accept) continue;
 
    LOG("SpectralFunc", pINFO) << "|p,nucleon| = " << kc; 
    LOG("SpectralFunc", pINFO) << "|w,nucleon| = " << wc;
 
    // generate momentum components
    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 kx = kc*sintheta*cosfi;
    double ky = kc*sintheta*sinfi;
    double kz = kc*costheta;
 
    // set generated values
    fCurrRemovalEnergy = wc;
    fCurrMomentum.SetXYZ(kx,ky,kz);
 
    return true;
  }
  return false;
}

References genie::NuclearModelI::fCurrMomentum, genie::NuclearModelI::fCurrRemovalEnergy, genie::RandomGen::Instance(), genie::constants::kPi, genie::controls::kRjMaxIterations, LOG, pINFO, Prob(), pWARN, genie::RandomGen::RndGen(), and SelectSpectralFunction().

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 SpectralFunc::LoadConfig ( void )

protectedvirtual

Reimplemented from genie::NuclearModelI.

Definition at line 144 of file SpectralFunc.cxx.

{
 
  NuclearModelI::LoadConfig() ;
 
  LOG("SpectralFunc", pDEBUG) << "Loading Benhar et al. spectral functions";
 
  string data_dir =
        string(gSystem->Getenv("GENIE")) + 
        string("/data/evgen/nucl/spectral_functions/");
  string c12file  = data_dir + "benhar-sf-12c.data";
  string fe56file = data_dir + "benhar-sf-56fe.data";
 
  TNtupleD sfdata_fe56("sfdata_fe56","","k:e:prob");
  TNtupleD sfdata_c12 ("sfdata_c12", "","k:e:prob");
 
  sfdata_fe56.ReadFile ( fe56file.c_str() );
  sfdata_c12. ReadFile ( c12file.c_str () );
 
  LOG("SpectralFunc", pDEBUG) << "Loaded " << sfdata_fe56.GetEntries() << " Fe56 points";
  LOG("SpectralFunc", pDEBUG) << "Loaded " << sfdata_c12.GetEntries()  << " C12 points";
 
  if (fSfFe56) delete fSfFe56;
  if (fSfC12 ) delete fSfC12;
 
  fSfFe56 = this->Convert2Graph(sfdata_fe56);
  fSfC12  = this->Convert2Graph(sfdata_c12);
 
  fSfFe56->SetName("sf_fe56");
  fSfC12 ->SetName("sf_c12");
}

References Convert2Graph(), fSfC12, fSfFe56, genie::NuclearModelI::LoadConfig(), LOG, and pDEBUG.

Referenced by Configure(), and Configure().

ModelType()

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

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 44 of file SpectralFunc.h.

  {
    return kNucmSpectralFunc;
  }

References genie::kNucmSpectralFunc.

Prob() [1/2]

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

virtual

Implements genie::NuclearModelI.

Definition at line 123 of file SpectralFunc.cxx.

{
  TGraph2D * sf = this->SelectSpectralFunction(target);
  if(!sf) return 0;
 
  return sf->Interpolate(p,w);
}

References SelectSpectralFunction().

Referenced by GenerateNucleon().

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

SelectSpectralFunction()

TGraph2D * SpectralFunc::SelectSpectralFunction ( const Target & target ) const

private

Definition at line 196 of file SpectralFunc.cxx.

{
  TGraph2D * sf = 0;
  int pdgc = t.Pdg();
 
  if      (pdgc == kPdgTgtC12)  sf = fSfC12;
  else if (pdgc == kPdgTgtFe56) sf = fSfFe56;
  else {
    LOG("SpectralFunc", pERROR) 
     << "** The spectral function for target " << pdgc << " isn't available";
  }
  if(!sf) {
    LOG("SpectralFunc", pERROR) << "** Null spectral function";
  }
  return sf;
}

References fSfC12, fSfFe56, genie::kPdgTgtC12, genie::kPdgTgtFe56, LOG, genie::Target::Pdg(), and pERROR.

Referenced by GenerateNucleon(), and Prob().

Member Data Documentation

fSfC12

TGraph2D* genie::SpectralFunc::fSfC12

private

Benhar's C12 SF.

Definition at line 63 of file SpectralFunc.h.

Referenced by LoadConfig(), SelectSpectralFunction(), SpectralFunc(), and SpectralFunc().

fSfFe56

TGraph2D* genie::SpectralFunc::fSfFe56

private

Benhar's Fe56 SF.

Definition at line 62 of file SpectralFunc.h.

Referenced by LoadConfig(), SelectSpectralFunction(), SpectralFunc(), and SpectralFunc().

---

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

• SpectralFunc.h
• SpectralFunc.cxx