PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PARTONS::GPDEvolutionModule Class Referenceabstract

Abstract class for GPD evolution implementation. More...

Inheritance diagram for PARTONS::GPDEvolutionModule:
PARTONS::ModuleObject PARTONS::BaseObject PARTONS::GPDEvolutionApfel PARTONS::GPDEvolutionVinnikov

Public Member Functions

 GPDEvolutionModule (const std::string &className)
 Constructor. More...
 
virtual ~GPDEvolutionModule ()
 Destructor. More...
 
virtual GPDEvolutionModuleclone () const =0
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
virtual void resolveObjectDependencies ()
 Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others. More...
 
virtual void configure (const ElemUtils::Parameters &parameters)
 Provides a generic method to configure all types of modules by passing a Parameters object. More...
 
virtual void prepareSubModules (const std::map< std::string, BaseObjectData > &subModulesData)
 Method used in automation to prepare all the modules used by this current module and configure them recursively. More...
 
PartonDistribution compute (const GPDKinematic &kinematic, GPDModule *pGPDModule, const GPDType::Type &type)
 Evaluate PartonDistribution. More...
 
void setMuF2_ref (const double &MuF2_ref)
 
void setPertOrder (const PerturbativeQCDOrderType::Type &pertOrder)
 
void setGPDType (GPDType::Type type)
 
void setRunningAlphaStrongModule (RunningAlphaStrongModule *runningAlphaStrongModule)
 
void setActiveFlavorsModule (ActiveFlavorsThresholdsModule *activeFlavorsModule)
 
double getMuF2_ref () const
 
double getMuF_ref () const
 
PerturbativeQCDOrderType::Type getPertOrder () const
 
GPDType::Type getGPDType () const
 
RunningAlphaStrongModulegetRunningAlphaStrongModule () const
 
ActiveFlavorsThresholdsModulegetActiveFlavorsModule () const
 
