An effective spectral function to match psi' superscaling. Implements the NuclearModelI interface. More...

#include <EffectiveSF.h>

Inheritance diagram for genie::EffectiveSF:

Collaboration diagram for genie::EffectiveSF:

Public Member Functions
	EffectiveSF ()

	EffectiveSF (string config)

virtual	~EffectiveSF ()

bool	GenerateNucleon (const Target &t) const

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

NuclearModel_t	ModelType (const Target &) const

void	Configure (const Registry &config)

void	Configure (string param_set)

Public Member Functions inherited from genie::NuclearModelI
virtual	~NuclearModelI ()

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

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

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

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

TH1D *	MakeEffectiveSF (const Target &target) const

TH1D *	MakeEffectiveSF (double bs, double bp, double alpha, double beta, double c1, double c2, double c3, const Target &target) const

double	ReturnBindingEnergy (const Target &target) const

double	GetTransEnh1p1hMod (const Target &target) const

double	Returnf1p1h (const Target &target) const

void	LoadConfig (void)

Private Attributes
map< string, TH1D * >	fProbDistroMap

double	fPMax

double	fPCutOff

bool	fEjectSecondNucleon2p2h

bool	fUseElFFTransEnh

map< int, double >	fNucRmvE

map< int, double >	f1p1hMap

map< int, std::vector< double > >	fProbDistParams

map< int, double >	fTransEnh1p1hMods

map< pair< int, int >, double >	fRangeNucRmvE

map< pair< int, int >, double >	fRange1p1hMap

map< pair< int, int > , std::vector< double > >	fRangeProbDistParams

map< pair< int, int >, double >	fRangeTransEnh1p1hMods

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

An effective spectral function to match psi' superscaling. Implements the NuclearModelI interface.

References:: http://arxiv.org/abs/1405.0583

Author: Brian Coopersmith, University of Rochester

Created:: April 02, 2014

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

Definition at line 34 of file EffectiveSF.h.

Constructor & Destructor Documentation

EffectiveSF::EffectiveSF ( )

Definition at line 38 of file EffectiveSF.cxx.

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

EffectiveSF::EffectiveSF ( string config )

Definition at line 44 of file EffectiveSF.cxx.

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

EffectiveSF::~EffectiveSF ( )

virtual

Definition at line 52 of file EffectiveSF.cxx.

References fProbDistroMap.

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

Member Function Documentation

void EffectiveSF::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 271 of file EffectiveSF.cxx.

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

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

void EffectiveSF::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 277 of file EffectiveSF.cxx.

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

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

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

virtual

Implements genie::NuclearModelI.

Definition at line 67 of file EffectiveSF.cxx.

