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

#include <QvalueShifter.h>

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

Public Member Functions

 QvalueShifter ()
 
 QvalueShifter (string config)
 
virtual ~QvalueShifter ()
 
virtual double Shift (const Target &target) const
 
virtual double Shift (const Interaction &interaction) const
 
void Configure (const Registry &config)
 
void Configure (string config)
 
- 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...
 

Protected Member Functions

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

Private Attributes

double fRelShiftDefault
 
std::map< int, double > fRelShift
 

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

Definition at line 29 of file QvalueShifter.h.

Constructor & Destructor Documentation

QvalueShifter::QvalueShifter ( )

Definition at line 21 of file QvalueShifter.cxx.

21  :
22  Algorithm("genie::QvalueShifter")
23 {
24 
25 }
QvalueShifter::QvalueShifter ( string  config)

Definition at line 27 of file QvalueShifter.cxx.

27  :
28  Algorithm("genie::QvalueShifter",config)
29 {
30 
31 }
QvalueShifter::~QvalueShifter ( )
virtual

Definition at line 33 of file QvalueShifter.cxx.

34 {
35 
36 }

Member Function Documentation

void QvalueShifter::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 38 of file QvalueShifter.cxx.

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

39 {
40  Algorithm::Configure(config);
41  this->LoadConfig();
42 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void QvalueShifter::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 44 of file QvalueShifter.cxx.

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

45 {
46  Algorithm::Configure(config);
47  this->LoadConfig();
48 }
virtual void Configure(const Registry &config)
Definition: Algorithm.cxx:62
void QvalueShifter::LoadConfig ( void  )
protected

Definition at line 76 of file QvalueShifter.cxx.

References genie::Registry::FindKeys(), fRelShift, fRelShiftDefault, genie::Algorithm::GetConfig(), genie::Algorithm::GetParam(), genie::PDGLibrary::Instance(), genie::pdg::IsIon(), LOG, pERROR, and genie::utils::str::Split().

Referenced by Configure().

77 {
78  bool good_config = true ;
79  // Store default value
80  GetParam( "QvalueShiftDefault", fRelShiftDefault ) ;
81 
82  // Clear map
83  fRelShift.clear() ;
84 
85  // Get possible entries to pdg - shift map
86  auto kpdg_list = GetConfig().FindKeys("QvalueShift@Pdg=") ;
87 
88  for( auto kiter = kpdg_list.begin(); kiter != kpdg_list.end(); ++kiter ) {
89  const RgKey & key = *kiter ;
90  vector<string> kv = genie::utils::str::Split(key,"=");
91  assert(kv.size()==2);
92  int pdg_target = stoi( kv[1] );
93  if( ! PDGLibrary::Instance()->Find(pdg_target) ) {
94  LOG("QvalueShifter", pERROR) << "The target Pdg code associated to the QvalueShift is not valid : " << pdg_target ;
95  good_config = false ;
96  continue ;
97  }
98 
99  if( ! pdg::IsIon(pdg_target) ) {
100  LOG("QvalueShifter", pERROR) << "The target Pdg code does not correspond to a Ion : " << pdg_target ;
101  good_config = false ;
102  continue ;
103  }
104  GetParam( key, fRelShift[pdg_target] ) ;
105  }
106 
107  if( ! good_config ) {
108  LOG("QvalueShifter", pERROR) << "Configuration has failed.";
109  exit(78) ;
110  }
111 
112 }
#define pERROR
Definition: Messenger.h:59
virtual const Registry & GetConfig(void) const
Definition: Algorithm.cxx:246
RgKeyList FindKeys(RgKey key_part) const
create list with all keys containing &#39;key_part&#39;
Definition: Registry.cxx:840
#define LOG(stream, priority)
A macro that returns the requested log4cpp::Category appending a string (using the FILE...
Definition: Messenger.h:96
static PDGLibrary * Instance(void)
Definition: PDGLibrary.cxx:68
std::map< int, double > fRelShift
Definition: QvalueShifter.h:49
vector< string > Split(string input, string delim)
Definition: StringUtils.cxx:36
bool IsIon(int pdgc)
Definition: PDGUtils.cxx:42
string RgKey
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const
double QvalueShifter::Shift ( const Target target) const
virtual

Definition at line 51 of file QvalueShifter.cxx.

References fRelShift, fRelShiftDefault, genie::Target::Pdg(), and genie::units::second.

Referenced by Shift(), and genie::NievesQELCCPXSec::XSec().

51  {
52  // Get Target pdg
53  int pdg_target = target.Pdg() ;
54 
55  const auto it = fRelShift.find(pdg_target) ;
56  if ( it != fRelShift.end() ) {
57  return it -> second ;
58  } else {
59  // return default
60  return fRelShiftDefault ;
61  }
62 
63  }
int Pdg(void) const
Definition: Target.h:71
static constexpr double second
Definition: Units.h:37
std::map< int, double > fRelShift
Definition: QvalueShifter.h:49
double QvalueShifter::Shift ( const Interaction interaction) const
virtual

Definition at line 67 of file QvalueShifter.cxx.

References genie::Interaction::InitState(), Shift(), and genie::InitialState::Tgt().

67  {
68  // This function allows the flexibility to add shift as a function of
69  // the interaction type.
70  // Right now, we just call the default :
71  return Shift( interaction.InitState().Tgt() ) ;
72  }
virtual double Shift(const Target &target) const
const InitialState & InitState(void) const
Definition: Interaction.h:69
const Target & Tgt(void) const
Definition: InitialState.h:66

Member Data Documentation

std::map<int,double> genie::QvalueShifter::fRelShift
private

Definition at line 49 of file QvalueShifter.h.

Referenced by LoadConfig(), and Shift().

double genie::QvalueShifter::fRelShiftDefault
private

Definition at line 48 of file QvalueShifter.h.

Referenced by LoadConfig(), and Shift().


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