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

Class representing a single collinear-distribution kinematics. More...

Inheritance diagram for PARTONS::CollinearDistributionKinematic:
PARTONS::Kinematic PARTONS::BaseObject

Public Member Functions

 CollinearDistributionKinematic ()
 Default constructor. More...
 
 CollinearDistributionKinematic (double x, double MuF2, double MuR2)
 Assignment constructor. More...
 
 CollinearDistributionKinematic (const PhysicalType< double > &x, const PhysicalType< double > &MuF2, const PhysicalType< double > &MuR2)
 Assignment constructor. More...
 
 CollinearDistributionKinematic (const ElemUtils::GenericType &x, const ElemUtils::GenericType &MuF2, const ElemUtils::GenericType &MuR2)
 Assignment constructor. More...
 
 CollinearDistributionKinematic (const CollinearDistributionKinematic &other)
 Copy constructor. More...
 
virtual ~CollinearDistributionKinematic ()
 Destructor. More...
 
virtual void configure (const ElemUtils::Parameters &parameters)
 Configure via parameters. More...
 
virtual std::string toString () const
 Return a pre-formatted characters string for output visualization of class member's values. More...
 
void serialize (ElemUtils::Packet &packet) const
 Serialize into given Packet. More...
 
void unserialize (ElemUtils::Packet &packet)
 Retrieve data from given Packet. More...
 
void serializeIntoStdVector (std::vector< double > &vec) const
 Serialize to std::vector<double>. More...
 
void unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
 Unserialize from std::vector<double>. More...
 
bool operator== (const CollinearDistributionKinematic &other) const
 Is equal operator. More...
 
bool operator!= (const CollinearDistributionKinematic &other) const
 Is different operator. More...
 
const PhysicalType< double > & getX () const
 Get longitudinal momentum fraction of active parton. More...
 
void setX (const PhysicalType< double > &x)
 Set longitudinal momentum fraction of active parton. More...
 
void setX (double x, PhysicalUnit::Type unit=PhysicalUnit::NONE)
 Set longitudinal momentum fraction of active parton. More...
 
const PhysicalType< double > & getMuF2 () const
 Get factorization scale squared. More...
 
void setMuF2 (const PhysicalType< double > &muF2)
 Set factorization scale squared. More...
 
