GENIEGenerator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for genie::HEDISXSec:
Collaboration graph
[legend]

Public Member Functions

 HEDISXSec ()
 
 HEDISXSec (string config)
 
virtual ~HEDISXSec ()
 
double Integrate (const XSecAlgorithmI *model, const Interaction *i) const
 XSecIntegratorI interface implementation. More...
 
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 RegistryGetConfig (void) const
 
RegistryGetOwnedConfig (void)
 
virtual const AlgIdId (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 AlgorithmSubAlg (const RgKey &registry_key) const
 
void AdoptConfig (void)
 
void AdoptSubstructure (void)
 
virtual void Print (ostream &stream) const
 Print algorithm info. More...
 

Private Member Functions

void LoadConfig (void)
 

Private Attributes

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

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)
 
RegistryExtractLocalConfig (const Registry &in) const
 
RegistryExtractLowerConfig (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::XSecIntegratorI
const IntegratorI * fIntegrator
 GENIE numerical integrator. More...
 
string fGSLIntgType
 name of GSL numerical integrator More...
 
double fGSLRelTol
 required relative tolerance (error) More...
 
int fGSLMaxEval
 GSL max evaluations. More...
 
int fGSLMinEval
 GSL min evaluations. Ignored by some integrators. More...
 
unsigned int fGSLMaxSizeOfSubintervals
 GSL maximum number of sub-intervals for 1D integrator. More...
 
unsigned int fGSLRule
 GSL Gauss-Kronrod integration rule (only for GSL 1D adaptive type) More...
 
- 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...
 
AlgMapfOwnedSubAlgMp
 local pool for owned sub-algs (taken out of the factory pool) More...
 

Detailed Description

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

Author
Alfonso Garcia <alfonsog nikhef.nl> NIKHEF
Created:
August 28, 2019
License:
Copyright (c) 2003-2024, 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::HEDISXSec ( )

Definition at line 37 of file HEDISXSec.cxx.

37  :
38 XSecIntegratorI("genie::HEDISXSec")
39 {
40 
41 }
HEDISXSec::HEDISXSec ( string  config)

Definition at line 43 of file HEDISXSec.cxx.

43  :
44 XSecIntegratorI("genie::HEDISXSec", config)
45 {
46 
47 }
HEDISXSec::~HEDISXSec ( )
virtual

Definition at line 49 of file HEDISXSec.cxx.

50 {
51 
52 }

Member Function Documentation

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.

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

147 {
148  Algorithm::Configure(config);
149  this->LoadConfig();
150 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void LoadConfig(void)
Definition: HEDISXSec.cxx:158
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.

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

153 {
154  Algorithm::Configure(config);
155  this->LoadConfig();
156 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void LoadConfig(void)
Definition: HEDISXSec.cxx:158
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.

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

56 {
57 
58  if(! model->ValidProcess(in) ) return 0.;
59 
60  const KPhaseSpace & kps = in->PhaseSpace();
61  if(!kps.IsAboveThreshold()) {
62  LOG("DISXSec", pDEBUG) << "*** Below energy threshold";
63  return 0;
64  }
65 
66  const InitialState & init_state = in->InitState();
67  double Ev = init_state.ProbeE(kRfLab);
68 
69  // If the input interaction is off a nuclear target, then chek whether
70  // the corresponding free nucleon cross section already exists at the
71  // cross section spline list.
72  // If yes, calculate the nuclear cross section based on that value.
73  //
75  if(init_state.Tgt().IsNucleus() && !xsl->IsEmpty() ) {
76 
77  int nucpdgc = init_state.Tgt().HitNucPdg();
78  int NNucl = (pdg::IsProton(nucpdgc)) ? init_state.Tgt().Z() : init_state.Tgt().N();
79 
80  Interaction * interaction = new Interaction(*in);
81  Target * target = interaction->InitStatePtr()->TgtPtr();
82  if(pdg::IsProton(nucpdgc)) { target->SetId(kPdgTgtFreeP); }
83  else { target->SetId(kPdgTgtFreeN); }
84  if(xsl->SplineExists(model,interaction)) {
85  const Spline * spl = xsl->GetSpline(model, interaction);
86  double xsec = spl->Evaluate(Ev);
87  LOG("HEDISXSec", pINFO) << "From XSecSplineList: XSec[HEDIS,free nucleon] (E = " << Ev << " GeV) = " << xsec;
88  if( !interaction->TestBit(kIAssumeFreeNucleon) ) {
89  xsec *= NNucl;
90  LOG("HEDISXSec", pINFO) << "XSec[HEDIS] (E = " << Ev << " GeV) = " << xsec;
91  }
92  delete interaction;
93  return xsec;
94  }
95  delete interaction;
96  }
97 
98  LOG("HEDISXSec", pINFO) << in->AsString();
99 
100  Range1D_t xl = kps.XLim();
101  Range1D_t Q2l = kps.Q2Lim();
102  LOG("HEDISXSec", pDEBUG) << "X only kinematic range = [" << xl.min << ", " << xl.max << "]";
103  LOG("HEDISXSec", pDEBUG) << "Q2 only kinematic range = [" << Q2l.min << ", " << Q2l.max << "]";
104 
105  if (xl.min < fSFXmin) xl.min=fSFXmin;
106  if (Q2l.min < fSFQ2min) Q2l.min=fSFQ2min;
107  if (Q2l.max > fSFQ2max) Q2l.max=fSFQ2max;
108 
109  LOG("HEDISXSec", pDEBUG) << "X kinematic+PDF range = [" << xl.min << ", " << xl.max << "]";
110  LOG("HEDISXSec", pDEBUG) << "Q2 kinematic+PDF range = [" << Q2l.min << ", " << Q2l.max << "]";
111 
112 
113  bool phsp_ok =
114  (Q2l.min >= 0. && Q2l.max >= 0. && Q2l.max >= Q2l.min &&
115  xl.min >= 0. && xl.max <= 1. && xl.max >= xl.min);
116 
117  if (!phsp_ok) return 0.;
118 
119 
120  // Just go ahead and integrate the input differential cross section for the
121  // specified interaction.
122  //
123  double xsec = 0.;
124 
125  Interaction * interaction = new Interaction(*in);
126 
127  // If a GSL option has been chosen, then the total xsec is recomptued
128  ROOT::Math::IBaseFunctionMultiDim * func = new utils::gsl::d2XSec_dlog10xdlog10Q2_E(model, interaction);
129  ROOT::Math::IntegrationMultiDim::Type ig_type = utils::gsl::IntegrationNDimTypeFromString(fGSLIntgType);
130  double abstol = 0; //In vegas we care about number of interactions
131  double reltol = 0; //In vegas we care about number of interactions
132  ROOT::Math::IntegratorMultiDim ig(*func, ig_type, abstol, reltol, fGSLMaxEval);
133  double kine_min[2] = { TMath::Log10(xl.min), TMath::Log10(Q2l.min) };
134  double kine_max[2] = {TMath::Log10(xl.max), TMath::Log10(Q2l.max) };
135  xsec = ig.Integral(kine_min, kine_max) * (1E-38 * units::cm2);
136  delete func;
137 
138  delete interaction;
139 
140  LOG("HEDISXSec", pINFO) << "XSec[HEDIS] (E = " << Ev << " GeV) = " << xsec * (1E+38/units::cm2) << " x 1E-38 cm^2";
141 
142  return xsec;
143 
144 }
string fGSLIntgType
name of GSL numerical integrator
ROOT::Math::IntegrationMultiDim::Type IntegrationNDimTypeFromString(string type)
Definition: GSLUtils.cxx:59
int HitNucPdg(void) const
Definition: Target.cxx:304
A simple [min,max] interval for doubles.
Definition: Range1.h:42
bool SplineExists(const XSecAlgorithmI *alg, const Interaction *i) const
A numeric analysis tool class for interpolating 1-D functions.
Definition: Spline.h:58
bool IsNucleus(void) const
Definition: Target.cxx:272
double fSFQ2max
maximum value of Q2 for which SF tables are computed
Definition: HEDISXSec.h:49
static XSecSplineList * Instance()
Range1D_t Q2Lim(void) const
Q2 limits.
double Evaluate(double x) const
Definition: Spline.cxx:363
void SetId(int pdgc)
Definition: Target.cxx:149
Summary information for an interaction.
Definition: Interaction.h:56
bool IsProton(int pdgc)
Definition: PDGUtils.cxx:336
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE...
Definition: Messenger.h:96
bool IsEmpty(void) const
static constexpr double cm2
Definition: Units.h:69
A Neutrino Interaction Target. Is a transparent encapsulation of quite different physical systems suc...
Definition: Target.h:40
Kinematical phase space.
Definition: KPhaseSpace.h:33
double fSFQ2min
minimum value of Q2 for which SF tables are computed
Definition: HEDISXSec.h:48
const int kPdgTgtFreeN
Definition: PDGCodes.h:200
const int kPdgTgtFreeP
Definition: PDGCodes.h:199
double func(double x, double y)
int Z(void) const
Definition: Target.h:68
#define pINFO
Definition: Messenger.h:62
virtual bool ValidProcess(const Interaction *i) const =0
Can this cross section algorithm handle the input process?
double max
Definition: Range1.h:53
int fGSLMaxEval
GSL max evaluations.
int N(void) const
Definition: Target.h:69
const UInt_t kIAssumeFreeNucleon
Definition: Interaction.h:49
Target * TgtPtr(void) const
Definition: InitialState.h:67
bool IsAboveThreshold(void) const
Checks whether the interaction is above the energy threshold.
double fSFXmin
minimum value of x for which SF tables are computed
Definition: HEDISXSec.h:47
InitialState * InitStatePtr(void) const
Definition: Interaction.h:74
Range1D_t XLim(void) const
x limits
double min
Definition: Range1.h:52
const Target & Tgt(void) const
Definition: InitialState.h:66
const Spline * GetSpline(const XSecAlgorithmI *alg, const Interaction *i) const
List of cross section vs energy splines.
double ProbeE(RefFrame_t rf) const
Initial State information.
Definition: InitialState.h:48
#define pDEBUG
Definition: Messenger.h:63
void HEDISXSec::LoadConfig ( void  )
private

Definition at line 158 of file HEDISXSec.cxx.

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

Referenced by Configure().

159 {
160 
161  // Get GSL integration type & relative tolerance
162  GetParamDef( "gsl-integration-type", fGSLIntgType, string("vegas") ) ;
163 
164  int max_eval ;
165  GetParamDef( "gsl-max-eval", max_eval, 500000 ) ;
166  fGSLMaxEval = (unsigned int) max_eval ;
167 
168  // Limits from the SF tables that are useful to reduce computation
169  // time of the total cross section
170  GetParam("XGrid-Min", fSFXmin ) ;
171  GetParam("Q2Grid-Min", fSFQ2min ) ;
172  GetParam("Q2Grid-Max", fSFQ2max ) ;
173 
174 }
string fGSLIntgType
name of GSL numerical integrator
double fSFQ2max
maximum value of Q2 for which SF tables are computed
Definition: HEDISXSec.h:49
double fSFQ2min
minimum value of Q2 for which SF tables are computed
Definition: HEDISXSec.h:48
int fGSLMaxEval
GSL max evaluations.
double fSFXmin
minimum value of x for which SF tables are computed
Definition: HEDISXSec.h:47
bool GetParamDef(const RgKey &name, T &p, const T &def) const
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const

Member Data Documentation

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

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

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: