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

A module that encapsulates a set provided through the LHAPDF interface. More...

Inheritance diagram for PARTONS::CollinearDistributionLHAPDF:
PARTONS::CollinearDistributionModule PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 CollinearDistributionLHAPDF (const std::string &className)
 Constructor. More...
 
virtual ~CollinearDistributionLHAPDF ()
 Default destructor. More...
 
virtual CollinearDistributionLHAPDFclone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. 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 std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
std::string getSetName () const
 
int getMember () const
 
CollinearDistributionType::Type getType () const
 
std::vector< LHAPDF::PDF * > getSet () const
 
void setSetName (const std::string &setname)
 
void setMember (const int &member)
 
void setType (const CollinearDistributionType::Type &type)
 
- Public Member Functions inherited from PARTONS::CollinearDistributionModule
virtual ~CollinearDistributionModule ()
 Destructor. 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 run ()
 
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...
 
virtual PartonDistribution compute (const CollinearDistributionKinematic &kinematic, CollinearDistributionType::Type colldistType)
 Virtual method, computes collinear distribution with some input parameters. More...
 
virtual CollinearDistributionResult compute (const CollinearDistributionKinematic &kinematic, const List< CollinearDistributionType > &colldistType=List< CollinearDistributionType >())
 Virtual method, computes collinear distribution with some input parameters. More...
 
List< CollinearDistributionTypegetListOfAvailableCollinearDistributionTypeForComputation () const
 Get list of available CollinearDistributionTypes in the model considered. More...
 
virtual PartonDistribution computeTransPDF ()
 
virtual PartonDistribution computeTransFF ()
 
double getMuF2Ref () const
 Get reference factorization scale used by the collinear distribution model before evolution. More...
 
const CollinearDistributionEvolutionModulegetEvolQcdModule () const
 Set underlying collinear distribution Evolution module. More...
 
void setEvolQcdModule (CollinearDistributionEvolutionModule *pEvolQcdModule)
 Get underlying collinear distribution Evolution module. More...
 