void setMuF2 (double muF2, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
 Set factorization scale squared. More...
 
const PhysicalType< double > & getMuR2 () const
 Get renormalization scale squared. More...
 
void setMuR2 (const PhysicalType< double > &muR2)
 Set renormalization scale squared. More...
 
void setMuR2 (double muR2, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
 Set renormalization scale squared. More...
 
- Public Member Functions inherited from PARTONS::Kinematic
virtual ~Kinematic ()
 Destructor. More...
 
void serialize (ElemUtils::Packet &packet) const
 Serialize into given Packet. More...
 
void unserialize (ElemUtils::Packet &packet)
 Retrieve data from given Packet. More...
 
void serializeIntoStdVector (std::vector< double > &vec) const
 Serialize to std::vector<double>. More...
 
void unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
 Unserialize from std::vector<double>. More...
 
ChannelType::Type getChannelType () const
 Get channel type. More...
 
const std::string & getHashSum () const
 Get hash sum of class content. More...
 
void setHashSum (const std::string &hashSum) const
 Set hash sum of class content. More...
 
- Public Member Functions inherited from PARTONS::BaseObject
 BaseObject (const std::string &className)
 Constructor. More...
 
virtual ~BaseObject ()
 Default destructor. More...
 
virtual BaseObjectclone () 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...
 
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 std::string COLLINEAR_DISTRIBUTION_KINEMATIC_CLASS_NAME = "CollinearDistributionKinematic"
 Type of the kinematic in XML automation. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_X = "x"
 Parameter name to set variable \(x\) via configuration methods. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_MUF2 = "MuF2"
 Parameter name to set variable \(\mu_{F}^{2}\) via configuration methods. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_MUR2 = "MuR2"
 Parameter name to set variable \(\mu_{R}^{2}\) via configuration methods. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_X_UNIT = "x_unit"
 Parameter name to set unit of variable \(x\) via configuration methods. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_MUF2_UNIT = "MuF2_unit"
 Parameter name to set unit of variable \(\mu_{F}^{2}\) via configuration methods. More...
 
static const std::string KINEMATIC_PARAMETER_NAME_MUR2_UNIT = "MuR2_unit"
 Parameter name to set unit of variable \(\mu_{R}^{2}\) via configuration methods. More...
 

Protected Member Functions

virtual void updateHashSum () const
 Update hash sum (see Kinematic::m_hashSum variable). More...
 
- Protected Member Functions inherited from PARTONS::Kinematic
 Kinematic (const std::string &className, ChannelType::Type channelType)
 Default constructor. More...
 
 Kinematic (const Kinematic &other)
 Copy constructor. More...
 
- 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...
 

Private Attributes

PhysicalType< double > m_x
 Longitudinal momentum fraction of active parton. More...
 
PhysicalType< double > m_MuF2
 Factorization scale squared (in \(GeV^{2}\)). More...
 
PhysicalType< double > m_MuR2
 Renormalization scale squared (in \(GeV^{2}\)). More...
 

Detailed Description

Class representing a single collinear-distribution kinematics.

This class represents a single collinear-distribution kinematics (x, \(\mu_{F}^{2}\), \(\mu_{F}^{2}\)).

Constructor & Destructor Documentation

◆ CollinearDistributionKinematic() [1/5]

PARTONS::CollinearDistributionKinematic::CollinearDistributionKinematic ( )

Default constructor.

◆ CollinearDistributionKinematic() [2/5]

PARTONS::CollinearDistributionKinematic::CollinearDistributionKinematic ( double  x,
double  MuF2,
double  MuR2 
)

Assignment constructor.

Parameters
xLongitudinal momentum fraction of active parton.
MuF2Factorization scale squared (in \(GeV^{2}\)).
MuR2Renormalization scale squared (in \(GeV^{2}\)).

◆ CollinearDistributionKinematic() [3/5]

PARTONS::CollinearDistributionKinematic::CollinearDistributionKinematic ( const PhysicalType< double > &  x,
const PhysicalType< double > &  MuF2,
const PhysicalType< double > &  MuR2 
)

Assignment constructor.

Parameters
xLongitudinal momentum fraction of active parton.
MuF2Factorization scale squared (in \(GeV^{2}\)).
MuR2Renormalization scale squared (in \(GeV^{2}\)).

◆ CollinearDistributionKinematic() [4/5]

PARTONS::CollinearDistributionKinematic::CollinearDistributionKinematic ( const ElemUtils::GenericType &  x,
const ElemUtils::GenericType &  MuF2,
const ElemUtils::GenericType &  MuR2 
)

Assignment constructor.

Parameters
xLongitudinal momentum fraction of active parton.
MuF2Factorization scale squared (in \(GeV^{2}\)).
MuR2Renormalization scale squared (in \(GeV^{2}\)).

◆ CollinearDistributionKinematic() [5/5]

PARTONS::CollinearDistributionKinematic::CollinearDistributionKinematic ( const CollinearDistributionKinematic other)

Copy constructor.

Parameters
otherObject to be copied.

◆ ~CollinearDistributionKinematic()

PARTONS::CollinearDistributionKinematic::~CollinearDistributionKinematic ( )
virtual

Destructor.

Member Function Documentation

◆ configure()

void PARTONS::CollinearDistributionKinematic::configure ( const ElemUtils::Parameters &  parameters)
virtual

Configure via parameters.

Parameters
parametersSet of parameters to be set.

Reimplemented from PARTONS::Kinematic.

◆ getMuF2()

const PhysicalType< double > & PARTONS::CollinearDistributionKinematic::getMuF2 ( ) const

Get factorization scale squared.

◆ getMuR2()

const PhysicalType< double > & PARTONS::CollinearDistributionKinematic::getMuR2 ( ) const

Get renormalization scale squared.

◆ getX()

const PhysicalType< double > & PARTONS::CollinearDistributionKinematic::getX ( ) const

Get longitudinal momentum fraction of active parton.

◆ operator!=()

bool PARTONS::CollinearDistributionKinematic::operator!= ( const CollinearDistributionKinematic other) const

Is different operator.

Checks of values of kinematic variables are different.

◆ operator==()

bool PARTONS::CollinearDistributionKinematic::operator== ( const CollinearDistributionKinematic other) const

Is equal operator.

Checks if values of kinematic variables are the same.

◆ serialize()

void PARTONS::CollinearDistributionKinematic::serialize ( ElemUtils::Packet &  packet) const

Serialize into given Packet.

Parameters
packetTarget Packet.

◆ serializeIntoStdVector()

void PARTONS::CollinearDistributionKinematic::serializeIntoStdVector ( std::vector< double > &  vec) const

Serialize to std::vector<double>.

◆ setMuF2() [1/2]

void PARTONS::CollinearDistributionKinematic::setMuF2 ( const PhysicalType< double > &  muF2)

Set factorization scale squared.

◆ setMuF2() [2/2]

void PARTONS::CollinearDistributionKinematic::setMuF2 ( double  muF2,
PhysicalUnit::Type  unit = PhysicalUnit::GEV2 
)

Set factorization scale squared.

◆ setMuR2() [1/2]

void PARTONS::CollinearDistributionKinematic::setMuR2 ( const PhysicalType< double > &  muR2)

Set renormalization scale squared.

◆ setMuR2() [2/2]

void PARTONS::CollinearDistributionKinematic::setMuR2 ( double  muR2,
PhysicalUnit::Type  unit = PhysicalUnit::GEV2 
)

Set renormalization scale squared.

◆ setX() [1/2]

void PARTONS::CollinearDistributionKinematic::setX ( const PhysicalType< double > &  x)

Set longitudinal momentum fraction of active parton.

◆ setX() [2/2]

void PARTONS::CollinearDistributionKinematic::setX ( double  x,
PhysicalUnit::Type  unit = PhysicalUnit::NONE 
)

Set longitudinal momentum fraction of active parton.

◆ toString()

std::string PARTONS::CollinearDistributionKinematic::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::Kinematic.

◆ unserialize()

void PARTONS::CollinearDistributionKinematic::unserialize ( ElemUtils::Packet &  packet)

Retrieve data from given Packet.

Parameters
packetInput Packet.

◆ unserializeFromStdVector()

void PARTONS::CollinearDistributionKinematic::unserializeFromStdVector ( std::vector< double >::const_iterator &  it,
const std::vector< double >::const_iterator &  end 
)

Unserialize from std::vector<double>.

◆ updateHashSum()

void PARTONS::CollinearDistributionKinematic::updateHashSum ( ) const
protectedvirtual

Update hash sum (see Kinematic::m_hashSum variable).

Implements PARTONS::Kinematic.

Member Data Documentation

◆ COLLINEAR_DISTRIBUTION_KINEMATIC_CLASS_NAME

const std::string PARTONS::CollinearDistributionKinematic::COLLINEAR_DISTRIBUTION_KINEMATIC_CLASS_NAME = "CollinearDistributionKinematic"
static

Type of the kinematic in XML automation.

◆ KINEMATIC_PARAMETER_NAME_MUF2

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_MUF2 = "MuF2"
static

Parameter name to set variable \(\mu_{F}^{2}\) via configuration methods.

◆ KINEMATIC_PARAMETER_NAME_MUF2_UNIT

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_MUF2_UNIT = "MuF2_unit"
static

Parameter name to set unit of variable \(\mu_{F}^{2}\) via configuration methods.

◆ KINEMATIC_PARAMETER_NAME_MUR2

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_MUR2 = "MuR2"
static

Parameter name to set variable \(\mu_{R}^{2}\) via configuration methods.

◆ KINEMATIC_PARAMETER_NAME_MUR2_UNIT

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_MUR2_UNIT = "MuR2_unit"
static

Parameter name to set unit of variable \(\mu_{R}^{2}\) via configuration methods.

◆ KINEMATIC_PARAMETER_NAME_X

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_X = "x"
static

Parameter name to set variable \(x\) via configuration methods.

◆ KINEMATIC_PARAMETER_NAME_X_UNIT

const std::string PARTONS::CollinearDistributionKinematic::KINEMATIC_PARAMETER_NAME_X_UNIT = "x_unit"
static

Parameter name to set unit of variable \(x\) via configuration methods.

◆ m_MuF2

PhysicalType<double> PARTONS::CollinearDistributionKinematic::m_MuF2
private

Factorization scale squared (in \(GeV^{2}\)).

◆ m_MuR2

PhysicalType<double> PARTONS::CollinearDistributionKinematic::m_MuR2
private

Renormalization scale squared (in \(GeV^{2}\)).

◆ m_x

PhysicalType<double> PARTONS::CollinearDistributionKinematic::m_x
private

Longitudinal momentum fraction of active parton.


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