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

Module for the GAM2 process using arXiv:2110.00048 set of formulas. More...

Inheritance diagram for PARTONS::GAM2ProcessGPSSW21:
PARTONS::GAM2ProcessModule PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult > PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 GAM2ProcessGPSSW21 (const std::string &className)
 Constructor. More...
 
virtual ~GAM2ProcessGPSSW21 ()
 Default destructor. More...
 
virtual GAM2ProcessGPSSW21clone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
 
- Public Member Functions inherited from PARTONS::GAM2ProcessModule
virtual ~GAM2ProcessModule ()
 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 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 List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Must be implemented in child class. More...
 
virtual GAM2ObservableResult compute (PolarizationType::Type polG0, PolarizationType::Type polG1, PolarizationType::Type polG2, NumA::Vector3D targetPolarization, const GAM2ObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Computes the differential cross-section. More...
 
virtual void resetPreviousKinematic ()
 Reset previous kinematics. More...
 
bool isPreviousCCFKinematicDifferent (const GAM2ConvolCoeffFunctionKinematic &kinematic) const
 Check if this kinematics is different than the previous one. More...
 
GAM2ScalesModulegetScaleModule () const
 Get scale module. More...
 
void setScaleModule (GAM2ScalesModule *pScaleModule)
 Set scale module. More...
 
GAM2XiConverterModulegetXiConverterModule () const
 Get xi converter module. More...
 
void setXiConverterModule (GAM2XiConverterModule *pXiConverterModule)
 Set xi converted module. More...
 
GAM2ConvolCoeffFunctionModulegetConvolCoeffFunctionModule () const
 Get CCF module;. More...
 
void setConvolCoeffFunctionModule (GAM2ConvolCoeffFunctionModule *pConvolCoeffFunctionModule)
 Set CCF module. More...
 
void setConvolCoeffFunction (const GAM2ConvolCoeffFunctionKinematic &kin, const GAM2ConvolCoeffFunctionResult &result)
 Set manually CFFs. More...
 
- Public Member Functions inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
virtual ~ProcessModule ()
 Destructor. More...
 
bool isCCFModuleDependent () const
 Check if this process module depends on a CCF module. More...
 
void setIsCCFModuleDependent (bool isCCFModuleDependent)
 Set if this process module depends on a CCF 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 unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::GAM2ProcessModule
static const std::string GAM2_PROCESS_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"
 

Protected Member Functions

 GAM2ProcessGPSSW21 (const GAM2ProcessGPSSW21 &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 > CrossSection ()
 Differential cross section. More...
 
- Protected Member Functions inherited from PARTONS::GAM2ProcessModule
 GAM2ProcessModule (const std::string &className)
 Default constructor. More...
 
 GAM2ProcessModule (const GAM2ProcessModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const GAM2ObservableKinematic &kinematic)
 Set internal kinematics. More...
 
virtual void setExperimentalConditions (PolarizationType::Type polG0, PolarizationType::Type polG1, PolarizationType::Type polG2, NumA::Vector3D targetPolarization)
 
void computeConvolCoeffFunction (const GAM2ObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Compute CCF for a given kinematics. More...
 
std::complex< double > getConvolCoeffFunctionValue (GPDType::Type gpdType)
 Gives back a previously computed Compton Form Factor. More...
 
- Protected Member Functions inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
 ProcessModule (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 ProcessModule (const ProcessModule &other)
 Copy constructor. 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...
 

Additional Inherited Members

- Protected Attributes inherited from PARTONS::GAM2ProcessModule
double m_t
 Four-momentum transfer squared of hadron target (in \(GeV^{2}\)). More...
 
double m_uPrim
 F our-momentum transfer squared to photon (in \(GeV^{2}\)). More...
 
double m_Mgg2
 Invariant mass of two photons (in \(GeV^{2}\)). More...
 
double m_E
 Beam energy (in GeV). More...
 
double m_phi
 Linear polarization angle. More...
 
double m_tmin
 t min; More...
 
double m_xi
 xi; More...
 
PolarizationType::Type m_polG0
 Polarization of incoming photon. More...
 
PolarizationType::Type m_polG1
 Polarization of first outgoing photon. More...
 
PolarizationType::Type m_polG2
 Polarization of second outgoing photon. More...
 
NumA::Vector3D m_targetPolarization
 Target polarization. More...
 
GAM2ScalesModulem_pScaleModule
 Pointer to the underlying scale module. More...
 
GAM2XiConverterModulem_pXiConverterModule
 Pointer to the underlying xi converter module. More...
 
GAM2ConvolCoeffFunctionModulem_pConvolCoeffFunctionModule
 Pointer to the underlying CCF module. More...
 
GAM2ConvolCoeffFunctionResult m_dvcsConvolCoeffFunctionResult
 Stored Compton Form Factor result. More...
 
GAM2ConvolCoeffFunctionKinematic m_lastCCFKinematics
 Last Compton Form Factor kinematics. More...
 
- Protected Attributes inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
bool m_isCCFModuleDependent
 Boolean (true if this Process module depends on a CCF module). More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

Module for the GAM2 process using arXiv:2110.00048 set of formulas.

Constructor & Destructor Documentation

◆ GAM2ProcessGPSSW21() [1/2]

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

Constructor.

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

Parameters
classNamename of child class.

◆ ~GAM2ProcessGPSSW21()

PARTONS::GAM2ProcessGPSSW21::~GAM2ProcessGPSSW21 ( )
virtual

Default destructor.

◆ GAM2ProcessGPSSW21() [2/2]

PARTONS::GAM2ProcessGPSSW21::GAM2ProcessGPSSW21 ( const GAM2ProcessGPSSW21 other)
protected

Copy constructor.

Member Function Documentation

◆ clone()

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

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

Returns

Implements PARTONS::GAM2ProcessModule.

◆ CrossSection()

PhysicalType< double > PARTONS::GAM2ProcessGPSSW21::CrossSection ( )
protectedvirtual

Differential cross section.

Reimplemented from PARTONS::GAM2ProcessModule.

◆ initModule()

void PARTONS::GAM2ProcessGPSSW21::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::GAM2ProcessModule.

◆ isModuleWellConfigured()

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

Member Data Documentation

◆ classId

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

Unique ID to automatically register the class in the registry.


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