GENIEGenerator
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
genie::DMELXSec Class Reference

Computes the Elastic dark matter (DMEL) cross section.
Is a concrete implementation of the XSecIntegratorI interface.
. More...

#include <DMELXSec.h>

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

Public Member Functions

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

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 Elastic dark matter (DMEL) cross section.
Is a concrete implementation of the XSecIntegratorI interface.
.

Author
Joshua Berger <jberger \at physics.wisc.edu> University of Wisconsin-Madison Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool
Created:\n September 4, 2017
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 31 of file DMELXSec.h.

Constructor & Destructor Documentation

◆ DMELXSec() [1/2]

DMELXSec::DMELXSec ( )

Definition at line 44 of file DMELXSec.cxx.

44 :
45XSecIntegratorI("genie::DMELXSec")
46{
47
48}

References genie::XSecIntegratorI::XSecIntegratorI().

◆ DMELXSec() [2/2]

DMELXSec::DMELXSec ( string config)

Definition at line 50 of file DMELXSec.cxx.

50 :
51XSecIntegratorI("genie::DMELXSec", config)
52{
53
54}

References genie::XSecIntegratorI::XSecIntegratorI().

◆ ~DMELXSec()

DMELXSec::~DMELXSec ( )
virtual

Definition at line 56 of file DMELXSec.cxx.

57{
58
59}

Member Function Documentation

◆ Configure() [1/2]

void DMELXSec::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 99 of file DMELXSec.cxx.

100{
101 Algorithm::Configure(config);
102 this->LoadConfig();
103}
genie::Algorithm::Configure
virtual void Configure(const Registry &config)
Definition Algorithm.cxx:62
genie::DMELXSec::LoadConfig
void LoadConfig(void)
Definition DMELXSec.cxx:111

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

◆ Configure() [2/2]

void DMELXSec::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 105 of file DMELXSec.cxx.

106{
107 Algorithm::Configure(config);
108 this->LoadConfig();
109}

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

◆ Integrate()

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

XSecIntegratorI interface implementation.

Implements genie::XSecIntegratorI.

Definition at line 61 of file DMELXSec.cxx.

63{
64 LOG("DMELXSec",pDEBUG) << "Beginning integrate";
65 if(! model->ValidProcess(in)) return 0.;
66
67 const KPhaseSpace & kps = in->PhaseSpace();
68 if(!kps.IsAboveThreshold()) {
69 LOG("DMELXSec", pDEBUG) << "*** Below energy threshold";
70 return 0;
71 }
72 Range1D_t rQ2 = kps.Limits(kKVQ2);
73
74 if(rQ2.min<0 || rQ2.max<0) return 0;
75 LOG("DMELXSec", pDEBUG)
76 << "Q2 integration range = (" << rQ2.min << ", " << rQ2.max << ")";
77
78 Interaction * interaction = new Interaction(*in);
79 interaction->SetBit(kISkipProcessChk);
80 interaction->SetBit(kISkipKinematicChk);
81
82 ROOT::Math::IBaseFunctionOneDim * func = new
83 utils::gsl::dXSec_dQ2_E(model, interaction);
84 ROOT::Math::IntegrationOneDim::Type ig_type =
85 utils::gsl::Integration1DimTypeFromString(fGSLIntgType);
86
87 double abstol = 1; //We mostly care about relative tolerance
88 ROOT::Math::Integrator ig(*func,ig_type,abstol,fGSLRelTol,fGSLMaxEval);
89 double xsec = ig.Integral(rQ2.min, rQ2.max) * (1E-38 * units::cm2);
90
91 //LOG("DMELXSec", pDEBUG) << "XSec[DMEL] (E = " << E << ") = " << xsec;
92
93 delete func;
94 delete interaction;
95
96 return xsec;
97}
pDEBUG
#define pDEBUG
Definition Messenger.h:63
LOG
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE,...
Definition Messenger.h:96
genie::KPhaseSpace::IsAboveThreshold
bool IsAboveThreshold(void) const
Checks whether the interaction is above the energy threshold.
Definition KPhaseSpace.cxx:284
genie::KPhaseSpace::Limits
Range1D_t Limits(KineVar_t kvar) const
Return the kinematical variable limits.
Definition KPhaseSpace.cxx:250
genie::Range1D_t::max
double max
Definition Range1.h:53
genie::Range1D_t::min
double min
Definition Range1.h:52
genie::XSecAlgorithmI::ValidProcess
virtual bool ValidProcess(const Interaction *i) const =0
Can this cross section algorithm handle the input process?
genie::XSecIntegratorI::fGSLIntgType
string fGSLIntgType
name of GSL numerical integrator
Definition XSecIntegratorI.h:44
genie::XSecIntegratorI::fGSLMaxEval
int fGSLMaxEval
GSL max evaluations.
Definition XSecIntegratorI.h:46
genie::XSecIntegratorI::fGSLRelTol
double fGSLRelTol
required relative tolerance (error)
Definition XSecIntegratorI.h:45
func
double func(double x, double y)
Definition gtestBLI2DUnifGrid.cxx:81
genie::units::cm2
static constexpr double cm2
Definition Units.h:69
genie::utils::gsl::Integration1DimTypeFromString
ROOT::Math::IntegrationOneDim::Type Integration1DimTypeFromString(string type)
Definition GSLUtils.cxx:23
genie::kKVQ2
@ kKVQ2
Definition KineVar.h:33
genie::kISkipKinematicChk
const UInt_t kISkipKinematicChk
if set, skip kinematic validity checks
Definition Interaction.h:48
genie::kISkipProcessChk
const UInt_t kISkipProcessChk
if set, skip process validity checks
Definition Interaction.h:47

References genie::units::cm2, genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, func(), genie::utils::gsl::Integration1DimTypeFromString(), genie::KPhaseSpace::IsAboveThreshold(), genie::kISkipKinematicChk, genie::kISkipProcessChk, genie::kKVQ2, genie::KPhaseSpace::Limits(), LOG, genie::Range1D_t::max, genie::Range1D_t::min, pDEBUG, genie::Interaction::PhaseSpace(), and genie::XSecAlgorithmI::ValidProcess().

◆ LoadConfig()

void DMELXSec::LoadConfig ( void )
private

Definition at line 111 of file DMELXSec.cxx.

112{
113 // Get GSL integration type & relative tolerance
114 GetParamDef( "gsl-integration-type", fGSLIntgType, string("adaptive"));
115 GetParamDef( "gsl-relative-tolerance", fGSLRelTol, 0.01 ) ;
116 int max;
117 GetParamDef( "gsl-max-eval", max, 100000) ;
118 fGSLMaxEval = (unsigned int) max ;
119}
genie::Algorithm::GetParamDef
bool GetParamDef(const RgKey &name, T &p, const T &def) const

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

Referenced by Configure(), and Configure().

The documentation for this class was generated from the following files:
Generated on for GENIEGenerator by doxygen 1.14.0