pairinstability.h

Go to the documentation of this file.

/*
 Created by iorio on 7/25/22.
Module for Pair instability models, it includes:
- Struct PISNreturn: a simple struct containing a double and a Lookup::SNExplosionType (enum) to handle some function returns
- Class PairInstability:  Base class for PairInstability models
- Class PIDisabled: Simple PairInstability model, just disable the pair instability correction
*/
 
#ifndef SEVN_PAIRINSTABILITY_H
#define SEVN_PAIRINSTABILITY_H
 
#include <map>
#include <utilities.h>
#include <vector>
#include <sevnlog.h>
#include <lookup_and_phases.h>
 
class Star;
using sevnstd::SevnLogging;
 
struct PISNreturn{
    const double Mremnant_after_pisn; //Mass of the remnant after the correction
    const Lookup::SNExplosionType SNType; //Type of SNexplosion considering pairinstability
};
 
 
class PairInstability {
/***** For Developers that want to add new PairInstability models: ******/
public:
    virtual inline std::string name() const {return "PairInstability";}
 
    virtual PairInstability *instance() = 0; //Pure virtual
 
public:
    virtual  utilities::MassContainer apply_beforeSN(_UNUSED Star* s) const;
 
 
    virtual  PISNreturn apply_afterSN(_UNUSED Star* s, _UNUSED double mremnant) const;
 
 
 
    /*********************************************************************************************************/
    /***** STOP: DO NOT CHANGE THE REST OF THE CODE IF YOU ARE NOT FULLY AWARE OF WHAT  YOU ARE DOING ******/
    /*********************************************************************************************************/
 
public:
 
    //Constructor - Destructor
    explicit PairInstability(_UNUSED bool reg=true){};
    virtual ~PairInstability() = default;
 
    //Create instance
    static PairInstability *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
    PairInstability (const PairInstability&) = delete; //copy constructor
    PairInstability& operator= (const PairInstability&) = delete; //copy assignment
    PairInstability (PairInstability&& other) = delete; //mv constructor
    PairInstability& operator= (PairInstability&& other) = delete; //mv assignement
 
 
protected:
    static void Register(PairInstability *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, PairInstability *> &GetStaticMap() {
        //First time call the function create the map, since c++11 this is thread safe
        static std::map<std::string, PairInstability *> _locmap;
        return _locmap;
    }
    static std::vector<int> &GetUsed() {
        static std::vector<int> _used;
        return _used;
    }
};
 
class PIDisabled : public  PairInstability{
public:
    //Ctor
    explicit PIDisabled(bool reg=true);
 
    //Static instance
    static PIDisabled _pidisabled;
 
    //name
    inline std::string name() const override { return "disabled";}
 
    //return an heap allocated instance
    PIDisabled* instance() override {
        return (new PIDisabled(false));
    }
 
};
 
 
 
 
#endif //SEVN_PAIRINSTABILITY_H