genie::HEDISXSec Class Reference

Computes the HEDIS Cross Section.
Is a concrete implementation of the XSecIntegratorI interface.
. More...

#include <HEDISXSec.h>

Inheritance diagram for genie::HEDISXSec:

Collaboration diagram for genie::HEDISXSec:

Public Member Functions
	HEDISXSec ()
	HEDISXSec (string config)
virtual	~HEDISXSec ()
double	Integrate (const XSecAlgorithmI *model, const Interaction *i) const
	XSecIntegratorI interface implementation.
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::XSecIntegratorI
virtual	~XSecIntegratorI ()
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.

Private Member Functions
void	LoadConfig (void)

Private Attributes
double	fSFXmin
	minimum value of x for which SF tables are computed
double	fSFQ2min
	minimum value of Q2 for which SF tables are computed
double	fSFQ2max
	maximum value of Q2 for which SF tables are computed

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::XSecIntegratorI
	XSecIntegratorI ()
	XSecIntegratorI (string name)
	XSecIntegratorI (string name, string config)
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.
Protected Attributes inherited from genie::XSecIntegratorI
const IntegratorI *	fIntegrator
	GENIE numerical integrator.
string	fGSLIntgType
	name of GSL numerical integrator
double	fGSLRelTol
	required relative tolerance (error)
int	fGSLMaxEval
	GSL max evaluations.
int	fGSLMinEval
	GSL min evaluations. Ignored by some integrators.
unsigned int	fGSLMaxSizeOfSubintervals
	GSL maximum number of sub-intervals for 1D integrator.
unsigned int	fGSLRule
	GSL Gauss-Kronrod integration rule (only for GSL 1D adaptive type)
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

Computes the HEDIS Cross Section.
Is a concrete implementation of the XSecIntegratorI interface.
.

Author

Alfonso Garcia <alfonsog \at nikhef.nl> NIKHEF

Created:\n August 28, 2019

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org or see $GENIE/LICENSE

Definition at line 29 of file HEDISXSec.h.

Constructor & Destructor Documentation

HEDISXSec() [1/2]

HEDISXSec::HEDISXSec

(

)

Definition at line 37 of file HEDISXSec.cxx.

                     :
XSecIntegratorI("genie::HEDISXSec")
{
 
}

References genie::XSecIntegratorI::XSecIntegratorI().

HEDISXSec() [2/2]

HEDISXSec::HEDISXSec

(

string

config

)

Definition at line 43 of file HEDISXSec.cxx.

                                  :
XSecIntegratorI("genie::HEDISXSec", config)
{
 
}

References genie::XSecIntegratorI::XSecIntegratorI().

~HEDISXSec()

HEDISXSec::~HEDISXSec ( )

virtual

Definition at line 49 of file HEDISXSec.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void HEDISXSec::Configure ( const Registry & config )

virtual

Overload the Algorithm::Configure() methods to load private data members from configuration options

Reimplemented from genie::Algorithm.

Definition at line 146 of file HEDISXSec.cxx.

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

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

Configure() [2/2]

void HEDISXSec::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 152 of file HEDISXSec.cxx.

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

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

Integrate()

double HEDISXSec::Integrate ( const XSecAlgorithmI * model, const Interaction * i ) const

virtual

XSecIntegratorI interface implementation.

Implements genie::XSecIntegratorI.

Definition at line 54 of file HEDISXSec.cxx.

