PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
PARTONS::CollinearDistributionEvolutionApfel Class Reference
Inheritance diagram for PARTONS::CollinearDistributionEvolutionApfel:
PARTONS::CollinearDistributionEvolutionModule PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 CollinearDistributionEvolutionApfel (const std::string &className)
 Constructor. More...
 
virtual ~CollinearDistributionEvolutionApfel ()
 Destructor. More...
 
virtual CollinearDistributionEvolutionApfelclone () const
 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...
 
void setSubgridNodes (const std::vector< int > &subgridNodes)
 
void setSubgridLowerBounds (const std::vector< double > &subgridLowerBounds)
 
void setSubgridInterDegrees (const std::vector< int > &subgridInterDegrees)
 
std::vector< int > getSubgridNodes () const
 
std::vector< double > getSubgridLowerBounds () const
 
std::vector< int > getSubgridInterDegrees () const
 
virtual void setRunningAlphaStrongModule (RunningAlphaStrongModule *runningAlphaStrongModule)
 
- Public Member Functions inherited from PARTONS::CollinearDistributionEvolutionModule
 CollinearDistributionEvolutionModule (const std::string &className)
 Constructor. More...
 
virtual ~CollinearDistributionEvolutionModule ()
 Destructor. More...
 
PartonDistribution compute (const CollinearDistributionKinematic &kinematic, CollinearDistributionModule *pCollinearDistributionModule)
 Evaluate PartonDistribution. More...
 
void setPertOrder (const PerturbativeQCDOrderType::Type &pertOrder)
 
void setCollinearDistributionType (CollinearDistributionType::Type type)
 
void setRunningAlphaStrongModule (RunningAlphaStrongModule *runningAlphaStrongModule)
 
void setActiveFlavorsModule (ActiveFlavorsThresholdsModule *activeFlavorsModule)
 
PerturbativeQCDOrderType::Type getPertOrder () const
 
CollinearDistributionType::Type getCollinearDistributionType () 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 PARAM_NAME_SUBGRID_NODES
 Settable parameters. More...
 
static const std::string PARAM_NAME_SUBGRID_LOWER_BOUNDS
 
static const std::string PARAM_NAME_SUBGRID_INTER_DEGREES
 
static const unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::CollinearDistributionEvolutionModule
static const std::string COLLINEAR_DISTRIBUTION_EVOLUTION_MODULE_CLASS_NAME = "CollinearDistributionEvolutionModule"
 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

 CollinearDistributionEvolutionApfel (const CollinearDistributionEvolutionApfel &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 PartonDistribution compute (CollinearDistributionModule *pCollinearDistributionModule)
 
std::function< std::map< int, double >double const &, double const &)> initialScaleDistributions (CollinearDistributionModule *pCollinearDistributionModule)
 
- Protected Member Functions inherited from PARTONS::CollinearDistributionEvolutionModule
 CollinearDistributionEvolutionModule (const CollinearDistributionEvolutionModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const CollinearDistributionKinematic &kinematic)
 
virtual CollinearDistributionKinematic getKinematics () const
 
- 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...
 

Private Attributes

std::vector< int > m_subgridNodes
 
std::vector< double > m_subgridLowerBounds
 
std::vector< int > m_subgridInterDegrees
 
std::shared_ptr< apfel::Grid > m_grid
 
std::map< int, apfel::DglapObjects > m_dglapobj
 
bool m_setApfelTables
 Switch used to generate Apfel tables. More...
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::CollinearDistributionEvolutionModule
PerturbativeQCDOrderType::Type m_pertOrder
 Attributes. More...
 
CollinearDistributionType::Type m_type
 collinear 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_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...
 

Constructor & Destructor Documentation

◆ CollinearDistributionEvolutionApfel() [1/2]

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

Constructor.

Parameters
classNameName of class.

◆ ~CollinearDistributionEvolutionApfel()

PARTONS::CollinearDistributionEvolutionApfel::~CollinearDistributionEvolutionApfel ( )
virtual

Destructor.

◆ CollinearDistributionEvolutionApfel() [2/2]

