local Fermi gas model. Implements the NuclearModelI interface. More...

#include <LocalFGM.h>

Inheritance diagram for genie::LocalFGM:

Public Member Functions
	LocalFGM ()

	LocalFGM (string config)

virtual	~LocalFGM ()

bool	GenerateNucleon (const Target &t, double hitNucleonRadius) const

double	Prob (double p, double w, const Target &t, double hitNucleonRadius) const

bool	GenerateNucleon (const Target &t) const

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

NuclearModel_t	ModelType (const Target &) const

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

void	Configure (const Registry &config)

void	Configure (string param_set)

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

virtual double	FermiMomentum (const Target &, int nucleon_pdg) 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...

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

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

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

Private Attributes
map< int, double >	fNucRmvE

double	fPMax

double	fSRC_Fraction

double	fPCutOff

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)

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

local Fermi gas model. Implements the NuclearModelI interface.

Author: Joe Johnston, Steven Dytman

December 2015

Definition at line 34 of file LocalFGM.h.

Constructor & Destructor Documentation

LocalFGM::LocalFGM ( )

Definition at line 35 of file LocalFGM.cxx.

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

LocalFGM::LocalFGM ( string config )

Definition at line 41 of file LocalFGM.cxx.

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

LocalFGM::~LocalFGM ( )

virtual

Definition at line 47 of file LocalFGM.cxx.

 {
 
 }

Member Function Documentation

void LocalFGM::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 200 of file LocalFGM.cxx.

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

void LocalFGM::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 206 of file LocalFGM.cxx.

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

bool LocalFGM::GenerateNucleon	(	const Target &	t,
		double	hitNucleonRadius
	)		const

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 52 of file LocalFGM.cxx.

 {
   assert(target.HitNucIsSet());
 
   fCurrRemovalEnergy = 0;
   fCurrMomentum.SetXYZ(0,0,0);
 
   //-- set fermi momentum vector
   //
   TH1D * prob = this->ProbDistro(target,hitNucleonRadius);
   if(!prob) {
     LOG("LocalFGM", pNOTICE)
               << "Null nucleon momentum probability distribution";
     exit(1);
   }
   double p = prob->GetRandom();
   delete prob;
   LOG("LocalFGM", 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
   //
   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);
 
   return true;
 }

bool genie::LocalFGM::GenerateNucleon ( const Target & t ) const

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 50 of file LocalFGM.h.

                                                 {
     return GenerateNucleon(t,0.0);
   }

void LocalFGM::LoadConfig ( void )

protectedvirtual

Reimplemented from genie::NuclearModelI.

Definition at line 212 of file LocalFGM.cxx.

 {
 
   NuclearModelI::LoadConfig() ;
 
   this->GetParamDef("LFG-MomentumMax", fPMax, 1.0);
   assert(fPMax > 0);
 
   this->GetParamDef("SRC-Fraction", fSRC_Fraction, 0.0);
   this->GetParam("LFG-MomentumCutOff", fPCutOff);
 
   if (fPCutOff > fPMax) {
         LOG("LocalFGM", pFATAL) << "Momentum CutOff greater than Momentum Max";
         exit(78);
   }
 
 
   // 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("LocalFGM", pINFO) << "Nucleus: " << pdgc << " -> using Eb =  " << eb << " GeV";
         fNucRmvE.insert(map<int,double>::value_type(Z,eb));
       }
     }
   }
 }

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

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 184 of file LocalFGM.cxx.

                                                                                             {
 
   assert(pdg::IsProton(nucleon_pdg) || pdg::IsNeutron(nucleon_pdg)) ;
 
   bool is_p = pdg::IsProton(nucleon_pdg);
   double numNuc = (double) ( (is_p) ? t.Z() : t.N() );
 
   //  double hbarc = kLightSpeed*kPlankConstant/genie::units::fermi;
   
   double kF = TMath::Power( 3*kPi2*numNuc*genie::utils::nuclear::Density( radius, t.A() ),
                            1.0/3.0 ) 
     / genie::units::fermi ;
 
   return kF ;
 }

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

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 56 of file LocalFGM.h.

   { 
     return kNucmLocalFermiGas; 
   }

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

virtual

Reimplemented from genie::NuclearModelI.

Definition at line 96 of file LocalFGM.cxx.

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

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

inlinevirtual

Implements genie::NuclearModelI.

Definition at line 53 of file LocalFGM.h.

                                                            {
     return Prob(p,w,t,0.0);
   }

TH1D * LocalFGM::ProbDistro	(	const Target &	t,
		double	r
	)		const

private

Definition at line 112 of file LocalFGM.cxx.

 {
   LOG("LocalFGM", pNOTICE)
              << "Computing P = f(p_nucleon) for: " << target.AsString()
              << ", Nucleon Radius = " << r;
   LOG("LocalFGM", pNOTICE)
              << ", P(max) = " << fPMax;
 
   assert(target.HitNucIsSet());
 
   //-- get information for the nuclear target
   int nucleon_pdgc = target.HitNucPdg();
   assert(pdg::IsProton(nucleon_pdgc) || pdg::IsNeutron(nucleon_pdgc));
 
   // bool is_p = pdg::IsProton(nucleon_pdgc);
   // double numNuc = (is_p) ? (double)target.Z():(double)target.N();
 
   // Calculate Fermi Momentum using Local FG equations
   double KF = LocalFermiMomentum( target, nucleon_pdgc, r ) ; 
 
   LOG("LocalFGM",pNOTICE) << "KF = " << KF;
 
   double a  = 2.0;
   double C  = 4. * kPi * TMath::Power(KF,3) / 3.;
 
   // Do not include nucleon correlation tail
   //double R  = 1. / (1.- KF/4.);
 #ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
   LOG("LocalFGM", pDEBUG) << "a  = " << a;
   LOG("LocalFGM", pDEBUG) << "C  = " << C;
   //LOG("LocalFGM", 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.; // unused variables
 //  double kfa_pi_2 = TMath::Power(KF*a/kPi,2); // unused variables
 
   for(int i = 0; i < npbins; i++) {
      double p  = i * dp;
      double p2 = TMath::Power(p,2);
 
      // use expression with fSRC_Fraction to allow the possibility of 
      // using the Correlated Fermi Gas Model with a high momentum tail
 
      // calculate |phi(p)|^2
      double phi2 = 0;
         if (p <= KF){
             phi2 = (1./(4*kPi)) * (3/TMath::Power(KF,3.)) * ( 1 - fSRC_Fraction );
         }else if( p > KF && p < fPCutOff ){
             phi2 = (1./(4*kPi)) * ( fSRC_Fraction / (1./KF - 1./fPCutOff) ) / TMath::Power(p,4.);
         }
 
      // calculate probability density : dProbability/dp
      double dP_dp = 4*kPi * p2 * phi2;
 #ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
      LOG("LocalFGM", pDEBUG) << "p = " << p << ", dP/dp = " << dP_dp;
 #endif
      prob->Fill(p, dP_dp);
   }
 
   //-- normalize the probability distribution
   prob->Scale( 1.0 / prob->Integral("width") );
 
   return prob;
 }

Member Data Documentation

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

private

Definition at line 75 of file LocalFGM.h.

double genie::LocalFGM::fPCutOff

private

Definition at line 81 of file LocalFGM.h.

double genie::LocalFGM::fPMax

private

Definition at line 77 of file LocalFGM.h.

double genie::LocalFGM::fSRC_Fraction

private

Definition at line 80 of file LocalFGM.h.

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

Generator/src/Physics/NuclearState/LocalFGM.h
Generator/src/Physics/NuclearState/LocalFGM.cxx

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation