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

Abstract class that provides a skeleton to implement a Compton Form Factor (CFF) module. More...

Inheritance diagram for PARTONS::DDVCSConvolCoeffFunctionModule:
PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult > PARTONS::ModuleObject PARTONS::MathIntegratorModule PARTONS::BaseObject PARTONS::DDVCSCFFStandard

Public Member Functions

virtual ~DDVCSConvolCoeffFunctionModule ()
 Destructor. More...
 
virtual DDVCSConvolCoeffFunctionModuleclone () const =0
 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 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 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 DDVCSConvolCoeffFunctionResult compute (const DDVCSConvolCoeffFunctionKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Computes the coefficient functions at given kinematics. More...
 
virtual List< GPDTypegetListOfAvailableGPDTypeForComputation () 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 > computeUnpolarized ()
 Method to compute some CFFs. More...
 
virtual std::complex< double > computePolarized ()
 Method to compute some CFFs. More...
 
virtual std::complex< double > computeCFF ()
 Method to compute some CFFs. More...
 
- Public Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >
virtual ~ConvolCoeffFunctionModule ()
 Destructor. More...
 
GPDModulegetGPDModule () 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 std::string DDVCS_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

 DDVCSConvolCoeffFunctionModule (const std::string &className)
 Default constructor. More...
 
 DDVCSConvolCoeffFunctionModule (const DDVCSConvolCoeffFunctionModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const DDVCSConvolCoeffFunctionKinematic &kinematic)
 Set internal kinematics. 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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >
 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 ()
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >
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...
 
GPDModulem_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
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

Abstract class that provides a skeleton to implement a Compton Form Factor (CFF) module.

It is best to use this module with the corresponding service: ConvolCoeffFunctionService (see examples therein), as explained in the general tutorial.

Constructor & Destructor Documentation

◆ ~DDVCSConvolCoeffFunctionModule()

PARTONS::DDVCSConvolCoeffFunctionModule::~DDVCSConvolCoeffFunctionModule ( )
virtual

Destructor.

◆ DDVCSConvolCoeffFunctionModule() [1/2]

PARTONS::DDVCSConvolCoeffFunctionModule::DDVCSConvolCoeffFunctionModule ( const std::string &  className)
protected

Default constructor.

◆ DDVCSConvolCoeffFunctionModule() [2/2]

PARTONS::DDVCSConvolCoeffFunctionModule::DDVCSConvolCoeffFunctionModule ( const DDVCSConvolCoeffFunctionModule other)
protected

Copy constructor.

Parameters
otherObject to be copied

Member Function Documentation

◆ clone()

virtual DDVCSConvolCoeffFunctionModule* PARTONS::DDVCSConvolCoeffFunctionModule::clone ( ) const
pure virtual

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

Returns

Implements PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

Implemented in PARTONS::DDVCSCFFStandard.

◆ compute()

DDVCSConvolCoeffFunctionResult PARTONS::DDVCSConvolCoeffFunctionModule::compute ( const DDVCSConvolCoeffFunctionKinematic kinematic,
const List< GPDType > &  gpdType = List<GPDType>() 
)
virtual

Computes the coefficient functions at given kinematics.

Parameters
kinematicKinematics.
gpdTypeType of CCF to compute.
Returns
Complex result.

Implements PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

◆ computeCFF()

std::complex< double > PARTONS::DDVCSConvolCoeffFunctionModule::computeCFF ( )
virtual

Method to compute some CFFs.

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

Returns
Complex result.

◆ computePolarized()

std::complex< double > PARTONS::DDVCSConvolCoeffFunctionModule::computePolarized ( )
virtual

Method to compute some CFFs.

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

Returns
Complex result.

Reimplemented in PARTONS::DDVCSCFFStandard.

◆ computeUnpolarized()

std::complex< double > PARTONS::DDVCSConvolCoeffFunctionModule::computeUnpolarized ( )
virtual

Method to compute some CFFs.

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

Returns
Complex result.

Reimplemented in PARTONS::DDVCSCFFStandard.

◆ configure()

void PARTONS::DDVCSConvolCoeffFunctionModule::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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

◆ getListOfAvailableGPDTypeForComputation()

List< GPDType > PARTONS::DDVCSConvolCoeffFunctionModule::getListOfAvailableGPDTypeForComputation ( ) const
virtual

Must be implemented in child class.

Returns
List of GPD/CCF types the child class can compute.

Implements PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

◆ getQCDOrderType()

PerturbativeQCDOrderType::Type PARTONS::DDVCSConvolCoeffFunctionModule::getQCDOrderType ( ) const

Get order of the perturbative QCD computation.

◆ initModule()

void PARTONS::DDVCSConvolCoeffFunctionModule::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

Reimplemented in PARTONS::DDVCSCFFStandard.

◆ isModuleWellConfigured()

void PARTONS::DDVCSConvolCoeffFunctionModule::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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

Reimplemented in PARTONS::DDVCSCFFStandard.

◆ prepareSubModules()

void PARTONS::DDVCSConvolCoeffFunctionModule::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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

◆ resolveObjectDependencies()

void PARTONS::DDVCSConvolCoeffFunctionModule::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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

Reimplemented in PARTONS::DDVCSCFFStandard.

◆ run()

void PARTONS::DDVCSConvolCoeffFunctionModule::run ( )
virtual

◆ setKinematics()

void PARTONS::DDVCSConvolCoeffFunctionModule::setKinematics ( const DDVCSConvolCoeffFunctionKinematic kinematic)
protectedvirtual

Set internal kinematics.

Parameters
kinematicKinematics to be set.

Reimplemented from PARTONS::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

◆ setQCDOrderType()

void PARTONS::DDVCSConvolCoeffFunctionModule::setQCDOrderType ( PerturbativeQCDOrderType::Type  qcdOrderType)

Set order of the perturbative QCD computation.

◆ toString()

std::string PARTONS::DDVCSConvolCoeffFunctionModule::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::ConvolCoeffFunctionModule< DDVCSConvolCoeffFunctionKinematic, DDVCSConvolCoeffFunctionResult >.

Member Data Documentation

◆ DDVCS_CONVOL_COEFF_FUNCTION_MODULE_CLASS_NAME

const std::string PARTONS::DDVCSConvolCoeffFunctionModule::DDVCS_CONVOL_COEFF_FUNCTION_MODULE_CLASS_NAME
static
Initial value:
=
"DDVCSConvolCoeffFunctionModule"

Type of the module in XML automation.


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