- Public Member Functions inherited from PARTONS::ModuleObject
 ModuleObject (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
virtual ~ModuleObject ()
 Default destructor. More...
 
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_SET_NAME = "setName"
 
static const std::string PARAM_NAME_SET_TYPE = "setType"
 
static const std::string PARAM_NAME_SET_MEMBER = "setMember"
 
static const unsigned int classId = BaseObjectRegistry::getInstance()->registerBaseObject(new CollinearDistributionLHAPDF("CollinearDistributionLHAPDF"))
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::CollinearDistributionModule
static const std::string COLLINEAR_DISTRIBUTION_MODULE_CLASS_NAME = "CollinearDistributionModule"
 Type of the module in XML automation. More...
 
- Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string CLASS_NAME = "className"
 

Protected Member Functions

 CollinearDistributionLHAPDF (const CollinearDistributionLHAPDF &other)
 Copy constructor. More...
 
virtual void isModuleWellConfigured ()
 Pure virtual function that provides skeleton to check if the module is well initialized and configured. More...
 
virtual void initModule ()
 Pure virtual function that provides skeleton for module initialization. More...
 
virtual PartonDistribution computeUnpolPDF ()
 This method can be implemented in the child class if the collinear distribution H is available to compute. More...
 
virtual PartonDistribution computePolPDF ()
 
virtual PartonDistribution computeUnpolFF ()
 
virtual PartonDistribution computePolFF ()
 
- Protected Member Functions inherited from PARTONS::CollinearDistributionModule
 CollinearDistributionModule (const std::string &className)
 Default constructor. More...
 
 CollinearDistributionModule (const CollinearDistributionModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const CollinearDistributionKinematic &kinematic)
 Set internal kinematics. More...
 
- 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

std::string m_setName
 
int m_member
 
CollinearDistributionType::Type m_type
 
std::vector< LHAPDF::PDF * > m_set
 
- Protected Attributes inherited from PARTONS::CollinearDistributionModule
std::map< CollinearDistributionType::Type, PartonDistribution(CollinearDistributionModule::*)()> m_listCollinearDistributionComputeTypeAvailable
 List of collinear distribution types that can be computed by the child class. More...
 
double m_x
 Longitudinal momentum fraction of the active parton. More...
 
double m_MuF2
 Factorization scale squared. More...
 
double m_MuR2
 Renormalization scale squared. More...
 
double m_MuF2_ref
 Reference factorization scale used by the collinear model before evolution. More...
 
CollinearDistributionEvolutionModulem_pCollinearDistributionEvolutionModule
 Pointer to the underlying collinear distribution Evolution module. More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

A module that encapsulates a set provided through the LHAPDF interface.

Constructor & Destructor Documentation

◆ CollinearDistributionLHAPDF() [1/2]

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

Constructor.

See BaseObject::BaseObject and ModuleObject::ModuleObject for more details.

Parameters
classNamename of child class.

◆ ~CollinearDistributionLHAPDF()

PARTONS::CollinearDistributionLHAPDF::~CollinearDistributionLHAPDF ( )
virtual

Default destructor.

◆ CollinearDistributionLHAPDF() [2/2]

PARTONS::CollinearDistributionLHAPDF::CollinearDistributionLHAPDF ( const CollinearDistributionLHAPDF other)
protected

Copy constructor.

Used by the factory.

Parameters
other

Member Function Documentation

◆ clone()

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

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

Returns

Implements PARTONS::CollinearDistributionModule.

◆ computePolFF()

PartonDistribution PARTONS::CollinearDistributionLHAPDF::computePolFF ( )
protectedvirtual

◆ computePolPDF()

PartonDistribution PARTONS::CollinearDistributionLHAPDF::computePolPDF ( )
protectedvirtual

◆ computeUnpolFF()

PartonDistribution PARTONS::CollinearDistributionLHAPDF::computeUnpolFF ( )
protectedvirtual

◆ computeUnpolPDF()

PartonDistribution PARTONS::CollinearDistributionLHAPDF::computeUnpolPDF ( )
protectedvirtual

This method can be implemented in the child class if the collinear distribution H is available to compute.

Returns
PartonDistribution object. Contains results for each flavor of partons.

Reimplemented from PARTONS::CollinearDistributionModule.

◆ configure()

void PARTONS::CollinearDistributionLHAPDF::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::CollinearDistributionModule.

◆ getMember()

int PARTONS::CollinearDistributionLHAPDF::getMember ( ) const

◆ getSet()

std::vector< LHAPDF::PDF * > PARTONS::CollinearDistributionLHAPDF::getSet ( ) const

◆ getSetName()

std::string PARTONS::CollinearDistributionLHAPDF::getSetName ( ) const

◆ getType()

CollinearDistributionType::Type PARTONS::CollinearDistributionLHAPDF::getType ( ) const

◆ initModule()

void PARTONS::CollinearDistributionLHAPDF::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::CollinearDistributionModule.

◆ isModuleWellConfigured()

void PARTONS::CollinearDistributionLHAPDF::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::CollinearDistributionModule.

◆ setMember()

void PARTONS::CollinearDistributionLHAPDF::setMember ( const int &  member)

◆ setSetName()

void PARTONS::CollinearDistributionLHAPDF::setSetName ( const std::string &  setname)

◆ setType()

void PARTONS::CollinearDistributionLHAPDF::setType ( const CollinearDistributionType::Type type)

◆ toString()

std::string PARTONS::CollinearDistributionLHAPDF::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::CollinearDistributionModule.

Member Data Documentation

◆ classId

const unsigned int PARTONS::CollinearDistributionLHAPDF::classId = BaseObjectRegistry::getInstance()->registerBaseObject(new CollinearDistributionLHAPDF("CollinearDistributionLHAPDF"))
static

Unique ID to automatically register the class in the registry.

◆ m_member

int PARTONS::CollinearDistributionLHAPDF::m_member
protected

◆ m_set

std::vector<LHAPDF::PDF*> PARTONS::CollinearDistributionLHAPDF::m_set
protected

◆ m_setName

std::string PARTONS::CollinearDistributionLHAPDF::m_setName
protected

◆ m_type

CollinearDistributionType::Type PARTONS::CollinearDistributionLHAPDF::m_type
protected

◆ PARAM_NAME_SET_MEMBER

const std::string PARTONS::CollinearDistributionLHAPDF::PARAM_NAME_SET_MEMBER = "setMember"
static

◆ PARAM_NAME_SET_NAME

const std::string PARTONS::CollinearDistributionLHAPDF::PARAM_NAME_SET_NAME = "setName"
static

◆ PARAM_NAME_SET_TYPE

const std::string PARTONS::CollinearDistributionLHAPDF::PARAM_NAME_SET_TYPE = "setType"
static

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