GENIEGenerator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | List of all members
genie::CEvNSXSec Class Reference

Computes the cross section for coherent elastic scattering.
Is a concrete implementation of the XSecIntegratorI interface. More...

#include <CEvNSXSec.h>

Inheritance diagram for genie::CEvNSXSec:
Inheritance graph
[legend]
Collaboration diagram for genie::CEvNSXSec:
Collaboration graph
[legend]

Public Member Functions

 CEvNSXSec ()
 
 CEvNSXSec (string config)
 
virtual ~CEvNSXSec ()
 
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. 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)
 

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 cross section for coherent elastic scattering.
Is a concrete implementation of the XSecIntegratorI interface.

Author
Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool
Created:
July 12, 2019
License:
Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 26 of file CEvNSXSec.h.

Constructor & Destructor Documentation

CEvNSXSec::CEvNSXSec ( )

Definition at line 28 of file CEvNSXSec.cxx.

28  :
29 XSecIntegratorI("genie::CEvNSXSec")
30 {
31 
32 }
CEvNSXSec::CEvNSXSec ( string  config)

Definition at line 34 of file CEvNSXSec.cxx.

34  :
35 XSecIntegratorI("genie::CEvNSXSec", config)
36 {
37 
38 }
CEvNSXSec::~CEvNSXSec ( )
virtual

Definition at line 40 of file CEvNSXSec.cxx.

41 {
42 
43 }

Member Function Documentation

void CEvNSXSec::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 85 of file CEvNSXSec.cxx.

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

86 {
87  Algorithm::Configure(config);
88  this->LoadConfig();
89 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void LoadConfig(void)
Definition: CEvNSXSec.cxx:97
void CEvNSXSec::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 91 of file CEvNSXSec.cxx.

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

92 {
93  Algorithm::Configure(config);
94  this->LoadConfig();
95 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void LoadConfig(void)
Definition: CEvNSXSec.cxx:97
double CEvNSXSec::Integrate ( const XSecAlgorithmI model,
const Interaction i 
) const
virtual

Implements genie::XSecIntegratorI.

Definition at line 45 of file CEvNSXSec.cxx.

References genie::units::cm2, genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, func(), genie::Interaction::InitState(), genie::utils::gsl::Integration1DimTypeFromString(), genie::KPhaseSpace::IsAboveThreshold(), genie::kISkipKinematicChk, genie::kISkipProcessChk, genie::kRfLab, LOG, genie::Range1D_t::max, genie::Range1D_t::min, pDEBUG, genie::Interaction::PhaseSpace(), pINFO, pNOTICE, genie::InitialState::ProbeE(), genie::utils::kinematics::Q2(), genie::KPhaseSpace::Q2Lim(), and genie::XSecAlgorithmI::ValidProcess().

47 {
48  if(! model->ValidProcess(in) ) return 0.;
49 
50  const KPhaseSpace & kps = in->PhaseSpace();
51  if(!kps.IsAboveThreshold()) {
52  LOG("CEvNS", pDEBUG) << "*** Below energy threshold";
53  return 0;
54  }
55 
56  Range1D_t Q2 = kps.Q2Lim();
57  LOG("CEvNS", pNOTICE)
58  << "Q2 integration range = [" << Q2.min << ", " << Q2.max << "] GeV^2";
59  assert(Q2.min > 0. && Q2.min < Q2.max);
60 
61  Interaction * interaction = new Interaction(*in);
62  interaction->SetBit(kISkipProcessChk);
63  interaction->SetBit(kISkipKinematicChk);
64 
65  ROOT::Math::IntegrationOneDim::Type ig_type =
67  ROOT::Math::IBaseFunctionOneDim * func =
68  new utils::gsl::dXSec_dQ2_E(model, interaction);
69  double abstol = 1; // We mostly care about relative tolerance
70  ROOT::Math::Integrator ig(*func,ig_type,abstol,fGSLRelTol,fGSLMaxEval);
71  double xsec = ig.Integral(Q2.min, Q2.max) * (1E-38 * units::cm2); // units: GeV^-2
72 
73  delete func;
74 
75  const InitialState & init_state = in->InitState();
76  double Ev = init_state.ProbeE(kRfLab);
77  LOG("CEvNS", pINFO)
78  << "XSec[CEvNS] (E = " << Ev << " GeV) = " << xsec/(units::cm2) << " cm^2";
79 
80  delete interaction;
81 
82  return xsec;
83 }
ROOT::Math::IntegrationOneDim::Type Integration1DimTypeFromString(string type)
Definition: GSLUtils.cxx:23
string fGSLIntgType
name of GSL numerical integrator
double Q2(const Interaction *const i)
Definition: KineUtils.cxx:1077
A simple [min,max] interval for doubles.
Definition: Range1.h:42
Range1D_t Q2Lim(void) const
Q2 limits.
Summary information for an interaction.
Definition: Interaction.h:56
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE...
Definition: Messenger.h:96
static constexpr double cm2
Definition: Units.h:69
Kinematical phase space.
Definition: KPhaseSpace.h:33
double func(double x, double y)
#define pINFO
Definition: Messenger.h:62
const UInt_t kISkipKinematicChk
if set, skip kinematic validity checks
Definition: Interaction.h:48
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.
bool IsAboveThreshold(void) const
Checks whether the interaction is above the energy threshold.
double min
Definition: Range1.h:52
#define pNOTICE
Definition: Messenger.h:61
double ProbeE(RefFrame_t rf) const
const UInt_t kISkipProcessChk
if set, skip process validity checks
Definition: Interaction.h:47
Initial State information.
Definition: InitialState.h:48
#define pDEBUG
Definition: Messenger.h:63
double fGSLRelTol
required relative tolerance (error)
void CEvNSXSec::LoadConfig ( void  )
private

Definition at line 97 of file CEvNSXSec.cxx.

References genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLMinEval, genie::XSecIntegratorI::fGSLRelTol, and genie::Algorithm::GetParamDef().

Referenced by Configure().

98 {
99  // Get GSL integration type & relative tolerance
100  this->GetParamDef("gsl-integration-type", fGSLIntgType, string("adaptive"));
101  this->GetParamDef("gsl-relative-tolerance", fGSLRelTol, 1E-2);
102 
103  // max and minimum number of integrand evaluations
104  int max_eval, min_eval ;
105  this->GetParamDef("gsl-max-eval", max_eval, 500000);
106  this->GetParamDef("gsl-min-eval", min_eval, 5000 );
107  fGSLMaxEval = (unsigned int) max_eval ;
108  fGSLMinEval = (unsigned int) min_eval ;
109 
110  // LOG("CEvNS", pDEBUG) << *this;
111 }
string fGSLIntgType
name of GSL numerical integrator
int fGSLMaxEval
GSL max evaluations.
bool GetParamDef(const RgKey &name, T &p, const T &def) const
int fGSLMinEval
GSL min evaluations. Ignored by some integrators.
double fGSLRelTol
required relative tolerance (error)

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