References genie::Target::A(), genie::NuclearModelI::fCurrMomentum, genie::NuclearModelI::fCurrRemovalEnergy, fEjectSecondNucleon2p2h, genie::NuclearModelI::fFermiMoverInteractionType, GetTransEnh1p1hMod(), genie::Target::HitNucIsSet(), genie::RandomGen::Instance(), genie::kFermiMoveEffectiveSF1p1h, genie::kFermiMoveEffectiveSF2p2h_eject, genie::kFermiMoveEffectiveSF2p2h_noeject, genie::constants::kPi, LOG, pDEBUG, pNOTICE, ProbDistro(), ReturnBindingEnergy(), Returnf1p1h(), and genie::RandomGen::RndGen().

 {
   assert(target.HitNucIsSet());
   fCurrRemovalEnergy = 0;
   fCurrMomentum.SetXYZ(0,0,0);
 
   //-- set fermi momentum vector
   //
 
   if ( target.A() > 1 ) {
     TH1D * prob = this->ProbDistro(target);
     if(!prob) {
       LOG("EffectiveSF", pNOTICE)
               << "Null nucleon momentum probability distribution";
       exit(1);
     }
 
     double p = prob->GetRandom();
 
 #ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
     LOG("EffectiveSF", pDEBUG) << "|p,nucleon| = " << p;
 #endif
 
     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
   //
 
   fCurrRemovalEnergy = this->ReturnBindingEnergy(target);
   double f1p1h = this->Returnf1p1h(target);
   // Since TE increases the QE peak via a 2p2h process, we decrease f1p1h
   // in order to increase the 2p2h interaction to account for this enhancement.
   f1p1h /= this->GetTransEnh1p1hMod(target);
   if ( RandomGen::Instance() -> RndGen().Rndm() < f1p1h) {
     fFermiMoverInteractionType = kFermiMoveEffectiveSF1p1h;
   } else if (fEjectSecondNucleon2p2h) {
     fFermiMoverInteractionType = kFermiMoveEffectiveSF2p2h_eject;
   } else {
     fFermiMoverInteractionType = kFermiMoveEffectiveSF2p2h_noeject;
   }
 
   return true;
 }

double EffectiveSF::GetTransEnh1p1hMod ( const Target & target ) const

private

Definition at line 167 of file EffectiveSF.cxx.

References fRangeTransEnh1p1hMods, fTransEnh1p1hMods, and genie::utils::config::GetValueFromNuclearMaps().

Referenced by GenerateNucleon().

                                                                  {
   double transEnhMod;
         if(GetValueFromNuclearMaps(target, fTransEnh1p1hMods,
                                    fRangeTransEnh1p1hMods, &transEnhMod) &&
            transEnhMod > 0) {
           return transEnhMod;
         }
   // If none specified, assume no enhancement to quasielastic peak
   return 1.0;
 }

void EffectiveSF::LoadConfig ( void )

privatevirtual

Reimplemented from genie::NuclearModelI.

Definition at line 285 of file EffectiveSF.cxx.

References genie::units::A, f1p1hMap, fEjectSecondNucleon2p2h, fNucRmvE, fPCutOff, fPMax, fProbDistParams, fRange1p1hMap, fRangeNucRmvE, fRangeProbDistParams, fRangeTransEnh1p1hMods, fTransEnh1p1hMods, fUseElFFTransEnh, genie::utils::config::GetDoubleKeyPDG(), genie::utils::config::GetDoubleKeyRangeNucA(), genie::Algorithm::GetOwnedConfig(), genie::Algorithm::GetParam(), genie::Algorithm::GetParamDef(), genie::pdg::IonPdgCode(), genie::utils::config::LoadAllIsotopesForKey(), genie::utils::config::LoadAllNucARangesForKey(), genie::NuclearModelI::LoadConfig(), LOG, and pINFO.

Referenced by Configure().

 {
 
   NuclearModelI::LoadConfig() ; 
 
   this->GetParamDef("EjectSecondNucleon2p2h", fEjectSecondNucleon2p2h, false);
 
   this->GetParamDef("MomentumMax",    fPMax,    1.0);
   this->GetParamDef("MomentumCutOff", fPCutOff, 0.65);
   assert(fPMax > 0 && fPCutOff > 0 && fPCutOff <= fPMax);
 
   // Find out if Transverse enhancement is enabled to figure out whether to load
   // the 2p2h enhancement parameters.
   this->GetParam("UseElFFTransverseEnhancement", fUseElFFTransEnh );
   if (!fUseElFFTransEnh) {
     LOG("EffectiveSF", pINFO)
         << "Transverse enhancement not used; "
         << "Do not increase the 2p2h cross section.";
   }
   else {
     LoadAllIsotopesForKey("TransEnhf1p1hMod", "EffectiveSF",
                           GetOwnedConfig(), &fTransEnh1p1hMods);
     LoadAllNucARangesForKey("TransEnhf1p1hMod", "EffectiveSF",
                             GetOwnedConfig(), &fRangeTransEnh1p1hMods);
   }
 
   LoadAllIsotopesForKey("BindingEnergy", "EffectiveSF", GetOwnedConfig(), &fNucRmvE);
   LoadAllNucARangesForKey("BindingEnergy", "EffectiveSF",
                           GetOwnedConfig(), &fRangeNucRmvE);
   LoadAllIsotopesForKey("f1p1h", "EffectiveSF", GetOwnedConfig(), &f1p1hMap);
   LoadAllNucARangesForKey("f1p1h", "EffectiveSF", GetOwnedConfig(), &fRange1p1hMap);
 
   for (int Z = 1; Z < 140; Z++) {
     for (int A = Z; A < 3*Z; A++) {
       const int pdgc = pdg::IonPdgCode(A, Z);
       double bs, bp, alpha, beta, c1, c2, c3;
       if (GetDoubleKeyPDG("bs", pdgc, GetOwnedConfig(), &bs) &&
           GetDoubleKeyPDG("bp", pdgc, GetOwnedConfig(), &bp) &&
           GetDoubleKeyPDG("alpha", pdgc, GetOwnedConfig(), &alpha) &&
           GetDoubleKeyPDG("beta", pdgc, GetOwnedConfig(), &beta) &&
           GetDoubleKeyPDG("c1", pdgc, GetOwnedConfig(), &c1) &&
           GetDoubleKeyPDG("c2", pdgc, GetOwnedConfig(), &c2) &&
           GetDoubleKeyPDG("c3", pdgc, GetOwnedConfig(), &c3)) {
         vector<double> pars = vector<double>();
         pars.push_back(bs);
         pars.push_back(bp);
         pars.push_back(alpha);
         pars.push_back(beta);
         pars.push_back(c1);
         pars.push_back(c2);
         pars.push_back(c3);
         LOG("EffectiveSF", pINFO)
           << "Nucleus: " << pdgc << " -> using bs =  " << bs << "; bp = "<< bp
           << "; alpha = " << alpha << "; beta = "<<beta<<"; c1 = "<<c1
           <<"; c2 = "<<c2<< "; c3 = " << c3;
         fProbDistParams[pdgc] = pars;
       }
     }
   }
   for(int lowA = 1; lowA < 3 * 140; lowA++) {
     for(int highA = lowA; highA < 3 * 140; highA++) {
       double bs, bp, alpha, beta, c1, c2, c3;
       if (GetDoubleKeyRangeNucA("bs",   lowA, highA, GetOwnedConfig(), &bs)    &&
           GetDoubleKeyRangeNucA("bp",   lowA, highA, GetOwnedConfig(), &bp)    &&
           GetDoubleKeyRangeNucA("alpha",lowA, highA, GetOwnedConfig(), &alpha) &&
           GetDoubleKeyRangeNucA("beta", lowA, highA, GetOwnedConfig(), &beta) &&
           GetDoubleKeyRangeNucA("c1",   lowA, highA, GetOwnedConfig(), &c1) &&
           GetDoubleKeyRangeNucA("c2",   lowA, highA, GetOwnedConfig(), &c2) &&
           GetDoubleKeyRangeNucA("c3",   lowA, highA, GetOwnedConfig(), &c3)) {
         vector<double> pars = vector<double>();
         pars.push_back(bs);
         pars.push_back(bp);
         pars.push_back(alpha);
         pars.push_back(beta);
         pars.push_back(c1);
         pars.push_back(c2);
         pars.push_back(c3);
         LOG("EffectiveSF", pINFO) << "For "<< lowA - 1 <<" < A < " << highA + 1
           <<" -> using bs =  " << bs << "; bp = "<< bp
           << "; alpha = " << alpha << "; beta = "<<beta<<"; c1 = "<<c1
           <<"; c2 = "<<c2<< "; c3 = " << c3;
         fRangeProbDistParams[pair<int, int>(lowA, highA)] = pars;
       }
     }
   }
 }

TH1D * EffectiveSF::MakeEffectiveSF ( const Target & target ) const

private

Definition at line 181 of file EffectiveSF.cxx.

References genie::Target::A(), fProbDistParams, fRangeProbDistParams, genie::pdg::IonPdgCode(), and genie::Target::Z().

Referenced by ProbDistro().

 {
   // First check for individually specified nuclei
   int pdgc  = pdg::IonPdgCode(target.A(), target.Z());
   map<int,vector<double> >::const_iterator it = fProbDistParams.find(pdgc);
   if(it != fProbDistParams.end()) {
     vector<double> v = it->second;
     return this->MakeEffectiveSF(v[0], v[1], v[2], v[3],
                                  v[4], v[5], v[6], target);
   }
 
   // Then check in the ranges of A
   map<pair<int, int>, vector<double> >::const_iterator range_it = fRangeProbDistParams.begin();
   for(; range_it != fRangeProbDistParams.end(); ++range_it) {
     if (target.A() >= range_it->first.first && target.A() <= range_it->first.second) {
       vector<double> v = range_it->second;
       return this->MakeEffectiveSF(v[0], v[1], v[2], v[3],
                                    v[4], v[5], v[6], target);
     }
   }
 
   return NULL;
 }

TH1D * EffectiveSF::MakeEffectiveSF	(	double	bs,
		double	bp,
		double	alpha,
		double	beta,
		double	c1,
		double	c2,
		double	c3,
		const Target &	target
	)		const

private

Definition at line 208 of file EffectiveSF.cxx.

References genie::units::as, genie::Target::AsString(), fPCutOff, fPMax, fProbDistroMap, LOG, and pDEBUG.

 {
   //-- create the probability distribution
   int npbins = (int) (1000 * fPMax);
 
   TH1D * prob = new TH1D("", "", npbins, 0, fPMax);
   prob->SetDirectory(0);
 
   double dp = fPMax / (npbins-1);
   for(int i = 0; i < npbins; i++) {
     double p  = i * dp;
     double y = p / 0.197;
     double as = c1 * exp(-pow(bs*y,2));
     double ap = c2 * pow(bp * y, 2) * exp(-pow(bp * y, 2));
     double at = c3 * pow(y, beta) * exp(-alpha * (y - 2));
     double rr = (3.14159265 / 4) * (as + ap + at) * pow(y, 2) / 0.197;
     double dP_dp = rr / 1.01691371;
     if(p>fPCutOff)
       dP_dp = 0;
     assert(dP_dp >= 0);
     // calculate probability density : dProbability/dp
 #ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
     LOG("EffectiveSF", 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;
 }

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

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 47 of file EffectiveSF.h.

References genie::kNucmEffSpectralFunc.

   {
     return kNucmEffSpectralFunc;
   }

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

virtual

Implements genie::NuclearModelI.

Definition at line 129 of file EffectiveSF.cxx.

References ProbDistro().

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

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

private

Definition at line 145 of file EffectiveSF.cxx.

References genie::Target::AsString(), fPCutOff, fPMax, fProbDistroMap, genie::Target::HitNucPdg(), genie::pdg::IsNeutron(), genie::pdg::IsProton(), LOG, MakeEffectiveSF(), and pNOTICE.

Referenced by GenerateNucleon(), and Prob().

 {
   //-- return stored /if already computed/
   map<string, TH1D*>::iterator it = fProbDistroMap.find(target.AsString());
   if(it != fProbDistroMap.end()) return it->second;
 
   LOG("EffectiveSF", pNOTICE)
              << "Computing P = f(p_nucleon) for: " << target.AsString();
   LOG("EffectiveSF", pNOTICE)
                << "P(cut-off) = " << fPCutOff << ", P(max) = " << fPMax;
 
   //-- get information for the nuclear target
   int nucleon_pdgc = target.HitNucPdg();
   assert( pdg::IsProton(nucleon_pdgc) || pdg::IsNeutron(nucleon_pdgc) );
   return this->MakeEffectiveSF(target);
 
 }

double EffectiveSF::ReturnBindingEnergy ( const Target & target ) const

private

Definition at line 248 of file EffectiveSF.cxx.

References fNucRmvE, fRangeNucRmvE, and genie::utils::config::GetValueFromNuclearMaps().

Referenced by GenerateNucleon().

 {
   double binding_en;
   if (GetValueFromNuclearMaps(target, fNucRmvE, fRangeNucRmvE, &binding_en) &&
       binding_en > 0) {
     return binding_en;
   }
   return 0;
 }

double EffectiveSF::Returnf1p1h ( const Target & target ) const

private

Definition at line 261 of file EffectiveSF.cxx.

References f1p1hMap, fRange1p1hMap, and genie::utils::config::GetValueFromNuclearMaps().

Referenced by GenerateNucleon().

 {
   double f1p1h;
   if (GetValueFromNuclearMaps(target, f1p1hMap, fRange1p1hMap, &f1p1h) &&
       f1p1h >= 0 && f1p1h <= 1) {
     return f1p1h;
   }
   return 1;
 }