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::NormXSec Class Reference

Normalization channel. Its main property is a constant cross section per nucleon over the whole energy range. More...

#include <NormXSec.h>

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

Public Member Functions

 NormXSec ()
 
 NormXSec (string config)
 
virtual ~NormXSec ()
 
double XSec (const Interaction *i, KinePhaseSpace_t k) const
 Compute the cross section for the input interaction. More...
 
double Integral (const Interaction *i) const
 
bool ValidProcess (const Interaction *i) const
 Can this cross section algorithm handle the input process? More...
 
bool ValidKinematics (const Interaction *i) const
 Is the input kinematical point a physically allowed one? More...
 
void Configure (const Registry &config)
 
void Configure (string param_set)
 
- Public Member Functions inherited from genie::XSecAlgorithmI
virtual ~XSecAlgorithmI ()
 
- 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 fNormScale
 

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::XSecAlgorithmI
 XSecAlgorithmI ()
 
 XSecAlgorithmI (string name)
 
 XSecAlgorithmI (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::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

Normalization channel. Its main property is a constant cross section per nucleon over the whole energy range.

References:
[1] GENIE docdb 297
Author
Igor Kakorin kakor.nosp@m.in@j.nosp@m.inr.r.nosp@m.u Joint Institute for Nuclear Research
Created:
May 16, 2022
License:
Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 31 of file NormXSec.h.

Constructor & Destructor Documentation

NormXSec::NormXSec ( )

Definition at line 17 of file NormXSec.cxx.

17  :
18 XSecAlgorithmI("genie::NormXSec")
19 {
20 
21 }
NormXSec::NormXSec ( string  config)

Definition at line 23 of file NormXSec.cxx.

23  :
24 XSecAlgorithmI("genie::NormXSec", config)
25 {
26 
27 }
NormXSec::~NormXSec ( )
virtual

Definition at line 29 of file NormXSec.cxx.

30 {
31 
32 }

Member Function Documentation

void NormXSec::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 59 of file NormXSec.cxx.

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

60 {
61  Algorithm::Configure(config);
62  this->LoadConfig();
63 }
void LoadConfig(void)
Definition: NormXSec.cxx:71
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void NormXSec::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 65 of file NormXSec.cxx.

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

66 {
67  Algorithm::Configure(config);
68  this->LoadConfig();
69 }
void LoadConfig(void)
Definition: NormXSec.cxx:71
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
double NormXSec::Integral ( const Interaction i) const
virtual

Integrate the model over the kinematic phase space available to the input interaction (kinematical cuts can be included)

Implements genie::XSecAlgorithmI.

Definition at line 42 of file NormXSec.cxx.

References genie::Target::A(), genie::units::A, e, fNormScale, genie::Interaction::InitState(), and genie::InitialState::Tgt().

43 {
44  const Target & tgt = interaction->InitState().Tgt();
45  double A = tgt.A();
46  return A*fNormScale*1e-11;
47 }
double fNormScale
Definition: NormXSec.h:51
int A(void) const
Definition: Target.h:70
const double e
static constexpr double A
Definition: Units.h:74
A Neutrino Interaction Target. Is a transparent encapsulation of quite different physical systems suc...
Definition: Target.h:40
void NormXSec::LoadConfig ( void  )
private

Definition at line 71 of file NormXSec.cxx.

References fNormScale, and genie::Algorithm::GetParamDef().

Referenced by Configure().

72 {
73  GetParamDef( "NormScale", fNormScale, 1.0);
74 }
double fNormScale
Definition: NormXSec.h:51
bool GetParamDef(const RgKey &name, T &p, const T &def) const
bool NormXSec::ValidKinematics ( const Interaction i) const
virtual

Is the input kinematical point a physically allowed one?

Reimplemented from genie::XSecAlgorithmI.

Definition at line 54 of file NormXSec.cxx.

55 {
56  return true;
57 }
bool NormXSec::ValidProcess ( const Interaction i) const
virtual

Can this cross section algorithm handle the input process?

Implements genie::XSecAlgorithmI.

Definition at line 49 of file NormXSec.cxx.

50 {
51  return true;
52 }
double NormXSec::XSec ( const Interaction i,
KinePhaseSpace_t  k 
) const
virtual

Compute the cross section for the input interaction.

Implements genie::XSecAlgorithmI.

Definition at line 34 of file NormXSec.cxx.

References genie::Target::A(), genie::units::A, e, fNormScale, genie::Interaction::InitState(), and genie::InitialState::Tgt().

36 {
37  const Target & tgt = interaction->InitState().Tgt();
38  double A = tgt.A();
39  return A*fNormScale*1e-11;
40 }
double fNormScale
Definition: NormXSec.h:51
int A(void) const
Definition: Target.h:70
const double e
static constexpr double A
Definition: Units.h:74
A Neutrino Interaction Target. Is a transparent encapsulation of quite different physical systems suc...
Definition: Target.h:40

Member Data Documentation

double genie::NormXSec::fNormScale
private

Definition at line 51 of file NormXSec.h.

Referenced by Integral(), LoadConfig(), and XSec().


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