FFBLPRBase.hh

Go to the documentation of this file.

///
/// @file  FFBLPRBase.hh
/// @brief Hammer base class for BLPR form factors
///

//**** This file is a part of the HAMMER library
//**** Copyright (C) 2016 - 2020 The HAMMER Collaboration
//**** HAMMER is licensed under version 3 of the GPL; see COPYING for details
//**** Please note the MCnet academic guidelines; see GUIDELINES for details

// -*- C++ -*-
#ifndef HAMMER_FF_BLPR_BASE
#define HAMMER_FF_BLPR_BASE

#include "Hammer/FormFactorBase.hh"

namespace Hammer {

    /// @brief Base class for BLPR form factors
    ///
    /// @ingroup FormFactors
    class FFBLPRBase : public FormFactorBase {

    public:
        FFBLPRBase();

        FFBLPRBase(const FFBLPRBase& other) = default;
        FFBLPRBase& operator=(const FFBLPRBase& other) = delete;
        FFBLPRBase(FFBLPRBase&& other) = delete;
        FFBLPRBase& operator=(FFBLPRBase&& other) = delete;
        virtual ~FFBLPRBase() = default;

        /// @brief method to evaluate the object on a specific particle set
        /// @param[in] parent  the parent Particle
        /// @param[in] daughters the daughters (and grand-daughters, if necessary) Particle list
        /// @param[in] references the parent Particle siblings (necessary e.g. for helicity amplitude phase conventions)
        virtual void eval(const Particle& parent, const ParticleList& daughters,
                          const ParticleList& references);

    protected:
        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CS(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CP(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CV1(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CV2(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CV3(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CA1(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CA2(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CA3(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CT1(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CT2(double w, double z) const;

        /// @brief
        /// @param[in] w
        /// @param[in] z
        /// @return
        double CT3(double w, double z) const;

        // Initialization of common variables & functions
        void initVars(double w, double z) const;

        // DiLog function
        double DiLog(double z) const;

        /// @brief
        /// @param[in] point
        /// @param[in] masses
        /// @return
        virtual void evalAtPSPoint(const std::vector<double>& point, const std::vector<double>& masses = {}) = 0;

        /// @brief
        virtual void defineSettings() = 0;


    protected:
        void addRefs() const;

    private:
        mutable double _wSq;
        mutable double _sqrt1wSq;
        mutable double _zSq;
        mutable double _zCu;
        mutable double _zm1Sq;
        mutable double _zp1Sq;
        mutable double _lnz;
        mutable double _wZ;
        mutable double _wP;
        mutable double _wM;
        mutable double _wmwZSq;
        mutable double _lnwP;
        mutable double _rW;
        mutable double _Omega;
    };

} // namespace Hammer

#endif