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

This model allows to select a single parton type. More...

Inheritance diagram for PARTONS::GPDSelectOnePartonType:
PARTONS::GPDModule PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 GPDSelectOnePartonType (const std::string &className)
 Constructor. More...
 
virtual ~GPDSelectOnePartonType ()
 Default destructor. More...
 
virtual GPDSelectOnePartonTypeclone () 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 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...
 
const GPDModulegetGPDModule () const
 Set underlying GPD module. More...
 
void setGPDModule (GPDModule *pGPDModule)
 Get underlying GPD module. More...
 
const std::string & getPartonType () const
 Get parton type. More...
 
void setPartonType (const std::string &partonType)
 Set parton type. More...
 
- Public Member Functions inherited from PARTONS::GPDModule
virtual ~GPDModule ()
 Destructor. 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 run ()
 
virtual PartonDistribution compute (const GPDKinematic &kinematic, GPDType::Type gpdType)
 Virtual method, computes GPD with some input parameters. More...
 
virtual GPDResult compute (const GPDKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Virtual method, computes GPD with some input parameters. More...
 
List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Get list of available GPDTypes in the model considered. More...
 
virtual PartonDistribution computeE ()
 This method can be implemented in the child class if the GPD E is available to compute. More...
 
virtual PartonDistribution computeHt ()
 This method can be implemented in the child class if the GPD Ht is available to compute. More...
 
virtual PartonDistribution computeEt ()
 This method can be implemented in the child class if the GPD Et is available to compute. More...
 
virtual PartonDistribution computeHTrans ()
 This method can be implemented in the child class if the GPD HTrans is available to compute. More...
 
virtual PartonDistribution computeETrans ()
 This method can be implemented in the child class if the GPD ETrans is available to compute. More...
 
virtual PartonDistribution computeHtTrans ()
 This method can be implemented in the child class if the GPD HtTrans is available to compute. More...
 
virtual PartonDistribution computeEtTrans ()
 This method can be implemented in the child class if the GPD EtTrans is available to compute. More...
 
virtual PartonDistribution computeH3p ()
 This method can be implemented in the child class if the GPD H3p is available to compute. More...
 
virtual PartonDistribution computeE3p ()
 This method can be implemented in the child class if the GPD E3p is available to compute. More...
 
virtual PartonDistribution computeHt3p ()
 This method can be implemented in the child class if the GPD Ht3p is available to compute. More...
 
virtual PartonDistribution computeEt3p ()
 This method can be implemented in the child class if the GPD Et3p is available to compute. More...
 
virtual PartonDistribution computeH3m ()
 This method can be implemented in the child class if the GPD H3m is available to compute. More...
 
virtual PartonDistribution computeE3m ()
 This method can be implemented in the child class if the GPD E3m is available to compute. More...
 
virtual PartonDistribution computeHt3m ()
 This method can be implemented in the child class if the GPD Ht3m is available to compute. More...
 
virtual PartonDistribution computeEt3m ()
 This method can be implemented in the child class if the GPD Et3m is available to compute. More...
 
virtual PartonDistribution computeEbarTrans ()
 This method can be implemented in the child class if the GPD EbarTrans is available to compute. More...
 
double getMuF2Ref () const
 Get reference factorization scale used by the GPD model before evolution. More...
 
const GPDEvolutionModulegetEvolQcdModule () const
 Set underlying GPD Evolution module. More...
 
void setEvolQcdModule (GPDEvolutionModule *pEvolQcdModule)
 Get underlying GPD Evolution module. More...
 
const CollinearDistributionModulegetPDFModule () const
 Set underlying PDF module. More...
 
void setPDFModule (CollinearDistributionModule *pPDFModule)
 Get underlying PDF 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 PARAMETER_NAME_SELECTONEPARTONTYPE_PARTONTYPE
 Name of parameter to set parton type via configure() More...
 
static const unsigned int classId
 ID assigned by BaseObjectRegistry. More...
 
- Static Public Attributes inherited from PARTONS::GPDModule
static const std::string GPD_MODULE_CLASS_NAME = "GPDModule"
 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

 GPDSelectOnePartonType (const GPDSelectOnePartonType &other)
 Copy constructor. More...
 
virtual PartonDistribution computeH ()
 This method can be implemented in the child class if the GPD H is available to compute. More...
 
- Protected Member Functions inherited from PARTONS::GPDModule
 GPDModule (const std::string &className)
 Default constructor. More...
 
 GPDModule (const GPDModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const GPDKinematic &kinematic)
 Set internal kinematics. More...
 
void setCurrentGPDType (GPDType::Type gpdType)
 Set current GPD type to be computed. 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...
 
- 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

GPDModulem_pGPDModule
 GPD module. More...
 
std::string m_partonType
 Parton type. More...
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::GPDModule
std::map< GPDType::Type, PartonDistribution(GPDModule::*)()> m_listGPDComputeTypeAvailable
 List of GPD types that can be computed by the child class. More...
 
std::map< GPDType::Type, PartonDistribution(GPDModule::*)()>::iterator m_it
 Iterator. More...
 
double m_x
 Longitudinal momentum fraction of the active parton. More...
 
double m_xi
 Skewness. More...
 
double m_t
 Mandelstam variable, momentum transfer on the hadron target. More...
 
double m_MuF2
 Factorization scale squared. More...
 
double m_MuR2
 Renormalization scale squared. More...
 
GPDType::Type m_currentGPDComputeType
 Current GPD type. More...
 
double m_MuF2_ref
 Reference factorization scale used by the GPD model before evolution. More...
 
GPDEvolutionModulem_pGPDEvolutionModule
 Pointer to the underlying GPD Evolution module. More...
 
CollinearDistributionModulem_pCollinearDistributionModule
 Pointer to the underlying PDF module. More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

This model allows to select a single parton type.

Constructor & Destructor Documentation

◆ GPDSelectOnePartonType() [1/2]

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

Constructor.

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

Parameters
classNamename of child class.

◆ ~GPDSelectOnePartonType()

PARTONS::GPDSelectOnePartonType::~GPDSelectOnePartonType ( )
virtual

Default destructor.

◆ GPDSelectOnePartonType() [2/2]

PARTONS::GPDSelectOnePartonType::GPDSelectOnePartonType ( const GPDSelectOnePartonType other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

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

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

Returns

Implements PARTONS::GPDModule.

◆ computeH()

PartonDistribution PARTONS::GPDSelectOnePartonType::computeH ( )
protectedvirtual

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

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

Reimplemented from PARTONS::GPDModule.

◆ configure()

void PARTONS::GPDSelectOnePartonType::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::GPDModule.

◆ getGPDModule()

const GPDModule * PARTONS::GPDSelectOnePartonType::getGPDModule ( ) const

Set underlying GPD module.

◆ getPartonType()

const std::string & PARTONS::GPDSelectOnePartonType::getPartonType ( ) const

Get parton type.

◆ prepareSubModules()

void PARTONS::GPDSelectOnePartonType::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::GPDModule.

◆ setGPDModule()

void PARTONS::GPDSelectOnePartonType::setGPDModule ( GPDModule pGPDModule)

Get underlying GPD module.

◆ setPartonType()

void PARTONS::GPDSelectOnePartonType::setPartonType ( const std::string &  partonType)

Set parton type.

Member Data Documentation

◆ classId

const unsigned int PARTONS::GPDSelectOnePartonType::classId
static
Initial value:
=
new GPDSelectOnePartonType("GPDSelectOnePartonType"))
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
GPDSelectOnePartonType(const std::string &className)
Constructor.
Definition: GPDSelectOnePartonType.cpp:28

ID assigned by BaseObjectRegistry.

◆ m_partonType

std::string PARTONS::GPDSelectOnePartonType::m_partonType
private

Parton type.

◆ m_pGPDModule

GPDModule* PARTONS::GPDSelectOnePartonType::m_pGPDModule
private

GPD module.

◆ PARAMETER_NAME_SELECTONEPARTONTYPE_PARTONTYPE

const std::string PARTONS::GPDSelectOnePartonType::PARAMETER_NAME_SELECTONEPARTONTYPE_PARTONTYPE
static
Initial value:
=
"parton_type"

Name of parameter to set parton type via configure()


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