- Public Member Functions inherited from PARTONS::ModuleObject
 ModuleObject (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
virtual ~ModuleObject ()
 Default destructor. More...
 
virtual void run ()
 
unsigned int getReferenceModuleId () const
 Get reference module id. More...
 
void setReferenceModuleId (unsigned int referenceModuleId)
 Set reference module id. More...
 
ChannelType::Type getChannelType () const
 Get channel type. More...
 
- Public Member Functions inherited from PARTONS::BaseObject
 BaseObject (const std::string &className)
 Constructor. More...
 
virtual ~BaseObject ()
 Default destructor. More...
 
void serialize (ElemUtils::Packet &packet) const
 Used to split a complex C++ object into a concatenation of simple types. More...
 
void unserialize (ElemUtils::Packet &packet)
 Used to rebuild a complex C++ object from a concatenation of simple type. More...
 
bool operator< (const BaseObject &other) const
 Overload of < operator to sort BaseObject object by its indexId value. More...
 
const std::string & getClassName () const
 
unsigned int getObjectId () const
 
int getIndexId () const
 
void setIndexId (int indexId)
 

Static Public Attributes

static const std::string GPD_EVOLUTION_MODULE_CLASS_NAME
 Type of module name used by the automatization. More...
 
- Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string CLASS_NAME = "className"
 

Protected Member Functions

 GPDEvolutionModule (const GPDEvolutionModule &other)
 Copy constructor. More...
 
virtual void initModule ()
 Pure virtual function that provides skeleton for module initialization. More...
 
virtual void isModuleWellConfigured ()
 Pure virtual function that provides skeleton to check if the module is well initialized and configured. More...
 
virtual void setKinematics (const GPDKinematic &kinematic)
 
virtual GPDKinematic getKinematics () const
 
virtual PartonDistribution compute (GPDModule *pGPDModule, const GPDType::Type &type)=0
 
- Protected Member Functions inherited from PARTONS::ModuleObject
 ModuleObject (const ModuleObject &other)
 
- Protected Member Functions inherited from PARTONS::BaseObject
 BaseObject (const BaseObject &other)
 Copy constructor. More...
 
void info (const std::string &functionName, const std::string &message) const
 Print info message into logger. More...
 
void debug (const std::string &functionName, const std::string &message) const
 Print debug message into logger. More...
 
void warn (const std::string &functionName, const std::string &message) const
 Print warning message into logger. More...
 
void errorMissingParameter (const std::string &parameterName) const
 Use in automation process to throw exception when a parameter is missing from the XML scenario file. More...
 

Protected Attributes

double m_MuF2_ref
 Attributes. More...
 
PerturbativeQCDOrderType::Type m_pertOrder
 pQCD order assumed in the calculation. More...
 
GPDType::Type m_type
 GPD distribution type. More...
 
RunningAlphaStrongModulem_pRunningAlphaStrongModule
 Pointer to RunningAlphaStrongModule object being used. More...
 
ActiveFlavorsThresholdsModulem_pActiveFlavorsModule
 Pointer to ActiveFlavorsThresholdsModule object being used. More...
 
double m_x
 Kinematics. More...
 
double m_xi
 Skewness variable. More...
 
double m_t
 Four-momentum transfer squared of hadron target (in \(GeV^{2}\)). More...
 
double m_MuF2
 Factorization scale squared (in \(GeV^{2}\)). More...
 
double m_MuR2
 Renormalization scale squared (in \(GeV^{2}\)). More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

Abstract class for GPD evolution implementation.

This class acts as an abstract (mother) class for modules implementing GPD evolution.

Constructor & Destructor Documentation

◆ GPDEvolutionModule() [1/2]

PARTONS::GPDEvolutionModule::GPDEvolutionModule ( const std::string &  className)

Constructor.

Parameters
classNameName of class.

◆ ~GPDEvolutionModule()

PARTONS::GPDEvolutionModule::~GPDEvolutionModule ( )
virtual

Destructor.

◆ GPDEvolutionModule() [2/2]

PARTONS::GPDEvolutionModule::GPDEvolutionModule ( const GPDEvolutionModule other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

virtual GPDEvolutionModule* PARTONS::GPDEvolutionModule::clone ( ) const
pure virtual

Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry.

Returns

Implements PARTONS::ModuleObject.

Implemented in PARTONS::GPDEvolutionVinnikov, and PARTONS::GPDEvolutionApfel.

◆ compute() [1/2]

PartonDistribution PARTONS::GPDEvolutionModule::compute ( const GPDKinematic kinematic,
GPDModule pGPDModule,
const GPDType::Type type 
)

Evaluate PartonDistribution.

◆ compute() [2/2]

virtual PartonDistribution PARTONS::GPDEvolutionModule::compute ( GPDModule pGPDModule,
const GPDType::Type type 
)
protectedpure virtual

◆ configure()

void PARTONS::GPDEvolutionModule::configure ( const ElemUtils::Parameters &  parameters)
virtual

Provides a generic method to configure all types of modules by passing a Parameters object.

Parameters class represents a list of couples key/value (see Parameters class documentation for more info).

Parameters
parametersElemUtils::Parameters object.

Reimplemented from PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionVinnikov, and PARTONS::GPDEvolutionApfel.

◆ getActiveFlavorsModule()

ActiveFlavorsThresholdsModule * PARTONS::GPDEvolutionModule::getActiveFlavorsModule ( ) const

◆ getGPDType()

GPDType::Type PARTONS::GPDEvolutionModule::getGPDType ( ) const

◆ getKinematics()

GPDKinematic PARTONS::GPDEvolutionModule::getKinematics ( ) const
protectedvirtual

◆ getMuF2_ref()

double PARTONS::GPDEvolutionModule::getMuF2_ref ( ) const

◆ getMuF_ref()

double PARTONS::GPDEvolutionModule::getMuF_ref ( ) const

◆ getPertOrder()

PerturbativeQCDOrderType::Type PARTONS::GPDEvolutionModule::getPertOrder ( ) const

◆ getRunningAlphaStrongModule()

RunningAlphaStrongModule * PARTONS::GPDEvolutionModule::getRunningAlphaStrongModule ( ) const

◆ initModule()

void PARTONS::GPDEvolutionModule::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Implements PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionVinnikov, and PARTONS::GPDEvolutionApfel.

◆ isModuleWellConfigured()

void PARTONS::GPDEvolutionModule::isModuleWellConfigured ( )
protectedvirtual

Pure virtual function that provides skeleton to check if the module is well initialized and configured.

Children must define and override it.

Implements PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionVinnikov, and PARTONS::GPDEvolutionApfel.

◆ prepareSubModules()

void PARTONS::GPDEvolutionModule::prepareSubModules ( const std::map< std::string, BaseObjectData > &  subModulesData)
virtual

Method used in automation to prepare all the modules used by this current module and configure them recursively.

The recursion is linked to the imbrication in XML files.
Can be implemented in the child class if it needs modules not needed by the parent class. But there must be first a call to the parent method.

Parameters
subModulesDataData used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionApfel.

◆ resolveObjectDependencies()

void PARTONS::GPDEvolutionModule::resolveObjectDependencies ( )
virtual

Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others.

To avoid the problem of pointer resolution order, this method is called by the BaseObjectRegistery after all objects are well registered in it. See BaseObjectRegistry class documentation for more details.

Reimplemented from PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionVinnikov, and PARTONS::GPDEvolutionApfel.

◆ setActiveFlavorsModule()

void PARTONS::GPDEvolutionModule::setActiveFlavorsModule ( ActiveFlavorsThresholdsModule activeFlavorsModule)

◆ setGPDType()

void PARTONS::GPDEvolutionModule::setGPDType ( GPDType::Type  type)

◆ setKinematics()

void PARTONS::GPDEvolutionModule::setKinematics ( const GPDKinematic kinematic)
protectedvirtual

◆ setMuF2_ref()

void PARTONS::GPDEvolutionModule::setMuF2_ref ( const double &  MuF2_ref)

◆ setPertOrder()

void PARTONS::GPDEvolutionModule::setPertOrder ( const PerturbativeQCDOrderType::Type pertOrder)

◆ setRunningAlphaStrongModule()

void PARTONS::GPDEvolutionModule::setRunningAlphaStrongModule ( RunningAlphaStrongModule runningAlphaStrongModule)

◆ toString()

std::string PARTONS::GPDEvolutionModule::toString ( ) const
virtual

Return a pre-formatted characters string for output visualization of class member's values.

Returns
a pre-formatted characters string.

Reimplemented from PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDEvolutionApfel.

Member Data Documentation

◆ GPD_EVOLUTION_MODULE_CLASS_NAME

const std::string PARTONS::GPDEvolutionModule::GPD_EVOLUTION_MODULE_CLASS_NAME
static
Initial value:
=
"GPDEvolutionModule"

Type of module name used by the automatization.

◆ m_MuF2

double PARTONS::GPDEvolutionModule::m_MuF2
protected

Factorization scale squared (in \(GeV^{2}\)).

◆ m_MuF2_ref

double PARTONS::GPDEvolutionModule::m_MuF2_ref
protected

Attributes.

Reference factorization scale squared (in \(GeV^{2}\)).

◆ m_MuR2

double PARTONS::GPDEvolutionModule::m_MuR2
protected

Renormalization scale squared (in \(GeV^{2}\)).

◆ m_pActiveFlavorsModule

ActiveFlavorsThresholdsModule* PARTONS::GPDEvolutionModule::m_pActiveFlavorsModule
protected

Pointer to ActiveFlavorsThresholdsModule object being used.

◆ m_pertOrder

PerturbativeQCDOrderType::Type PARTONS::GPDEvolutionModule::m_pertOrder
protected

pQCD order assumed in the calculation.

◆ m_pRunningAlphaStrongModule

RunningAlphaStrongModule* PARTONS::GPDEvolutionModule::m_pRunningAlphaStrongModule
protected

Pointer to RunningAlphaStrongModule object being used.

◆ m_t

double PARTONS::GPDEvolutionModule::m_t
protected

Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).

◆ m_type

GPDType::Type PARTONS::GPDEvolutionModule::m_type
protected

GPD distribution type.

◆ m_x

double PARTONS::GPDEvolutionModule::m_x
protected

Kinematics.

Longitudinal momentum

◆ m_xi

double PARTONS::GPDEvolutionModule::m_xi
protected

Skewness variable.


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