hoteos.h

/*
 *  Definition of Lorene class Hot_eos.
 *
 */

/*
 *   Copyright (c) 2015 Jerome Novak
 *
 *   This file is part of LORENE.
 *
 *   LORENE is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   LORENE is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with LORENE; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef __HOTEOS_H_ 
#define __HOTEOS_H_ 

/*
 * $Id: hoteos.h,v 1.8 2022/05/06 09:51:29 g_servignat Exp $
 * $Log: hoteos.h,v $
 * Revision 1.8  2022/05/06 09:51:29  g_servignat
 * Removed chi2 computation function from Ye EoS representation
 *
 * Revision 1.7  2022/04/06 12:38:06  g_servignat
 * Added source computation routine and source reading in table for electronic fraction advection equation
 *
 * Revision 1.6  2022/03/01 10:03:07  g_servignat
 * Corrected all pure virtual interference between Hot_eos derived classes ; amended use of interpol_linear_2D
 *
 * Revision 1.5  2022/02/25 11:59:43  g_servignat
 * Compilation error corrections (correctly using class inheritance)
 *
 * Revision 1.4  2022/02/25 10:44:50  g_servignat
 * Added Ye_eos_tabul derived class to Hot_eos class for tabulated 2D equations of state with H and Y_e as parameters
 *
 * Revision 1.3  2015/12/08 10:52:17  j_novak
 * New class Hoteos_tabul for tabulated temperature-dependent EoSs.
 *
 * Revision 1.2  2015/09/10 13:28:00  j_novak
 * New methods for the class Hot_Eos
 *
 * Revision 1.1  2015/03/17 14:19:59  j_novak
 * New class Hot_eos to deal with temperature-dependent EOSs.
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/hoteos.h,v 1.8 2022/05/06 09:51:29 g_servignat Exp $
 *
 */

//C++ headers
#include "headcpp.h"

//C headers
#include<cstdio>
#include "tbl.h"

namespace Lorene{

class Scalar ;
class Param ;
class Eos ;  
            //------------------------------------//
            //      class Hot_eos         //
            //------------------------------------//

  class Hot_eos {
    
    // Data : 
    // -----
  protected:
    string name ;      
    
    // Constructors - Destructor
    // -------------------------
  protected:
    Hot_eos() ;         
    
    explicit Hot_eos(const string&) ;
    
    explicit Hot_eos(const char*) ;
    
    Hot_eos(const Hot_eos& ) ;      
    
    Hot_eos(FILE* ) ;           
    
    Hot_eos(ifstream& ) ; 
    
  public:
    virtual ~Hot_eos() ;            
 
    // Derived data : 
    // ------------
  protected:
    mutable Eos* p_cold_eos ;     
    
    virtual void del_deriv() const ; 

    void set_der_0x0() const ; 
    
    // Name manipulation
    // -----------------
  public:
    const string& get_name() const {return name; };
    
    void set_name(const char* ) ; 
    
    // Miscellaneous
    // -------------
  public:
    static Hot_eos* hoteos_from_file(FILE* ) ; 
    
    static Hot_eos* hoteos_from_file(ifstream& ) ; 
    
    virtual bool operator==(const Hot_eos& ) const = 0 ; 

    virtual bool operator!=(const Hot_eos& ) const = 0 ; 
    
    virtual int identify() const = 0 ; 
    
    // Outputs
    // -------
    
  public: 
    virtual void sauve(FILE* ) const ;  

    friend ostream& operator<<(ostream& , const Hot_eos& ) ;    

  protected: 
    virtual ostream& operator>>(ostream &) const = 0 ;    

  public:
    virtual const Eos& new_cold_Eos() const = 0 ; 

    // virtual const string fetch_

    // Computational functions
    // -----------------------
  protected:
    void calcule(const Scalar& thermo1, const Scalar& thermo2, int nzet, int l_min,
         double (Hot_eos::*fait)(double, double) const, Scalar& resu) const ;

  public:
    virtual double nbar_Hs_p(double ent, double sb) const = 0 ;

    Scalar nbar_Hs(const Scalar& ent, const Scalar& sb, int nzet, int l_min = 0) const  ;

    virtual double ener_Hs_p(double ent, double sb) const = 0 ;
 
