neutrinomassloss.h

Go to the documentation of this file.

/*
 Created by iorio on 7/25/22.
Module for Neutrino mass loss models, it includes:
- Class NeutrinoMassLoss:  Base class for NeutrinoMassLoss models
- Class NMLDisabled: Simple NeutrinoMassLoss model, just disable the neutrino mass loss correction
*/
 
#ifndef SEVN_NEUTRINOMASSLOSS_H
#define SEVN_NEUTRINOMASSLOSS_H
 
#include <sevnlog.h>
#include <map>
#include <vector>
#define _UNUSED __attribute__ ((unused))
 
class Star;
 
using sevnstd::SevnLogging;
 
class NeutrinoMassLoss{
/***** For Developers that want to add new NeutrinoMassLoss models: ******/
public:
    virtual inline std::string name() const {return "NeutrinoMassLoss";}
 
    virtual NeutrinoMassLoss *instance() = 0; //Pure virtual
 
    virtual double apply(_UNUSED const double mremnant, _UNUSED Star *s) const = 0; //Pure virtual
 
 
    /*********************************************************************************************************/
    /***** STOP: DO NOT CHANGE THE REST OF THE CODE IF YOU ARE NOT FULLY AWARE OF WHAT  YOU ARE DOING ******/
    /*********************************************************************************************************/
 
public:
    //Constructor - Destructor
    explicit NeutrinoMassLoss(_UNUSED bool reg=true){};
    virtual ~NeutrinoMassLoss() = default;
 
    //Create instance
    static NeutrinoMassLoss *Instance(std::string const &name);
 
    //Remove cp and mv, we don't need to copy or mv, therefore to avoid unexpected behaviour we just delete them
    NeutrinoMassLoss (const NeutrinoMassLoss&) = delete; //copy constructor
    NeutrinoMassLoss& operator= (const NeutrinoMassLoss&) = delete; //copy assignment
    NeutrinoMassLoss (NeutrinoMassLoss&& other) = delete; //mv constructor
    NeutrinoMassLoss& operator= (NeutrinoMassLoss&& other) = delete; //mv assignement
 
protected:
    static void Register(NeutrinoMassLoss *ptr);
    SevnLogging svlog;
 
private:
 
    //TODO We are using this Register-StaticMap formalism a lot, maybe we have to create a base template class containing
    //all these methods (GetStaticMap,Register,GetUsed) to have only one definition of these functions
    static std::map<std::string, NeutrinoMassLoss *> &GetStaticMap() {
        //First time call the function create the map, since c++11 this is thread safe
        static std::map<std::string, NeutrinoMassLoss *> _locmap;
        return _locmap;
    }
    static std::vector<int> &GetUsed() {
        static std::vector<int> _used;
        return _used;
    }
};
 
class NMLDisabled : public NeutrinoMassLoss{
public:
    //Ctor
    NMLDisabled(bool reg=true);
 
    //name
    inline std::string name() const override { return "disabled";}
 
    //Static instance
    static NMLDisabled _nmldisabled;
 
    //return an heap allocated instance
    NMLDisabled* instance() override {
        return (new NMLDisabled(false));
    }
 
     double apply(const double mremnant, _UNUSED Star *s) const override {return mremnant;}
};
 
 
 
#endif //SEVN_NEUTRINOMASSLOSS_H