FFBGLBase.hh

Go to the documentation of this file.

///
/// @file  FFBGLBase.hh
/// @brief Hammer base class for BGL 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_BGL_BASE
#define HAMMER_FF_BGL_BASE

#include "Hammer/FormFactorBase.hh"

namespace Hammer {

    /// @brief Base class for BGL form factors
    ///
    /// @ingroup FormFactors
    class FFBGLBase : public FormFactorBase {

    public:
        FFBGLBase();

        FFBGLBase(const FFBGLBase& other) = default;
        FFBGLBase& operator=(const FFBGLBase& other) = delete;
        FFBGLBase(FFBGLBase&& other) = delete;
        FFBGLBase& operator=(FFBGLBase&& other) = delete;
        virtual ~FFBGLBase() = 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] 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;

    };

} // namespace Hammer

#endif