GENIEGenerator
Loading...
Searching...
No Matches
genie::DISStructureFuncModelI Class Referenceabstract

Pure Abstract Base Class. Defines the DISStructureFuncModelI interface to be implemented by any algorithmic class computing DIS structure functions. More...

#include <DISStructureFuncModelI.h>

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

Public Member Functions

virtual ~DISStructureFuncModelI ()
virtual void Calculate (const Interaction *interaction) const =0
 Calculate the structure functions F1-F6 for the input interaction.
virtual double F1 (void) const =0
 Get the computed structure function F1.
virtual double F2 (void) const =0
 Get the computed structure function F2.
virtual double F3 (void) const =0
 Get the computed structure function F3.
virtual double F4 (void) const =0
 Get the computed structure function F4.
virtual double F5 (void) const =0
 Get the computed structure function F5.
virtual double F6 (void) const =0
 Get the computed structure function F6.
Public Member Functions inherited from genie::Algorithm
virtual ~Algorithm ()
virtual void Configure (const Registry &config)
virtual void Configure (string config)
virtual void FindConfig (void)
virtual const RegistryGetConfig (void) const
RegistryGetOwnedConfig (void)
virtual const AlgIdId (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 AlgorithmSubAlg (const RgKey &registry_key) const
void AdoptConfig (void)
void AdoptSubstructure (void)
virtual void Print (ostream &stream) const
 Print algorithm info.

Protected Member Functions

 DISStructureFuncModelI ()
 DISStructureFuncModelI (string name)
 DISStructureFuncModelI (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.
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.

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,...)
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
AlgMapfOwnedSubAlgMp
 local pool for owned sub-algs (taken out of the factory pool)

Detailed Description

Pure Abstract Base Class. Defines the DISStructureFuncModelI interface to be implemented by any algorithmic class computing DIS structure functions.

Author
Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool
Created:\n May 03, 2004
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 28 of file DISStructureFuncModelI.h.

Constructor & Destructor Documentation

◆ ~DISStructureFuncModelI()

DISStructureFuncModelI::~DISStructureFuncModelI ( )
virtual

Definition at line 34 of file DISStructureFuncModelI.cxx.

35{
36
37}

◆ DISStructureFuncModelI() [1/3]

◆ DISStructureFuncModelI() [2/3]

DISStructureFuncModelI::DISStructureFuncModelI ( string name)
protected

Definition at line 22 of file DISStructureFuncModelI.cxx.

22 :
23Algorithm(name)
24{
25
26}

References genie::Algorithm::Algorithm().

◆ DISStructureFuncModelI() [3/3]

DISStructureFuncModelI::DISStructureFuncModelI ( string name,
string config )
protected

Definition at line 28 of file DISStructureFuncModelI.cxx.

28 :
29Algorithm(name, config)
30{
31
32}

References genie::Algorithm::Algorithm().

Member Function Documentation

◆ Calculate()

virtual void genie::DISStructureFuncModelI::Calculate ( const Interaction * interaction) const
pure virtual

Calculate the structure functions F1-F6 for the input interaction.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F1()

virtual double genie::DISStructureFuncModelI::F1 ( void ) const
pure virtual

Get the computed structure function F1.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F2()

virtual double genie::DISStructureFuncModelI::F2 ( void ) const
pure virtual

Get the computed structure function F2.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F3()

virtual double genie::DISStructureFuncModelI::F3 ( void ) const
pure virtual

Get the computed structure function F3.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F4()

virtual double genie::DISStructureFuncModelI::F4 ( void ) const
pure virtual

Get the computed structure function F4.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F5()

virtual double genie::DISStructureFuncModelI::F5 ( void ) const
pure virtual

Get the computed structure function F5.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.

◆ F6()

virtual double genie::DISStructureFuncModelI::F6 ( void ) const
pure virtual

Get the computed structure function F6.

Implemented in genie::QPMDISStrucFuncBase, and genie::QPMDMDISStrucFuncBase.


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