    Scalar ener_Hs(const Scalar& ent, const Scalar& sb, int nzet, int l_min = 0) const ;

    virtual double press_Hs_p(double ent, double sb) const = 0 ;

    Scalar press_Hs(const Scalar& ent, const Scalar& sb, int nzet, int l_min = 0) const ;

    virtual double temp_Hs_p(double ent, double sb) const = 0 ;

    Scalar temp_Hs(const Scalar& ent, const Scalar& sb, int nzet, int l_min = 0) const  ;

    
        virtual double csound_square_Hs_p(double ent, const double ye) const = 0;
  
        virtual double chi2_Hs_p(double ent, const double ye) const = 0;
  
        Scalar chi2_Hs(const Scalar& ent, const Scalar& Ye, int nzet, int l_min = 0) const ;
  
        virtual double mul_Hs_p(double ent, const double ye) const = 0;
  
        Scalar mul_Hs(const Scalar& ent, const Scalar& Ye, int nzet, int l_min = 0) const ;
    
        Scalar csound_square_Hs(const Scalar& ent, const Scalar& Y_e, int nzet, int l_min = 0) const ;
  
        virtual double sigma_Hs_p(double ent, const double ye) const = 0 ;
  
        Scalar sigma_Hs(const Scalar& ent, const Scalar& Y_e, int nzet, int l_min = 0) const ;
  };
  ostream& operator<<(ostream& , const Hot_eos& ) ; 

        //------------------------------------//
            //          class Ideal_gas            //
            //----------------------------------//

  class Ideal_gas : public Hot_eos {
    
    // Data :
    //-------
    
  protected:
    double gam ;
    
    double kap ; 
    
    double m_0 ;
    
    double gam1 ;       
    double unsgam1 ;    
    double gam1sgamkap ; 
    
    // Constructors - Destructor
    // -------------------------
  public:
    
    Ideal_gas(double gamma, double kappa, double mass=1.) ;

    Ideal_gas(const Ideal_gas& ) ;  
    
    protected:
    Ideal_gas(FILE* ) ;

    Ideal_gas(ifstream& ) ;

    friend Hot_eos* Hot_eos::hoteos_from_file(FILE* ) ;
    friend Hot_eos* Hot_eos::hoteos_from_file(ifstream& ) ; 

  public:
    virtual ~Ideal_gas() ;          

    // Assignment
    // ----------
    void operator=(const Ideal_gas& ) ;

    // Miscellaneous
    // -------------
    
  public :
    virtual bool operator==(const Hot_eos& ) const ;
    
    virtual bool operator!=(const Hot_eos& ) const ;
    
    virtual int identify() const ; 
    
    double get_gam() const ;

    double get_kap() const ;
    
    double get_m_0() const ;

    virtual const Eos& new_cold_Eos() const ;

    protected:
    void set_auxiliary() ;

    // Outputs
    // -------

  public:
    virtual void sauve(FILE* ) const ;  

  protected:
    virtual ostream& operator>>(ostream &) const ;    


    // Computational functions
    // -----------------------

  public:
    virtual double nbar_Hs_p(double ent, double sb) const ;

    virtual double ener_Hs_p(double ent, double sb) const ;
 
    virtual double press_Hs_p(double ent, double sb) const ;

    virtual double temp_Hs_p(double ent, double sb) const ;
    
        virtual double csound_square_Hs_p(double ent, const double ye) const ;
      
        virtual double chi2_Hs_p(double ent, const double ye) const ;
      
        virtual double mul_Hs_p(double ent, const double ye) const ;

        virtual double sigma_Hs_p(double ent, const double ye) const ;

};

        //------------------------------------//
            //        class Hoteos_tabul            //
            //------------------------------------//

  class Hoteos_tabul : public Hot_eos {
    
    // Data :
    //-------
    
  protected:
    string tablename ;
    
    string authors ; 

    double hmin ;
        
    double hmax ;
    
    double sbmin ;
        
    double sbmax ;
    
    Tbl* hhh ;
    
    Tbl* s_B ;
    
    Tbl* ppp ;
    
    Tbl* dpdh ;
    
    Tbl* dpds ;
    
    Tbl* d2p ;

    
    // Constructors - Destructor
    // -------------------------
  public:
    
