convol_coeff_function/TCS/TCSConvolCoeffFunctionKinematic.h

0001 #ifndef TCS_CONVOL_COEFF_FUNCTION_KINEMATIC_H
0002 #define TCS_CONVOL_COEFF_FUNCTION_KINEMATIC_H
0003
0004 /**
0005  * @file TCSConvolCoeffFunctionKinematic.h
0006  * @author Bryan BERTHOU (SPhN / CEA Saclay)
0007  * @date July 22, 2015
0008  * @version 1.0
0009  */
0010
0011 #include <ElementaryUtils/parameters/GenericType.h>
0012 #include <ElementaryUtils/parameters/Parameters.h>
0013 #include <string>
0014 #include <vector>
0015
0016 #include "../../../utils/type/PhysicalType.h"
0017 #include "../../../utils/type/PhysicalUnit.h"
0018 #include "../ConvolCoeffFunctionKinematic.h"
0019
0020 namespace PARTONS {
0021
0022 /**
0023  * @class TCSConvolCoeffFunctionKinematic
0024  *
0025  * @brief Class representing single CCF kinematics for TCS process.
0026  *
0027  * This class represents a single CCF kinematics for TCS process (xi, t, \f$Q^{2}'\f$, \f$\mu_{F}^{2}\f$, \f$\mu_{F}^{2}\f$).
0028  */
0029 class TCSConvolCoeffFunctionKinematic: public ConvolCoeffFunctionKinematic {
0030
0031 public:
0032
0033     static const std::string TCS_CONVOL_COEFF_FUNCTION_KINEMATIC_CLASS_NAME; ///< Type of the kinematic in XML automation.
0034
0035     /**
0036      * Default constructor.
0037      */
0038     TCSConvolCoeffFunctionKinematic();
0039
0040     /**
0041      * Assignment constructor.
0042      * @param xi Skewness variable.
0043      * @param t Four-momentum transfer squared of hadron target (in \f$GeV^{2}\f$).
0044      * @param Q2Prim Outgoing virtual-photon virtuality (in \f$GeV^{2}\f$).
0045      * @param MuF2 Factorization scale squared (in \f$GeV^{2}\f$).
0046      * @param MuR2 Renormalization scale squared (in \f$GeV^{2}\f$).
0047      */
0048     TCSConvolCoeffFunctionKinematic(double xi, double t, double Q2Prim,
0049             double MuF2, double MuR2);
0050
0051     /**
0052      * Assignment constructor.
0053      * @param xi Skewness variable.
0054      * @param t Four-momentum transfer squared of hadron target (in \f$GeV^{2}\f$).
0055      * @param Q2Prim Outgoing virtual-photon virtuality (in \f$GeV^{2}\f$).
0056      * @param MuF2 Factorization scale squared (in \f$GeV^{2}\f$).
0057      * @param MuR2 Renormalization scale squared (in \f$GeV^{2}\f$).
0058      */
0059     TCSConvolCoeffFunctionKinematic(const PhysicalType<double> &xi,
0060             const PhysicalType<double> &t, const PhysicalType<double> &Q2Prim,
0061             const PhysicalType<double> &MuF2, const PhysicalType<double> &MuR2);
0062
0063     /**
0064      * Assignment constructor.
0065      * @param xi Skewness variable.
0066      * @param t Four-momentum transfer squared of hadron target (in \f$GeV^{2}\f$).
0067      * @param Q2Prim Outgoing virtual-photon virtuality (in \f$GeV^{2}\f$).
0068      * @param MuF2 Factorization scale squared (in \f$GeV^{2}\f$).
0069      * @param MuR2 Renormalization scale squared (in \f$GeV^{2}\f$).
0070      */
0071     TCSConvolCoeffFunctionKinematic(const ElemUtils::GenericType &xi,
0072             const ElemUtils::GenericType &t,
0073             const ElemUtils::GenericType &Q2Prim,
0074             const ElemUtils::GenericType &MuF2,
0075             const ElemUtils::GenericType &MuR2);
0076
0077     /**
0078      * Copy constructor.
0079      * @param other Object to be copied.
0080      */
0081     TCSConvolCoeffFunctionKinematic(
0082             const TCSConvolCoeffFunctionKinematic &other);
0083
0084     /**
0085      * Destructor.
0086      */
0087     virtual ~TCSConvolCoeffFunctionKinematic();
0088
0089     virtual void configure(const ElemUtils::Parameters &parameters);
0090     virtual std::string toString() const;
0091
0092     /**
0093      * Serialize into given Packet.
0094      * @param packet Target Packet.
0095      */
0096     void serialize(ElemUtils::Packet &packet) const;
0097
0098     /**
0099      * Retrieve data from given Packet.
0100      * @param packet Input Packet.
0101      */
0102     void unserialize(ElemUtils::Packet &packet);
0103
0104     /**
0105      * Serialize to std::vector<double>.
0106      */
0107     void serializeIntoStdVector(std::vector<double>& vec) const;
0108
0109     /**
0110      * Unserialize from std::vector<double>.
0111      */
0112     void unserializeFromStdVector(std::vector<double>::const_iterator& it,
0113             const std::vector<double>::const_iterator& end);
0114
0115     /**
0116      * Is equal operator. Checks if values of kinematic variables are the same.
0117      */
0118     bool operator ==(const TCSConvolCoeffFunctionKinematic& other) const;
0119
0120     /**
0121      * Is different operator. Checks of values of kinematic variables are different.
0122      */
0123     bool operator !=(const TCSConvolCoeffFunctionKinematic& other) const;
0124
0125     //********************************************************
0126     //*** SETTERS AND GETTERS ********************************
0127     //********************************************************
0128
0129     /**
0130      * Get outgoing virtual-photon virtuality.
0131      */
0132     const PhysicalType<double>& getQ2Prim() const;
0133
0134     /**
0135      * Set outgoing virtual-photon virtuality.
0136      */
0137     void setQ2Prim(const PhysicalType<double>& Q2Prim);
0138
0139     /**
0140      * Set outgoing virtual-photon virtuality.
0141      */
0142     void setQ2Prim(double Q2Prim, PhysicalUnit::Type unit = PhysicalUnit::GEV2);
0143
0144 protected:
0145
0146     virtual void updateHashSum() const;
0147
0148 private:
0149
0150     /**
0151      * Outgoing virtual-photon virtuality (in \f$GeV^{2}\f$).
0152      */
0153     PhysicalType<double> m_Q2Prim;
0154 };
0155
0156 /**
0157  * Stream operator to serialize class into Packet. See also GPDType::serialize().
0158  */
0159 ElemUtils::Packet& operator <<(ElemUtils::Packet& packet,
0160         TCSConvolCoeffFunctionKinematic& kinematic);
0161
0162 /**
0163  * Stream operator to retrieve class from Packet. See also GPDType::unserialize().
0164  */
0165 ElemUtils::Packet& operator >>(ElemUtils::Packet& packet,
0166         TCSConvolCoeffFunctionKinematic& kinematic);
0167
0168 } /* namespace PARTONS */
0169
0170 #endif /* TCS_CONVOL_COEFF_FUNCTION_KINEMATIC_H */