PARTONS::CollinearDistributionEvolutionApfel::CollinearDistributionEvolutionApfel ( const CollinearDistributionEvolutionApfel other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

CollinearDistributionEvolutionApfel * PARTONS::CollinearDistributionEvolutionApfel::clone ( ) const
virtual

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

Returns

Implements PARTONS::CollinearDistributionEvolutionModule.

◆ compute()

PartonDistribution PARTONS::CollinearDistributionEvolutionApfel::compute ( CollinearDistributionModule pCollinearDistributionModule)
protectedvirtual

◆ configure()

void PARTONS::CollinearDistributionEvolutionApfel::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::CollinearDistributionEvolutionModule.

◆ getSubgridInterDegrees()

std::vector< int > PARTONS::CollinearDistributionEvolutionApfel::getSubgridInterDegrees ( ) const

◆ getSubgridLowerBounds()

std::vector< double > PARTONS::CollinearDistributionEvolutionApfel::getSubgridLowerBounds ( ) const

◆ getSubgridNodes()

std::vector< int > PARTONS::CollinearDistributionEvolutionApfel::getSubgridNodes ( ) const

◆ initialScaleDistributions()

std::function< std::map< int, double >double const &, double const &)> PARTONS::CollinearDistributionEvolutionApfel::initialScaleDistributions ( CollinearDistributionModule pCollinearDistributionModule)
protected

◆ initModule()

void PARTONS::CollinearDistributionEvolutionApfel::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::CollinearDistributionEvolutionModule.

◆ isModuleWellConfigured()

void PARTONS::CollinearDistributionEvolutionApfel::isModuleWellConfigured ( )
protectedvirtual

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

Children must define and override it.

Reimplemented from PARTONS::CollinearDistributionEvolutionModule.

◆ prepareSubModules()

void PARTONS::CollinearDistributionEvolutionApfel::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::CollinearDistributionEvolutionModule.

◆ resolveObjectDependencies()

void PARTONS::CollinearDistributionEvolutionApfel::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::CollinearDistributionEvolutionModule.

◆ setRunningAlphaStrongModule()

void PARTONS::CollinearDistributionEvolutionApfel::setRunningAlphaStrongModule ( RunningAlphaStrongModule runningAlphaStrongModule)
virtual

◆ setSubgridInterDegrees()

void PARTONS::CollinearDistributionEvolutionApfel::setSubgridInterDegrees ( const std::vector< int > &  subgridInterDegrees)

◆ setSubgridLowerBounds()

void PARTONS::CollinearDistributionEvolutionApfel::setSubgridLowerBounds ( const std::vector< double > &  subgridLowerBounds)

◆ setSubgridNodes()

void PARTONS::CollinearDistributionEvolutionApfel::setSubgridNodes ( const std::vector< int > &  subgridNodes)

◆ toString()

std::string PARTONS::CollinearDistributionEvolutionApfel::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::CollinearDistributionEvolutionModule.

Member Data Documentation

◆ classId

const unsigned int PARTONS::CollinearDistributionEvolutionApfel::classId
static
Initial value:
=
"CollinearDistributionEvolutionApfel"))
unsigned int registerBaseObject(BaseObject *pBaseObject)
Store a unique instance of a module identified by a unique string character key.
Definition: BaseObjectRegistry.cpp:45
static BaseObjectRegistry * getInstance()
Static function to be able to retrieve a unique instance pointer of this class anywhere in the code.
Definition: BaseObjectRegistry.cpp:15
CollinearDistributionEvolutionApfel(const std::string &className)
Constructor.
Definition: CollinearDistributionEvolutionApfel.cpp:20

Unique ID to automatically register the class in the registry.

◆ m_dglapobj

std::map<int, apfel::DglapObjects> PARTONS::CollinearDistributionEvolutionApfel::m_dglapobj
private

◆ m_grid

std::shared_ptr<apfel::Grid> PARTONS::CollinearDistributionEvolutionApfel::m_grid
private

◆ m_setApfelTables

bool PARTONS::CollinearDistributionEvolutionApfel::m_setApfelTables
private

Switch used to generate Apfel tables.

◆ m_subgridInterDegrees

std::vector<int> PARTONS::CollinearDistributionEvolutionApfel::m_subgridInterDegrees
private

◆ m_subgridLowerBounds

std::vector<double> PARTONS::CollinearDistributionEvolutionApfel::m_subgridLowerBounds
private

◆ m_subgridNodes

std::vector<int> PARTONS::CollinearDistributionEvolutionApfel::m_subgridNodes
private

◆ PARAM_NAME_SUBGRID_INTER_DEGREES

const std::string PARTONS::CollinearDistributionEvolutionApfel::PARAM_NAME_SUBGRID_INTER_DEGREES
static
Initial value:
=
"subgridInterDegrees"

◆ PARAM_NAME_SUBGRID_LOWER_BOUNDS

const std::string PARTONS::CollinearDistributionEvolutionApfel::PARAM_NAME_SUBGRID_LOWER_BOUNDS
static
Initial value:
=
"subgridLowerBounds"

◆ PARAM_NAME_SUBGRID_NODES

const std::string PARTONS::CollinearDistributionEvolutionApfel::PARAM_NAME_SUBGRID_NODES
static
Initial value:
=
"subgridNodes"

Settable parameters.


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