GENIEGenerator
Loading...
Searching...
No Matches
genie::MECXSec Class Reference

A numerical cross-section integrator (GENIE/GSL interface) for the J. Nieves, I. Ruiz Simo, M.J. Vicente Vacas and Martini MEC models. Is a concrete implementation of the XSecIntegratorI interface. More...

#include <MECXSec.h>

Inheritance diagram for genie::MECXSec:
[legend]
Collaboration diagram for genie::MECXSec:
[legend]

Public Member Functions

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

Protected Attributes

bool fSplitIntegral
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
AlgMapfOwnedSubAlgMp
 local pool for owned sub-algs (taken out of the factory pool)

Private Member Functions

void LoadConfig (void)

Private Attributes

double fQ3Max

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

Detailed Description

A numerical cross-section integrator (GENIE/GSL interface) for the J. Nieves, I. Ruiz Simo, M.J. Vicente Vacas and Martini MEC models. Is a concrete implementation of the XSecIntegratorI interface.

Author
Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool
Created:\n March 22, 2016
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 34 of file MECXSec.h.

Constructor & Destructor Documentation

◆ MECXSec() [1/2]

MECXSec::MECXSec ( )

Definition at line 41 of file MECXSec.cxx.

41 :
42XSecIntegratorI("genie::MECXSec")
43{
44
45}

References genie::XSecIntegratorI::XSecIntegratorI().

◆ MECXSec() [2/2]

MECXSec::MECXSec ( string config)

Definition at line 47 of file MECXSec.cxx.

47 :
48XSecIntegratorI("genie::MECXSec", config)
49{
50
51}

References genie::XSecIntegratorI::XSecIntegratorI().

◆ ~MECXSec()

MECXSec::~MECXSec ( )
virtual

Definition at line 53 of file MECXSec.cxx.

54{
55
56}

Member Function Documentation

◆ Configure() [1/2]

void MECXSec::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 104 of file MECXSec.cxx.

105{
106 Algorithm::Configure(config);
107 this->LoadConfig();
108}
virtual void Configure(const Registry &config)
Definition Algorithm.cxx:62
void LoadConfig(void)
Definition MECXSec.cxx:116

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

◆ Configure() [2/2]

void MECXSec::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 110 of file MECXSec.cxx.

111{
112 Algorithm::Configure(config);
113 this->LoadConfig();
114}

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

◆ Integrate()

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

Implements genie::XSecIntegratorI.

Definition at line 58 of file MECXSec.cxx.

60{
61 if(! model->ValidProcess(in) ) return 0.;
62
63 const KPhaseSpace & kps = in->PhaseSpace(); // only OK phase space for this
64 if(!kps.IsAboveThreshold()) {
65 LOG("MECXSec", pDEBUG) << "*** Below energy threshold";
66 return 0;
67 }
68
69 Interaction interaction(*in);
70 interaction.SetBit(kISkipProcessChk);
71 interaction.SetBit(kISkipKinematicChk);
72
73 // T, costh limits
74 double Enu = in->InitState().ProbeE(kRfLab);
75 double LepMass = in->FSPrimLepton()->Mass();
76 double TMax = Enu - LepMass;
77 double TMin = 0.0;
78 double CosthMax = 1.0;
79 double CosthMin = -1.0;
80 if (Enu < fQ3Max) {
81 TMin = 0 ;
82 CosthMin = -1 ;
83 } else {
84 TMin = TMath::Sqrt(TMath::Power(LepMass, 2) + TMath::Power((Enu - fQ3Max), 2)) - LepMass;
85 CosthMin = TMath::Sqrt(1 - TMath::Power((fQ3Max / Enu ), 2));
86 }
87
88 double kine_min[2] = { TMin, CosthMin };
89 double kine_max[2] = { TMax, CosthMax };
90
91 double xsec = 0;
92
93 double abstol = 1; //We mostly care about relative tolerance.
94 genie::utils::mec::gsl::d2Xsec_dTCosth func(model, interaction, Enu, LepMass );
95 ROOT::Math::IntegrationMultiDim::Type ig_type =
97 ROOT::Math::IntegratorMultiDim ig(func, ig_type, abstol, fGSLRelTol, fGSLMaxEval);
98
99 xsec = ig.Integral(kine_min, kine_max);
100
101 return xsec;
102}
#define pDEBUG
Definition Messenger.h:63
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE,...
Definition Messenger.h:96
bool IsAboveThreshold(void) const
Checks whether the interaction is above the energy threshold.
double fQ3Max
Definition MECXSec.h:53
virtual bool ValidProcess(const Interaction *i) const =0
Can this cross section algorithm handle the input process?
string fGSLIntgType
name of GSL numerical integrator
int fGSLMaxEval
GSL max evaluations.
double fGSLRelTol
required relative tolerance (error)
double func(double x, double y)
ROOT::Math::IntegrationMultiDim::Type IntegrationNDimTypeFromString(string type)
Definition GSLUtils.cxx:59
const UInt_t kISkipKinematicChk
if set, skip kinematic validity checks
Definition Interaction.h:48
@ kRfLab
Definition RefFrame.h:26
const UInt_t kISkipProcessChk
if set, skip process validity checks
Definition Interaction.h:47

References genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, fQ3Max, genie::Interaction::FSPrimLepton(), func(), genie::Interaction::InitState(), genie::utils::gsl::IntegrationNDimTypeFromString(), genie::KPhaseSpace::IsAboveThreshold(), genie::kISkipKinematicChk, genie::kISkipProcessChk, genie::kRfLab, LOG, pDEBUG, genie::Interaction::PhaseSpace(), genie::InitialState::ProbeE(), and genie::XSecAlgorithmI::ValidProcess().

◆ LoadConfig()

void MECXSec::LoadConfig ( void )
private

Definition at line 116 of file MECXSec.cxx.

117{
118 GetParam( "NSV-Q3Max", fQ3Max ) ;
119
120 // Get GSL integration type & relative tolerance
121 GetParamDef( "gsl-integration-type", fGSLIntgType, string("vegas") ) ;
122
123 int max ;
124 GetParamDef( "gsl-max-eval", max, 20000 ) ;
125 fGSLMaxEval = (unsigned int) max ;
126
127 GetParamDef( "gsl-relative-tolerance", fGSLRelTol, 0.01 ) ;
128 GetParamDef( "split-integral", fSplitIntegral, true ) ;
129
130}
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const
bool GetParamDef(const RgKey &name, T &p, const T &def) const
bool fSplitIntegral
Definition MECXSec.h:49

References genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, fQ3Max, fSplitIntegral, genie::Algorithm::GetParam(), and genie::Algorithm::GetParamDef().

Referenced by Configure(), and Configure().

Member Data Documentation

◆ fQ3Max

double genie::MECXSec::fQ3Max
private

Definition at line 53 of file MECXSec.h.

Referenced by Integrate(), and LoadConfig().

◆ fSplitIntegral

bool genie::MECXSec::fSplitIntegral
protected

Definition at line 49 of file MECXSec.h.

Referenced by LoadConfig().


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