This module calculates TCS Compton Form Factors using DVCS CFFs. More...

Inheritance diagram for PARTONS::TCSCFFFromDVCS:

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

virtual TCSCFFFromDVCS *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...

virtual	~TCSCFFFromDVCS ()
	Default 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	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	setDVCSConvolCoeffFunctionModule (DVCSConvolCoeffFunctionModule *pDVCSConvolCoeffFunctionModule)
	Set DVCSConvolCoeffFunctionModule. More...

DVCSConvolCoeffFunctionModule *	getDVCSConvolCoeffFunctionModule () const
	Get DVCSConvolCoeffFunctionModule. More...

Public Member Functions inherited from PARTONS::TCSConvolCoeffFunctionModule
virtual	~TCSConvolCoeffFunctionModule ()
	Destructor. More...

virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...

virtual void	run ()

virtual void	configure (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of modules by passing a Parameters object. More...

virtual TCSConvolCoeffFunctionResult	compute (const TCSConvolCoeffFunctionKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Computes the coefficient functions at given kinematics. More...

virtual List< GPDType >	getListOfAvailableGPDTypeForComputation () const
	Must be implemented in child class. More...

PerturbativeQCDOrderType::Type	getQCDOrderType () const
	Get order of the perturbative QCD computation. More...

void	setQCDOrderType (PerturbativeQCDOrderType::Type qcdOrderType)
	Set order of the perturbative QCD computation. More...

virtual std::complex< double >	computeCFF ()
	Method to compute some CFFs. More...

Public Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
virtual	~ConvolCoeffFunctionModule ()
	Destructor. More...

GPDModule *	getGPDModule () const
	Get pointer to the underlying GPD module. More...

void	setGPDModule (GPDModule *gpdModule)
	Set pointer to the underlying GPD module. More...

bool	isGPDModuleDependent () const
	True if this CCF module depends on a GPD module. More...

void	setIsGPDModuleDependent (bool isGPDModuleDependent)
	True if this CCF module depends on a GPD 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)

Public Member Functions inherited from PARTONS::MathIntegratorModule
	MathIntegratorModule ()
	Default constructor. More...

virtual	~MathIntegratorModule ()
	Default destructor. More...

Static Public Attributes
static const unsigned int	classId
	Unique ID to automatically register the class in the registry. More...

Static Public Attributes inherited from PARTONS::TCSConvolCoeffFunctionModule
static const std::string	TCS_CONVOL_COEFF_FUNCTION_MODULE_CLASS_NAME
	Type of the module in XML automation. More...

Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string	CLASS_NAME = "className"

Static Public Attributes inherited from PARTONS::MathIntegratorModule
static const std::string	PARAM_NAME_INTEGRATOR_TYPE
	Parameter used in configureIntegrator() or XML automation to set the type of integrator. More...

Protected Member Functions
	TCSCFFFromDVCS (const TCSCFFFromDVCS &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 std::complex< double >	computeUnpolarized ()
	Method to compute some CFFs. More...

virtual std::complex< double >	computePolarized ()
	Method to compute some CFFs. More...

Protected Member Functions inherited from PARTONS::TCSConvolCoeffFunctionModule
	TCSConvolCoeffFunctionModule (const std::string &className)
	Default constructor. More...

	TCSConvolCoeffFunctionModule (const TCSConvolCoeffFunctionModule &other)
	Copy constructor. More...

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

Protected Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
	ConvolCoeffFunctionModule (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

	ConvolCoeffFunctionModule (const ConvolCoeffFunctionModule &other)
	Copy constructor. 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 Member Functions inherited from PARTONS::MathIntegratorModule
	MathIntegratorModule (const MathIntegratorModule &other)
	Copy constructor. More...

void	setIntegrator (NumA::IntegratorType1D::Type integratorType)
	Sets a given integrator available in NumA++. More...

double	integrate (NumA::FunctionType1D *pFunction, double a, double b, std::vector< double > &parameters)
	Computes the integral of a function defined via a functor. More...

void	configureIntegrator (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of integration routines by passing a Parameters object. More...

NumA::Integrator1D *	getMathIntegrator ()

Private Attributes
DVCSConvolCoeffFunctionModule *	m_pDVCSConvolCoeffFunctionModule
	Pointer to DVCSConvolCoeffFunctionModule to be used. More...

Additional Inherited Members
Protected Attributes inherited from PARTONS::ConvolCoeffFunctionModule< TCSConvolCoeffFunctionKinematic, TCSConvolCoeffFunctionResult >
double	m_xi
	Skewness. More...

double	m_t
	Mandelstam variable, momentum transfer on the hadron target (in GeV^2). More...

double	m_MuF2
	Factorization scale (in GeV^2). More...

double	m_MuR2
	Renormalization scale (in GeV^2) More...

GPDType::Type	m_currentGPDComputeType
	GPDType of the current CFF computation. More...

GPDModule *	m_pGPDModule
	Pointer to the underlying GPD module. More...

bool	m_isGPDModuleDependent
	Boolean (true if this CCF module depends on a GPD module). More...

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

Detailed Description

This module calculates TCS Compton Form Factors using DVCS CFFs.

Available CFF types: H, E, Ht, Et.

Constructor & Destructor Documentation

◆ TCSCFFFromDVCS() [1/2]

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

Constructor.

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

Parameters

className Name of last child class.

◆ ~TCSCFFFromDVCS()

PARTONS::TCSCFFFromDVCS::~TCSCFFFromDVCS ( )

virtual

Default destructor.

◆ TCSCFFFromDVCS() [2/2]

PARTONS::TCSCFFFromDVCS::TCSCFFFromDVCS ( const TCSCFFFromDVCS & other )

protected

Copy constructor.

Parameters

other

Member Function Documentation

◆ clone()

TCSCFFFromDVCS * PARTONS::TCSCFFFromDVCS::clone ( ) const

virtual

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

Returns

Implements PARTONS::TCSConvolCoeffFunctionModule.

Reimplemented in PARTONS::TCSCFFFromDVCSOnlyNLOPart.

◆ computePolarized()

std::complex< double > PARTONS::TCSCFFFromDVCS::computePolarized ( )

protectedvirtual

Method to compute some CFFs.

Can be implemented and used in child class, if needed.

Returns: Complex result.

Reimplemented from PARTONS::TCSConvolCoeffFunctionModule.

◆ computeUnpolarized()

std::complex< double > PARTONS::TCSCFFFromDVCS::computeUnpolarized ( )

protectedvirtual

Method to compute some CFFs.

Can be implemented and used in child class, if needed.

Returns: Complex result.

Reimplemented from PARTONS::TCSConvolCoeffFunctionModule.

Reimplemented in PARTONS::TCSCFFFromDVCSOnlyNLOPart.

◆ getDVCSConvolCoeffFunctionModule()

DVCSConvolCoeffFunctionModule * PARTONS::TCSCFFFromDVCS::getDVCSConvolCoeffFunctionModule ( ) const

Get DVCSConvolCoeffFunctionModule.

◆ initModule()

void PARTONS::TCSCFFFromDVCS::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::TCSConvolCoeffFunctionModule.

◆ isModuleWellConfigured()

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

◆ prepareSubModules()

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

◆ resolveObjectDependencies()

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

◆ setDVCSConvolCoeffFunctionModule()

void PARTONS::TCSCFFFromDVCS::setDVCSConvolCoeffFunctionModule ( DVCSConvolCoeffFunctionModule * pDVCSConvolCoeffFunctionModule )

Set DVCSConvolCoeffFunctionModule.

Member Data Documentation

◆ classId

const unsigned int PARTONS::TCSCFFFromDVCS::classId

static

Initial value:

=
        BaseObjectRegistry::getInstance()->registerBaseObject(
                new TCSCFFFromDVCS("TCSCFFFromDVCS"))

Unique ID to automatically register the class in the registry.

◆ m_pDVCSConvolCoeffFunctionModule

DVCSConvolCoeffFunctionModule* PARTONS::TCSCFFFromDVCS::m_pDVCSConvolCoeffFunctionModule

private

Pointer to DVCSConvolCoeffFunctionModule to be used.

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

include/partons/modules/convol_coeff_function/TCS/TCSCFFFromDVCS.h
src/partons/modules/convol_coeff_function/TCS/TCSCFFFromDVCS.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TCSCFFFromDVCS() [1/2]

◆ ~TCSCFFFromDVCS()

◆ TCSCFFFromDVCS() [2/2]

Member Function Documentation

◆ clone()

◆ computePolarized()

◆ computeUnpolarized()

◆ getDVCSConvolCoeffFunctionModule()

◆ initModule()

◆ isModuleWellConfigured()

◆ prepareSubModules()

◆ resolveObjectDependencies()

◆ setDVCSConvolCoeffFunctionModule()

Member Data Documentation

◆ classId

◆ m_pDVCSConvolCoeffFunctionModule