Abstract class for modeling of GPD subtraction constant. More...

Inheritance diagram for PARTONS::GPDSubtractionConstantModule:

Public Member Functions
	GPDSubtractionConstantModule (const std::string &className)
	Constructor. More...

virtual	~GPDSubtractionConstantModule ()
	Destructor. More...

virtual GPDSubtractionConstantModule *	clone () 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...

virtual GPDSubtractionConstantResult	compute (const GPDSubtractionConstantKinematic &kinematic, GPDType::Type gpdType)
	Evaluate specific GPD subtraction constant for a given kinematics. More...

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_SUBTRACTION_CONSTANT_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
	GPDSubtractionConstantModule (const GPDSubtractionConstantModule &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 PhysicalType< double >	computeSubtractionConstant ()
	Evaluate specific GPD subtraction constant (user defined part). More...

virtual void	setKinematics (const GPDSubtractionConstantKinematic &kinematic)
	Set internal kinematics. More...

void	setCurrentGPDType (GPDType::Type gpdType)
	Set current GPD type to be computed. 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
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...

Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactory *	m_pModuleObjectFactory
	Pointer tp module object factory. More...

Detailed Description

Abstract class for modeling of GPD subtraction constant.

Constructor & Destructor Documentation

◆ GPDSubtractionConstantModule() [1/2]

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

Constructor.

Parameters

className Name of class.

◆ ~GPDSubtractionConstantModule()

PARTONS::GPDSubtractionConstantModule::~GPDSubtractionConstantModule ( )

virtual

Destructor.

◆ GPDSubtractionConstantModule() [2/2]

PARTONS::GPDSubtractionConstantModule::GPDSubtractionConstantModule ( const GPDSubtractionConstantModule & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ clone()

GPDSubtractionConstantModule * PARTONS::GPDSubtractionConstantModule::clone ( ) const

virtual

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

Returns

Implements PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDSubtractionConstantKM10, and PARTONS::GPDSubtractionConstantDLMSTW21.

◆ compute()

GPDSubtractionConstantResult PARTONS::GPDSubtractionConstantModule::compute	(	const GPDSubtractionConstantKinematic &	kinematic,
		GPDType::Type	gpdType
	)

virtual

Evaluate specific GPD subtraction constant for a given kinematics.

Parameters

kinematic	GPD kinematics
gpdType	GPD type

◆ computeSubtractionConstant()

PhysicalType< double > PARTONS::GPDSubtractionConstantModule::computeSubtractionConstant ( )

protectedvirtual

Evaluate specific GPD subtraction constant (user defined part).

Reimplemented in PARTONS::GPDSubtractionConstantKM10, and PARTONS::GPDSubtractionConstantDLMSTW21.

◆ configure()

void PARTONS::GPDSubtractionConstantModule::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

parameters ElemUtils::Parameters object.

Reimplemented from PARTONS::ModuleObject.

Reimplemented in PARTONS::GPDSubtractionConstantDLMSTW21.

◆ initModule()

void PARTONS::GPDSubtractionConstantModule::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Implements PARTONS::ModuleObject.

◆ isModuleWellConfigured()

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

◆ prepareSubModules()

void PARTONS::GPDSubtractionConstantModule::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

subModulesData Data used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::ModuleObject.

◆ resolveObjectDependencies()

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

◆ setCurrentGPDType()

void PARTONS::GPDSubtractionConstantModule::setCurrentGPDType ( GPDType::Type gpdType )

protected

Set current GPD type to be computed.

◆ setKinematics()

void PARTONS::GPDSubtractionConstantModule::setKinematics ( const GPDSubtractionConstantKinematic & kinematic )

protectedvirtual

Set internal kinematics.

Parameters

kinematic Kinematics to be set.

◆ toString()

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

Member Data Documentation

◆ GPD_SUBTRACTION_CONSTANT_MODULE_CLASS_NAME

const std::string PARTONS::GPDSubtractionConstantModule::GPD_SUBTRACTION_CONSTANT_MODULE_CLASS_NAME

static

Initial value:

=

"GPDSubtractionConstantModule"

Type of module name used by the automatization.

◆ m_currentGPDComputeType

GPDType::Type PARTONS::GPDSubtractionConstantModule::m_currentGPDComputeType

protected

Current GPD type.

◆ m_MuF2

double PARTONS::GPDSubtractionConstantModule::m_MuF2

protected

Factorization scale squared.

◆ m_MuR2

double PARTONS::GPDSubtractionConstantModule::m_MuR2

protected

Renormalization scale squared.

◆ m_t

double PARTONS::GPDSubtractionConstantModule::m_t

protected

Mandelstam variable, momentum transfer on the hadron target.

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

include/partons/modules/gpd_subtraction_constant/GPDSubtractionConstantModule.h
src/partons/modules/gpd_subtraction_constant/GPDSubtractionConstantModule.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GPDSubtractionConstantModule() [1/2]

◆ ~GPDSubtractionConstantModule()

◆ GPDSubtractionConstantModule() [2/2]

Member Function Documentation

◆ clone()

◆ compute()

◆ computeSubtractionConstant()

◆ configure()

◆ initModule()

◆ isModuleWellConfigured()

◆ prepareSubModules()

◆ resolveObjectDependencies()

◆ setCurrentGPDType()

◆ setKinematics()

◆ toString()

Member Data Documentation

◆ GPD_SUBTRACTION_CONSTANT_MODULE_CLASS_NAME

◆ m_currentGPDComputeType

◆ m_MuF2

◆ m_MuR2

◆ m_t