    Hoteos_tabul(const string& filename) ;

    Hoteos_tabul(const Hoteos_tabul& ) ;    
    
    protected:
    Hoteos_tabul(FILE* ) ;

    Hoteos_tabul(ifstream& ) ;

    friend Hot_eos* Hot_eos::hoteos_from_file(FILE* ) ;
    friend Hot_eos* Hot_eos::hoteos_from_file(ifstream& ) ; 

  public:
    virtual ~Hoteos_tabul() ;           

    void operator=(const Hoteos_tabul& ) ;

    // Miscellaneous
    // -------------

  protected:    
    void read_table() ;

    void set_arrays_0x0() ;
    
  public :
    virtual bool operator==(const Hot_eos& ) const ;
    
    virtual bool operator!=(const Hot_eos& ) const ;
    
    virtual int identify() const ; 
    
    virtual const Eos& new_cold_Eos() const ;

    // Outputs
    // -------

  public:
    virtual void sauve(FILE* ) const ;  

  protected:
    virtual ostream& operator>>(ostream &) const ;    


    // Computational functions
    // -----------------------

  public:
    virtual double nbar_Hs_p(double ent, double sb) const ;

    virtual double ener_Hs_p(double ent, double sb) const ;
 
    virtual double press_Hs_p(double ent, double sb) const ;

    virtual double temp_Hs_p(double ent, double sb) const ;
    
        virtual double csound_square_Hs_p(double ent, const double ye) const ;
      
        virtual double chi2_Hs_p(double ent, const double ye) const ;
      
        virtual double mul_Hs_p(double ent, const double ye) const ;
  
        virtual double sigma_Hs_p(double ent, const double ye) const ;

};

        //------------------------------------//
            //        class Ye_eos_tabul            //
            //------------------------------------//

  class Ye_eos_tabul : public Hot_eos {
    
    // Data :
    //-------
    
  protected:
    string tablename ;
    
    string authors ; 

    double hmin ;
        
    double hmax ;
    
    double yemin ;
        
    double yemax ;
    
    Tbl* hhh ;
    
    Tbl* Y_e ;

    Tbl* c_sound2 ;

    Tbl* mu_l ;
    
    Tbl* ppp ;
    
    Tbl* dpdh ;
    
    Tbl* dpdye ;
    
    Tbl* d2p ;

    Tbl* Sourcetbl ;
    
    // Constructors - Destructor
    // -------------------------
  public:
    
    Ye_eos_tabul(const string& filename) ;

    Ye_eos_tabul(const Ye_eos_tabul& ) ;    
    
    protected:
    Ye_eos_tabul(FILE* ) ;

    Ye_eos_tabul(ifstream& ) ;

    friend Hot_eos* Hot_eos::hoteos_from_file(FILE* ) ;
    friend Hot_eos* Hot_eos::hoteos_from_file(ifstream& ) ; 

  public:
    virtual ~Ye_eos_tabul() ;           
    
    const string get_tablename() const { return tablename ;} ;

    void operator=(const Ye_eos_tabul& ) ;

    // Miscellaneous
    // -------------

  protected:    
    void read_table() ;

    void set_arrays_0x0() ;
    
  public :
    virtual bool operator==(const Hot_eos& ) const ;
    
    virtual bool operator!=(const Hot_eos& ) const ;
    
    virtual int identify() const ; 
    
    virtual const Eos& new_cold_Eos() const ;

    // Outputs
    // -------

  public:
    virtual void sauve(FILE* ) const ;  

  protected:
    virtual ostream& operator>>(ostream &) const ;    


    // Computational functions
    // -----------------------
  protected:
  
  public:
    virtual double nbar_Hs_p(double ent, double ye) const ;



    virtual double ener_Hs_p(double ent, double ye) const ;
 
    virtual double press_Hs_p(double ent, double ye) const ; 
    
    virtual double temp_Hs_p(double ent, double sb) const ;


        virtual double csound_square_Hs_p(double ent, const double ye) const ;
    
  
        virtual double chi2_Hs_p(double ent, const double ye) const ;
    

        virtual double mul_Hs_p(double ent, const double ye) const ;

        virtual double sigma_Hs_p(double ent, const double ye) const ;
};

}
#endif