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

1th Fourier moment of longitudinally polarized target asymmetry for negative beam charge. More...

Inheritance diagram for PARTONS::DVMPAluuMinusSin1Phi:
PARTONS::DVMPAluuMinus PARTONS::MathIntegratorModule PARTONS::DVMPObservable PARTONS::Observable< DVMPObservableKinematic, DVMPObservableResult > PARTONS::ModuleObject PARTONS::BaseObject

Public Member Functions

 DVMPAluuMinusSin1Phi (const std::string &className)
 Constructor. More...
 
virtual ~DVMPAluuMinusSin1Phi ()
 Destructor. More...
 
virtual DVMPAluuMinusSin1Phiclone () const
 Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...
 
virtual void configure (const ElemUtils::Parameters &parameters)
 Provides a generic method to configure all types of modules by passing a Parameters object. More...
 
- Public Member Functions inherited from PARTONS::DVMPAluuMinus
 DVMPAluuMinus (const std::string &className)
 Constructor. More...
 
virtual ~DVMPAluuMinus ()
 Destructor. More...
 
- Public Member Functions inherited from PARTONS::DVMPObservable
virtual ~DVMPObservable ()
 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 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 DVMPObservableResult compute (const DVMPObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 Computes the observable at given kinematics. More...
 
virtual List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Must be implemented in child class. More...
 
DVMPProcessModulegetProcessModule () const
 Get process module. More...
 
void setProcessModule (DVMPProcessModule *pProcessModule)
 Set process module. More...
 
- Public Member Functions inherited from PARTONS::Observable< DVMPObservableKinematic, DVMPObservableResult >
virtual ~Observable ()
 Destructor. 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::DVMPAluuMinus
static const unsigned int classId
 Unique ID to automatically register the class in the registry. More...
 
- Static Public Attributes inherited from PARTONS::DVMPObservable
static const std::string DVMP_OBSERVABLE_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

 DVMPAluuMinusSin1Phi (const DVMPAluuMinusSin1Phi &other)
 Copy constructor. More...
 
virtual PhysicalType< double > computeObservable (const DVMPObservableKinematic &kinematic, const List< GPDType > &gpdType)
 Evaluate observable. More...
 
virtual double functionToIntegrateObservable (double x, std::vector< double > params)
 Function to be integrated. More...
 
void initFunctorsForIntegrations ()
 Initialize functors. More...
 
- Protected Member Functions inherited from PARTONS::DVMPAluuMinus
 DVMPAluuMinus (const DVMPAluuMinus &other)
 Copy constructor. More...
 
- Protected Member Functions inherited from PARTONS::DVMPObservable
 DVMPObservable (const std::string &className)
 Default constructor. More...
 
 DVMPObservable (const DVMPObservable &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::Observable< DVMPObservableKinematic, DVMPObservableResult >
 Observable (const std::string &className, ChannelType::Type channelType)
 Constructor. More...
 
 Observable (const Observable &other)
 Copy constructor. More...
 
std::vector< double > serializeKinematicsAndGPDTypesIntoStdVector (const DVMPObservableKinematic &kin, const List< GPDType > &list) const
 Serialize kinematics and list of GPD types to std::vector<double>. More...
 
void unserializeKinematicsAndGPDTypesFromStdVector (const std::vector< double > &vec, DVMPObservableKinematic &kin, List< GPDType > &list) const
 Unserialize kinematics and list of GPD types from std::vector<double>. 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 ()
 

Protected Attributes

NumA::FunctionType1D * m_pFunctionToIntegrateObservable
 Functor to perform the integration. More...
 
- Protected Attributes inherited from PARTONS::DVMPObservable
DVMPProcessModulem_pProcessModule
 Pointer to the underlying process module. More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

1th Fourier moment of longitudinally polarized target asymmetry for negative beam charge.

Constructor & Destructor Documentation

◆ DVMPAluuMinusSin1Phi() [1/2]

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

Constructor.

Parameters
classNameName of class.

◆ ~DVMPAluuMinusSin1Phi()

PARTONS::DVMPAluuMinusSin1Phi::~DVMPAluuMinusSin1Phi ( )
virtual

Destructor.

◆ DVMPAluuMinusSin1Phi() [2/2]

PARTONS::DVMPAluuMinusSin1Phi::DVMPAluuMinusSin1Phi ( const DVMPAluuMinusSin1Phi other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

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

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

Returns

Reimplemented from PARTONS::DVMPAluuMinus.

◆ computeObservable()

PhysicalType< double > PARTONS::DVMPAluuMinusSin1Phi::computeObservable ( const DVMPObservableKinematic kinematic,
const List< GPDType > &  gpdType 
)
protectedvirtual

Evaluate observable.

To be implemented in a child class.

Reimplemented from PARTONS::DVMPAluuMinus.

◆ configure()

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

◆ functionToIntegrateObservable()

double PARTONS::DVMPAluuMinusSin1Phi::functionToIntegrateObservable ( double  x,
std::vector< double >  params 
)
protectedvirtual

Function to be integrated.

◆ initFunctorsForIntegrations()

void PARTONS::DVMPAluuMinusSin1Phi::initFunctorsForIntegrations ( )
protected

Initialize functors.

Member Data Documentation

◆ classId

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

Unique ID to automatically register the class in the registry.

◆ m_pFunctionToIntegrateObservable

NumA::FunctionType1D* PARTONS::DVMPAluuMinusSin1Phi::m_pFunctionToIntegrateObservable
protected

Functor to perform the integration.


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