{
 
  if(! model->ValidProcess(in) ) return 0.;
 
  const KPhaseSpace & kps = in->PhaseSpace();
  if(!kps.IsAboveThreshold()) {
     LOG("DISXSec", pDEBUG)  << "*** Below energy threshold";
     return 0;
  }
 
  const InitialState & init_state = in->InitState();
  double Ev = init_state.ProbeE(kRfLab);
 
  // If the input interaction is off a nuclear target, then chek whether 
  // the corresponding free nucleon cross section already exists at the 
  // cross section spline list. 
  // If yes, calculate the nuclear cross section based on that value.
  //
  XSecSplineList * xsl = XSecSplineList::Instance();
  if(init_state.Tgt().IsNucleus() && !xsl->IsEmpty() ) {
 
    int nucpdgc = init_state.Tgt().HitNucPdg();
    int NNucl   = (pdg::IsProton(nucpdgc)) ? init_state.Tgt().Z() : init_state.Tgt().N();
 
    Interaction * interaction = new Interaction(*in);
    Target * target = interaction->InitStatePtr()->TgtPtr();
    if(pdg::IsProton(nucpdgc)) { target->SetId(kPdgTgtFreeP); }
    else                       { target->SetId(kPdgTgtFreeN); }
    if(xsl->SplineExists(model,interaction)) {
      const Spline * spl = xsl->GetSpline(model, interaction);
      double xsec = spl->Evaluate(Ev);
      LOG("HEDISXSec", pINFO) << "From XSecSplineList: XSec[HEDIS,free nucleon] (E = " << Ev << " GeV) = " << xsec;
      if( !interaction->TestBit(kIAssumeFreeNucleon) ) { 
          xsec *= NNucl; 
          LOG("HEDISXSec", pINFO)  << "XSec[HEDIS] (E = " << Ev << " GeV) = " << xsec;
      }
      delete interaction;
      return xsec;
    }
    delete interaction;
  }
 
  LOG("HEDISXSec", pINFO)  << in->AsString();
 
  Range1D_t xl  = kps.XLim();
  Range1D_t Q2l = kps.Q2Lim();
  LOG("HEDISXSec", pDEBUG) << "X only kinematic range = [" << xl.min << ", " << xl.max << "]";
  LOG("HEDISXSec", pDEBUG) << "Q2 only kinematic range = [" << Q2l.min << ", " << Q2l.max << "]";
 
  if (xl.min < fSFXmin)  xl.min=fSFXmin;
  if (Q2l.min < fSFQ2min) Q2l.min=fSFQ2min;
  if (Q2l.max > fSFQ2max) Q2l.max=fSFQ2max;
 
  LOG("HEDISXSec", pDEBUG) << "X kinematic+PDF range = [" << xl.min << ", " << xl.max << "]";
  LOG("HEDISXSec", pDEBUG) << "Q2 kinematic+PDF range = [" << Q2l.min << ", " << Q2l.max << "]";
 
 
  bool phsp_ok = 
      (Q2l.min >= 0. && Q2l.max >= 0. && Q2l.max >= Q2l.min &&
        xl.min >= 0. &&  xl.max <= 1. &&  xl.max >=  xl.min);
 
  if (!phsp_ok) return 0.;
 
 
  // Just go ahead and integrate the input differential cross section for the 
  // specified interaction.
  //
  double xsec = 0.;
 
  Interaction * interaction = new Interaction(*in);
  
  // If a GSL option has been chosen, then the total xsec is recomptued
  ROOT::Math::IBaseFunctionMultiDim * func = new utils::gsl::d2XSec_dlog10xdlog10Q2_E(model, interaction);
  ROOT::Math::IntegrationMultiDim::Type ig_type = utils::gsl::IntegrationNDimTypeFromString(fGSLIntgType);
  double abstol = 0; //In vegas we care about number of interactions
  double reltol = 0; //In vegas we care about number of interactions
  ROOT::Math::IntegratorMultiDim ig(*func, ig_type, abstol, reltol, fGSLMaxEval);
  double kine_min[2] = { TMath::Log10(xl.min), TMath::Log10(Q2l.min) };
  double kine_max[2] = {TMath::Log10(xl.max), TMath::Log10(Q2l.max) };
  xsec = ig.Integral(kine_min, kine_max) * (1E-38 * units::cm2);
  delete func;
 
  delete interaction;
 
  LOG("HEDISXSec", pINFO)  << "XSec[HEDIS] (E = " << Ev << " GeV) = " << xsec * (1E+38/units::cm2) << " x 1E-38 cm^2";
 
  return xsec;
 
}

References genie::Interaction::AsString(), genie::units::cm2, genie::Spline::Evaluate(), genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, fSFQ2max, fSFQ2min, fSFXmin, func(), genie::XSecSplineList::GetSpline(), genie::Target::HitNucPdg(), genie::Interaction::InitState(), genie::Interaction::InitStatePtr(), genie::XSecSplineList::Instance(), genie::utils::gsl::IntegrationNDimTypeFromString(), genie::KPhaseSpace::IsAboveThreshold(), genie::XSecSplineList::IsEmpty(), genie::Target::IsNucleus(), genie::pdg::IsProton(), genie::kIAssumeFreeNucleon, genie::kPdgTgtFreeN, genie::kPdgTgtFreeP, genie::kRfLab, LOG, genie::Range1D_t::max, genie::Range1D_t::min, genie::Target::N(), pDEBUG, genie::Interaction::PhaseSpace(), pINFO, genie::InitialState::ProbeE(), genie::KPhaseSpace::Q2Lim(), genie::Target::SetId(), genie::XSecSplineList::SplineExists(), genie::InitialState::Tgt(), genie::InitialState::TgtPtr(), genie::XSecAlgorithmI::ValidProcess(), genie::KPhaseSpace::XLim(), and genie::Target::Z().

LoadConfig()

void HEDISXSec::LoadConfig ( void )

private

Definition at line 158 of file HEDISXSec.cxx.

{
 
  // Get GSL integration type & relative tolerance
  GetParamDef( "gsl-integration-type", fGSLIntgType, string("vegas") ) ;
 
  int max_eval ;
  GetParamDef( "gsl-max-eval", max_eval, 500000 ) ;
  fGSLMaxEval  = (unsigned int) max_eval ;
 
  // Limits from the SF tables that are useful to reduce computation 
  // time of the total cross section
  GetParam("XGrid-Min",  fSFXmin ) ;
  GetParam("Q2Grid-Min", fSFQ2min ) ;
  GetParam("Q2Grid-Max", fSFQ2max ) ;
 
}

References genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, fSFQ2max, fSFQ2min, fSFXmin, genie::Algorithm::GetParam(), and genie::Algorithm::GetParamDef().

Referenced by Configure(), and Configure().

Member Data Documentation

fSFQ2max

double genie::HEDISXSec::fSFQ2max

private

maximum value of Q2 for which SF tables are computed

Definition at line 49 of file HEDISXSec.h.

Referenced by Integrate(), and LoadConfig().

fSFQ2min

double genie::HEDISXSec::fSFQ2min

private

minimum value of Q2 for which SF tables are computed

Definition at line 48 of file HEDISXSec.h.

Referenced by Integrate(), and LoadConfig().

fSFXmin

double genie::HEDISXSec::fSFXmin

private

minimum value of x for which SF tables are computed

Definition at line 47 of file HEDISXSec.h.

Referenced by Integrate(), and LoadConfig().

---

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

• HEDISXSec.h
• HEDISXSec.cxx