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

Concrete implementation of the AxialFormFactorModelI interface. Computes the axial form factor using the dipole form factor approximation. More...

#include <DipoleAxialFormFactorModel.h>

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

Public Member Functions

 DipoleAxialFormFactorModel ()
 DipoleAxialFormFactorModel (string config)
virtual ~DipoleAxialFormFactorModel ()
double FA (const Interaction *interaction) const
 Compute the axial form factor.
void Configure (const Registry &config)
void Configure (string param_set)
Public Member Functions inherited from genie::AxialFormFactorModelI
virtual ~AxialFormFactorModelI ()
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)

Private Attributes

double fMa
 axial mass
double fMa2
double fFA0
 FA(q2=0)

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

Concrete implementation of the AxialFormFactorModelI interface. Computes the axial form factor using the dipole form factor approximation.

Author
Aaron Meyer <asmeyer2012 \at uchicago.edu> 
     based off DipoleELFormFactorsModel by
     Costas Andreopoulos <c.andreopoulos \at cern.ch>
     University of Liverpool
Created:\n August 16, 2013
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 30 of file DipoleAxialFormFactorModel.h.

Constructor & Destructor Documentation

◆ DipoleAxialFormFactorModel() [1/2]

DipoleAxialFormFactorModel::DipoleAxialFormFactorModel ( )

Definition at line 24 of file DipoleAxialFormFactorModel.cxx.

24 :
25AxialFormFactorModelI("genie::DipoleAxialFormFactorModel")
26{
27
28}

References genie::AxialFormFactorModelI::AxialFormFactorModelI().

◆ DipoleAxialFormFactorModel() [2/2]

DipoleAxialFormFactorModel::DipoleAxialFormFactorModel ( string config)

Definition at line 30 of file DipoleAxialFormFactorModel.cxx.

30 :
31AxialFormFactorModelI("genie::DipoleAxialFormFactorModel", config)
32{
33
34}

References genie::AxialFormFactorModelI::AxialFormFactorModelI().

◆ ~DipoleAxialFormFactorModel()

DipoleAxialFormFactorModel::~DipoleAxialFormFactorModel ( )
virtual

Definition at line 36 of file DipoleAxialFormFactorModel.cxx.

37{
38
39}

Member Function Documentation

◆ Configure() [1/2]

void DipoleAxialFormFactorModel::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 51 of file DipoleAxialFormFactorModel.cxx.

52{
53 Algorithm::Configure(config);
54 this->LoadConfig();
55}
genie::Algorithm::Configure
virtual void Configure(const Registry &config)
Definition Algorithm.cxx:62

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

◆ Configure() [2/2]

void DipoleAxialFormFactorModel::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 57 of file DipoleAxialFormFactorModel.cxx.

58{
59 Algorithm::Configure(param_set);
60 this->LoadConfig();
61}

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

◆ FA()

double DipoleAxialFormFactorModel::FA ( const Interaction * interaction) const
virtual

Compute the axial form factor.

Implements genie::AxialFormFactorModelI.

Definition at line 41 of file DipoleAxialFormFactorModel.cxx.

42{
43 // calculate and return FA
44 double q2 = interaction->Kine().q2();
45 double fa = fFA0 / TMath::Power(1-q2/fMa2, 2);
46
47 LOG("AxialFormFactor", pDEBUG) << "FA(q^2 = " << q2 << ") = " << fa;
48 return fa;
49}
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::Interaction::Kine
const Kinematics & Kine(void) const
Definition Interaction.h:71
genie::Kinematics::q2
double q2(bool selected=false) const
Definition Kinematics.cxx:141

References fFA0, fMa2, genie::Interaction::Kine(), LOG, pDEBUG, and genie::Kinematics::q2().

◆ LoadConfig()

void DipoleAxialFormFactorModel::LoadConfig ( void )
private

Definition at line 63 of file DipoleAxialFormFactorModel.cxx.

64{
65 GetParam( "QEL-Ma", fMa ) ;
66 fMa2 = TMath::Power(fMa,2);
67
68 // FA(q2 = 0)
69 GetParam( "QEL-FA0", fFA0 ) ;
70}
genie::Algorithm::GetParam
bool GetParam(const RgKey &name, T &p, bool is_top_call=true) const

References fFA0, fMa, fMa2, and genie::Algorithm::GetParam().

Referenced by Configure(), and Configure().

Member Data Documentation

◆ fFA0

double genie::DipoleAxialFormFactorModel::fFA0
private

FA(q2=0)

Definition at line 50 of file DipoleAxialFormFactorModel.h.

Referenced by FA(), and LoadConfig().

◆ fMa

double genie::DipoleAxialFormFactorModel::fMa
private

axial mass

Definition at line 48 of file DipoleAxialFormFactorModel.h.

Referenced by LoadConfig().

◆ fMa2

double genie::DipoleAxialFormFactorModel::fMa2
private

Definition at line 49 of file DipoleAxialFormFactorModel.h.

Referenced by FA(), and LoadConfig().

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