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

Dispersion relation DVCS/CFF model. More...

Inheritance diagram for PARTONS::DVCSCFFDispersionRelation:
PARTONS::DVCSConvolCoeffFunctionModule PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult > PARTONS::ModuleObject PARTONS::MathIntegratorModule PARTONS::BaseObject

Public Member Functions

 DVCSCFFDispersionRelation (const std::string &className)
 Constructor. More...
 
virtual ~DVCSCFFDispersionRelation ()
 Destructor. More...
 
virtual DVCSCFFDispersionRelationclone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. 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...
 
GPDSubtractionConstantModulegetSubtractionConstantModule () const
 Get subtraction constant module. More...
 
void setSubtractionConstantModule (GPDSubtractionConstantModule *subtractionConstantModule)
 Set subtraction constant module. More...
 
- Public Member Functions inherited from PARTONS::DVCSConvolCoeffFunctionModule
virtual ~DVCSConvolCoeffFunctionModule ()
 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 DVCSConvolCoeffFunctionResult compute (const DVCSConvolCoeffFunctionKinematic &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 > computeCFF ()
 Method to compute some CFFs. More...
 
- Public Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
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 unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::DVCSConvolCoeffFunctionModule
static const std::string DVCS_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

 DVCSCFFDispersionRelation (const DVCSCFFDispersionRelation &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...
 
- Protected Member Functions inherited from PARTONS::DVCSConvolCoeffFunctionModule
 DVCSConvolCoeffFunctionModule (const std::string &className)
 Default constructor. More...
 
 DVCSConvolCoeffFunctionModule (const DVCSConvolCoeffFunctionModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const DVCSConvolCoeffFunctionKinematic &kinematic)
 Set internal kinematics. More...
 
- Protected Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
 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 Member Functions

virtual std::complex< double > computeUnpolarized ()
 Method to compute some CFFs. More...
 
virtual std::complex< double > computePolarized ()
 Method to compute some CFFs. More...
 
double computeSquareChargeAveragedGPD (double xi)
 Sum for quark singlet combinations weighted by squares of charges. More...
 
double dispersionRelationIntegralPartDiagonalA (double xi, std::vector< double > par)
 Dispersion relation integral function for 1/(x - xi) part. More...
 
double dispersionRelationIntegralPartDiagonalB (double xi, std::vector< double > par)
 Dispersion relation integral function for 1/(x + xi) part. More...
 
void initFunctorsForIntegrations ()
 Initialize functors. More...
 

Private Attributes

NumA::FunctionType1D * m_p_int_dispersionRelationIntegralPartDiagonalA
 functor related to dispersionRelationIntegralPartDiagonalA() function More...
 
NumA::FunctionType1D * m_p_int_dispersionRelationIntegralPartDiagonalB
 functor related to dispersionRelationIntegralPartDiagonalB() function More...
 
GPDSubtractionConstantModulem_pSubtractionConstantModule
 Subtraction constant module. More...
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
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

Dispersion relation DVCS/CFF model.

Dispersion relation DVCS/CFF model. Need to be configured with GPDSubtractionConstantModule object provided. The sign of subtraction constant is -/+ for GPDs H/E.

Constructor & Destructor Documentation

◆ DVCSCFFDispersionRelation() [1/2]

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

Constructor.

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

Parameters
classNameName of last child class.

◆ ~DVCSCFFDispersionRelation()

PARTONS::DVCSCFFDispersionRelation::~DVCSCFFDispersionRelation ( )
virtual

Destructor.

◆ DVCSCFFDispersionRelation() [2/2]

PARTONS::DVCSCFFDispersionRelation::DVCSCFFDispersionRelation ( const DVCSCFFDispersionRelation other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

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

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

Returns

Implements PARTONS::DVCSConvolCoeffFunctionModule.

◆ computePolarized()

std::complex< double > PARTONS::DVCSCFFDispersionRelation::computePolarized ( )
privatevirtual

Method to compute some CFFs.

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

Returns
Complex result.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ computeSquareChargeAveragedGPD()

double PARTONS::DVCSCFFDispersionRelation::computeSquareChargeAveragedGPD ( double  xi)
private

Sum for quark singlet combinations weighted by squares of charges.

Parameters
xiGPD xi variable.

◆ computeUnpolarized()

std::complex< double > PARTONS::DVCSCFFDispersionRelation::computeUnpolarized ( )
privatevirtual

Method to compute some CFFs.

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

Returns
Complex result.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ configure()

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

◆ dispersionRelationIntegralPartDiagonalA()

double PARTONS::DVCSCFFDispersionRelation::dispersionRelationIntegralPartDiagonalA ( double  xi,
std::vector< double >  par 
)
private

Dispersion relation integral function for 1/(x - xi) part.

Parameters
xiGPD xi variable.
parAdditional parameters (not used here).

◆ dispersionRelationIntegralPartDiagonalB()

double PARTONS::DVCSCFFDispersionRelation::dispersionRelationIntegralPartDiagonalB ( double  xi,
std::vector< double >  par 
)
private

Dispersion relation integral function for 1/(x + xi) part.

Parameters
xiGPD xi variable.
parAdditional parameters (not used here).

◆ getSubtractionConstantModule()

GPDSubtractionConstantModule * PARTONS::DVCSCFFDispersionRelation::getSubtractionConstantModule ( ) const

Get subtraction constant module.

◆ initFunctorsForIntegrations()

void PARTONS::DVCSCFFDispersionRelation::initFunctorsForIntegrations ( )
private

Initialize functors.

◆ initModule()

void PARTONS::DVCSCFFDispersionRelation::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ isModuleWellConfigured()

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

◆ prepareSubModules()

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

◆ resolveObjectDependencies()

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

◆ setSubtractionConstantModule()

void PARTONS::DVCSCFFDispersionRelation::setSubtractionConstantModule ( GPDSubtractionConstantModule subtractionConstantModule)

Set subtraction constant module.

Parameters
subtractionConstantModuleSubtraction constant module to be set.

Member Data Documentation

◆ classId

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

Unique ID to automatically register the class in the registry.

◆ m_p_int_dispersionRelationIntegralPartDiagonalA

NumA::FunctionType1D* PARTONS::DVCSCFFDispersionRelation::m_p_int_dispersionRelationIntegralPartDiagonalA
private

functor related to dispersionRelationIntegralPartDiagonalA() function

◆ m_p_int_dispersionRelationIntegralPartDiagonalB

NumA::FunctionType1D* PARTONS::DVCSCFFDispersionRelation::m_p_int_dispersionRelationIntegralPartDiagonalB
private

functor related to dispersionRelationIntegralPartDiagonalB() function

◆ m_pSubtractionConstantModule

GPDSubtractionConstantModule* PARTONS::DVCSCFFDispersionRelation::m_pSubtractionConstantModule
private

Subtraction constant module.


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