eos.h

/*
 *  Definition of Lorene classes Eos
 *               Eos_poly
 *               Eos_poly_newt
 *               Eos_incomp
 *               Eos_incomp_newt
 *               Eos_strange
 *               Eos_strange_c
 *
 */

/*
 *   Copyright (c) 2000-2001 Eric Gourgoulhon
 *
 *   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 as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   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 __EOS_H_ 
#define __EOS_H_ 

/*
 * $Id: eos.h,v 1.17 2011/06/16 10:49:18 j_novak Exp $
 * $Log: eos.h,v $
 * Revision 1.17  2011/06/16 10:49:18  j_novak
 * New class Eos_mag for EOSs depending on density and magnetic field.
 *
 * Revision 1.16  2010/02/02 13:21:52  j_novak
 * New class Eos_Compstar.
 *
 * Revision 1.15  2010/01/23 16:27:11  e_gourgoulhon
 * Improved documentation.
 *
 * Revision 1.14  2005/05/22 20:49:12  k_taniguchi
 * Introduction of a new class Eos_fit_AkmalPR.
 *
 * Revision 1.13  2004/09/26 18:51:47  k_taniguchi
 * Introduction of new classes Eos_fitting, Eos_fit_SLy4, and Eos_fit_FPS
 *
 * Revision 1.12  2004/05/07 08:08:29  k_taniguchi
 * Add the case of Eos_multi_poly.C
 *
 * Revision 1.11  2004/03/22 16:10:20  j_novak
 * Excluding some files
 *
 * Revision 1.10  2004/03/22 13:12:40  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.9  2004/01/14 15:52:26  f_limousin
 * Added methods calcule, nbar_ent, der_nbar_ent and der_ener_ent for Scalar.
 *
 * Revision 1.8  2003/12/08 15:48:12  m_bejger
 * GlendNH3 (Glendenning 1985, case 3) added
 *
 * Revision 1.7  2002/10/16 14:36:28  j_novak
 * Reorganization of #include instructions of standard C++, in order to
 * use experimental version 3 of gcc.
 *
 * Revision 1.6  2002/09/13 09:17:31  j_novak
 * Modif. commentaires
 *
 * Revision 1.5  2002/06/17 14:05:16  j_novak
 * friend functions are now also declared outside the class definition
 *
 * Revision 1.4  2002/04/11 13:27:48  e_gourgoulhon
 * *** empty log message ***
 *
 * Revision 1.3  2002/04/09 15:19:03  e_gourgoulhon
 * Add EOS number 100 in the comments of eos_from_file
 *
 * Revision 1.2  2002/04/09 14:32:14  e_gourgoulhon
 * 1/ Added extra parameters in EOS computational functions (argument par)
 * 2/ New class MEos for multi-domain EOS
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 2.15  2001/09/12  15:54:17  eric
 * Modif documentation eos_from_file.
 *
 * Revision 2.14  2001/06/13  14:12:18  eric
 *  Modif commentaires (mise en conformite Doc++ 3.4.7)
 *
 * Revision 2.13  2001/02/07  09:33:42  eric
 * Suppression des fonctions derent_ent et derent_ent_p.
 * Ajout des fonctions donnant les derivees de l'EOS:
 *  der_nbar_ent
 *  der_ener_ent
 *  der_press_ent
 *
 * Revision 2.12  2000/11/23  14:45:33  eric
 * Ajout de l'EOS Eos_strange_cr.
 *
 * Revision 2.11  2000/11/22  19:28:45  eric
 * Ajout de #include "eos_tabul.h" a la fin.
 *
 * Revision 2.10  2000/10/25  10:55:08  eric
 * Eos_strange: modif commentaires.
 *
 * Revision 2.9  2000/10/24  15:28:43  eric
 * Ajout de l'EOS matiere etrange (Eos_strange).
 *
 * Revision 2.8  2000/06/20  08:34:20  eric
 * Ajout des membres get_gam(), ... a Eos_ploy
 *
 * Revision 2.7  2000/02/14  14:43:22  eric
 * Modif commentaires.
 *
 * Revision 2.6  2000/02/14  14:32:46  eric
 * Ajout des constructeurs par lecture de fichier formate.
 *
 * Revision 2.5  2000/01/21  16:21:12  eric
 * Modif commentaires.
 *
 * Revision 2.4  2000/01/21  15:16:10  eric
 * Ajout de la fonction identify()
 * Ajout de la fonction de construction a partir d'un fichier
 *   static Eos* Eos::eos_from_file(FILE* ).
 * Ajout des operateurs de comparaison == et !=
 *
 * Revision 2.3  2000/01/18  16:10:57  eric
 * Ajout des EOS Eos_incomp et Eos_incomp_newt.
 *
 * Revision 2.2  2000/01/18  15:13:28  eric
 * Ajout de l'equation d'etat Eos_poly_newt.
 *
 * Revision 2.1  2000/01/18  13:46:50  eric
 * Premiere version operationnelle
 *
 * Revision 2.0  2000/01/18  10:46:08  eric
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/eos.h,v 1.17 2011/06/16 10:49:18 j_novak Exp $
 *
 */

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

// Headers C
#include <stdio.h>

// Lorene classes
class Tbl ;
class Cmp ;
class Scalar ;
class Param ;

            //------------------------------------//
            //      base class Eos        //
            //------------------------------------//

class Eos {

    // Data :
    // -----

    protected: 
    char name[100] ;        


    // Constructors - Destructor
    // -------------------------
    protected:
    Eos() ;         

    explicit Eos(const char* name_i) ; 

    Eos(const Eos& ) ;  

    protected:
    Eos(FILE* ) ; 

    Eos(ifstream& ) ; 
    
    
    public:
    virtual ~Eos() ;            


    // Name manipulation
    // -----------------
    public:
    const char* get_name() const ;  

    void set_name(const char* name_i) ; 
    
    // Miscellaneous
    // -------------
    public:
    static Eos* eos_from_file(FILE* ) ; 
    
    static Eos* eos_from_file(ifstream& ) ; 
    
    virtual bool operator==(const Eos& ) const = 0 ; 

    virtual bool operator!=(const Eos& ) const = 0 ; 
    
    virtual int identify() const = 0 ; 

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

    public: 
    virtual void sauve(FILE* ) const ;  

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

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


    // Computational functions
    // -----------------------
    protected:
    void calcule(const Cmp& thermo, int nzet, int l_min,
             double (Eos::*fait)(double, const Param*) const, const Param* par, Cmp& resu) const ;

    void calcule(const Scalar& thermo, int nzet, int l_min,
             double (Eos::*fait)(double, const Param*) const, const Param* par, Scalar& resu) const ;

    public:
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const = 0 ;

        Cmp nbar_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const  ;

        Scalar nbar_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const  ;

        virtual double ener_ent_p(double ent, const Param* par=0x0) const = 0 ;

        Cmp ener_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;
 
    Scalar ener_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

        virtual double press_ent_p(double ent, const Param* par=0x0) const = 0 ;


        Cmp press_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

        Scalar press_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const = 0 ;

        Cmp der_nbar_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

    Scalar der_nbar_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const = 0 ;

        Cmp der_ener_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;
  
    Scalar der_ener_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

        virtual double der_press_ent_p(double ent, const Param* par=0x0) const = 0 ;

        Cmp der_press_ent(const Cmp& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

    Scalar der_press_ent(const Scalar& ent, int nzet, int l_min = 0, const Param* par=0x0) const ;

};
ostream& operator<<(ostream& , const Eos& ) ;   


            //------------------------------------//
            //      class Eos_poly        //
            //------------------------------------//


class Eos_poly : public Eos {

    // Data :
    // -----

    protected:
    double gam ;

    double kap ; 

    double m_0 ;

        double mu_0 ;



    double gam1 ;       
    double unsgam1 ;    
    double gam1sgamkap ; 
        double rel_mu_0 ;       
        double ent_0 ;          

    // Constructors - Destructor
    // -------------------------
    public:

    Eos_poly(double gamma, double kappa) ;

    Eos_poly(double gamma, double kappa, double mass) ;

    Eos_poly(double gamma, double kappa, double mass, double mu_zero) ;

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

    Eos_poly(ifstream& ) ;

    friend Eos* Eos::eos_from_file(FILE* ) ;
    friend Eos* Eos::eos_from_file(ifstream& ) ; 

    public:
    virtual ~Eos_poly() ;           

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


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

    public :
    virtual bool operator==(const Eos& ) const ;

    virtual bool operator!=(const Eos& ) const ;

    virtual int identify() const ; 

    double get_gam() const ;

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

    double get_mu_0() const ;

    protected:
    void set_auxiliary() ;


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

    public:
    virtual void sauve(FILE* ) const ;  

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


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

    public:
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ;

        virtual double ener_ent_p(double ent, const Param* par=0x0) const ;

        virtual double press_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ;
       
};

            //------------------------------------//
            //      class Eos_poly_newt   //
            //------------------------------------//



class Eos_poly_newt : public Eos_poly {

    // Data :
    // -----

    // no new data with respect to Eos_poly 

    // Constructors - Destructor
    // -------------------------
    public:
    
    Eos_poly_newt(double gamma, double kappa) ; 

    Eos_poly_newt(const Eos_poly_newt& ) ;  

    protected:
    Eos_poly_newt(FILE* ) ; 
    
    Eos_poly_newt(ifstream& ) ; 
    
    friend Eos* Eos::eos_from_file(FILE* ) ; 
    friend Eos* Eos::eos_from_file(ifstream& ) ; 


    public:
    virtual ~Eos_poly_newt() ;          

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

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

    public : 
    virtual bool operator==(const Eos& ) const ; 

    virtual bool operator!=(const Eos& ) const ; 
    
    virtual int identify() const ; 

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

    public: 
    virtual void sauve(FILE* ) const ;  

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


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

    public: 
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ; 
    
        virtual double ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double press_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ; 
       
};


            //------------------------------------//
            //      class Eos_incomp      //
            //------------------------------------//


class Eos_incomp : public Eos {

    // Data :
    // -----

    protected: 
    double rho0 ;
    
    double ent0 ;   

    // Constructors - Destructor
    // -------------------------
    public:
    
    Eos_incomp(double rho_c) ;  

    Eos_incomp(double rho_c, double ent_c) ;    

    Eos_incomp(const Eos_incomp& ) ;    

    protected:
    Eos_incomp(FILE* ) ; 
    
    Eos_incomp(ifstream& ) ; 
    
    friend Eos* Eos::eos_from_file(FILE* ) ; 
    friend Eos* Eos::eos_from_file(ifstream& ) ; 

    public:
    virtual ~Eos_incomp() ;         

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

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

    public : 
    virtual bool operator==(const Eos& ) const ; 

    virtual bool operator!=(const Eos& ) const ; 
    
    virtual int identify() const ; 

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

    public: 
    virtual void sauve(FILE* ) const ;  

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


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

    public: 
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ; 
    
        virtual double ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double press_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ; 

};

            //------------------------------------//
            //     class Eos_incomp_newt      //
            //------------------------------------//


class Eos_incomp_newt : public Eos_incomp {

    // Data :
    // -----

    // no new data with respect to Eos_incomp
    
    // Constructors - Destructor
    // -------------------------
    public:
    
    Eos_incomp_newt(double rho_c) ; 

    Eos_incomp_newt(double rho_c, double ent_c) ;   

    Eos_incomp_newt(const Eos_incomp_newt& ) ;  

    protected:
    Eos_incomp_newt(FILE* ) ; 
    
    Eos_incomp_newt(ifstream& ) ; 
    
    friend Eos* Eos::eos_from_file(FILE* ) ; 
    friend Eos* Eos::eos_from_file(ifstream& ) ; 

    public:
    virtual ~Eos_incomp_newt() ;            

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

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

    public : 
    virtual bool operator==(const Eos& ) const ; 

    virtual bool operator!=(const Eos& ) const ; 
    
    virtual int identify() const ; 

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

    public: 
    virtual void sauve(FILE* ) const ;  

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


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

    public: 
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ; 
    
        virtual double ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double press_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ; 
       
};


            //------------------------------------//
            //      class Eos_strange     //
            //------------------------------------//


class Eos_strange : public Eos {

    // Data :
    // -----

    protected: 
    double n0_b60 ; 
    
    double b60 ;
    
    double ent0 ;   
    
    double eps_fit ; 
    
    double rho0_b60 ; 
    
    double n0 ; 
    
    double rho0 ; 

    double b34 ;
    
    double fach ; 

    // Constructors - Destructor
    // -------------------------
    public:
    
    Eos_strange(double n0_b60_i, double b60_i, double ent0_i, 
            double eps_fit_i, double rho0_b60_i) ;  


    Eos_strange(const Eos_strange& ) ;  
    
    protected:
    Eos_strange(FILE* ) ; 
    
    Eos_strange(ifstream& ) ; 
    
    friend Eos* Eos::eos_from_file(FILE* ) ; 
    friend Eos* Eos::eos_from_file(ifstream& ) ; 

    public:
    virtual ~Eos_strange() ;            

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


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

    public : 
    virtual bool operator==(const Eos& ) const ; 

    virtual bool operator!=(const Eos& ) const ; 
    
    virtual int identify() const ; 

    double get_n0_b60() const {return n0_b60;} ; 
    
    double get_b60() const {return b60;} ;
    
    double get_ent0() const {return ent0;} ;    
    
    double get_eps_fit() const {return eps_fit;} ; 
    
    double get_rho0_b60() const {return rho0_b60;} ; 
    
    protected:
    void set_auxiliary() ; 
    

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

    public: 
    virtual void sauve(FILE* ) const ;  

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


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

    public: 
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ; 
    
        virtual double ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double press_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ; 

};


            //------------------------------------//
            //      class Eos_strange_cr      //
            //------------------------------------//


class Eos_strange_cr : public Eos {

    // Data :
    // -----

    protected:
    double n0_b60 ;
    
    double b60 ;
    
    double ent0 ;   
    
    double eps_fit ;
    
    double rho0_b60 ;
    
     double ent_nd ;
    
     double rho_nd ;
    
    double gam ;

    // Derived data:
    // -------------

    double n0 ;
    
    double rho0 ;

    double b34 ;
    
    double fach ;
    
     double rho_nd_nucl ;
    
    double x_nd ;

    double ncr_nd ;

    double delent ;

    double unsgam1 ;

    double gam1sx ;

    
    // Constructors - Destructor
    // -------------------------
    public:

    Eos_strange_cr(double n0_b60_i, double b60_i, double ent0_i,
            double eps_fit_i, double rho0_b60_i,
            double ent_nd_i, double rho_nd_i,
            double gam_i) ; 


    Eos_strange_cr(const Eos_strange_cr& ) ; 
    
    protected:
    Eos_strange_cr(FILE* ) ;
    
    Eos_strange_cr(ifstream& ) ;
    
    friend Eos* Eos::eos_from_file(FILE* ) ;
    friend Eos* Eos::eos_from_file(ifstream& ) ;

    public:
    virtual ~Eos_strange_cr() ;     

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


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

    public :
    virtual bool operator==(const Eos& ) const ;

    virtual bool operator!=(const Eos& ) const ;

    virtual int identify() const ;

    double get_n0_b60() const {return n0_b60;} ;
    
    double get_b60() const {return b60;} ;
    
    double get_ent0() const {return ent0;} ;    
    
    double get_eps_fit() const {return eps_fit;} ;
    
    double get_rho0_b60() const {return rho0_b60;} ;
    
    double get_ent_nd() const {return ent_nd;} ;
    
    double get_rho_nd() const {return rho_nd;} ;
    
    double get_gam() const {return gam;} ;
    


    protected:
    void set_auxiliary() ;


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

    public:
    virtual void sauve(FILE* ) const ;  

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


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

    public:
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ;

        virtual double ener_ent_p(double ent, const Param* par=0x0) const ;

        virtual double press_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ; 
       
        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ;

};


                //------------------------------//
                //  EOS with domain dependency //
              //------------------------------//

class MEos : public Eos {

    // Data :
    // -----

    protected:
    const Eos** mono_eos ;

    int ndom ;

    bool constructed_from_file ;

    // Constructors - Destructor
    // -------------------------
    public:

    MEos(int ndom_i, const Eos** mono_eos_i) ;

        MEos(const Eos& eos1, const Eos& eos2) ;

        MEos(const Eos& eos1, const Eos& eos2, const Eos& eos3) ;

       MEos(const Eos& eos1, const Eos& eos2, const Eos& eos3, const Eos& eos4) ;

    MEos(const MEos& ) ;    

    protected:
    MEos(FILE* ) ;

    MEos(ifstream& ) ;

    friend Eos* Eos::eos_from_file(FILE* ) ;
    friend Eos* Eos::eos_from_file(ifstream& ) ;

    public:
    virtual ~MEos() ;           

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


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

    public :
    virtual bool operator==(const Eos& ) const ;

    virtual bool operator!=(const Eos& ) const ;

    virtual int identify() const ;

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

    public:
    virtual void sauve(FILE* ) const ;  

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


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

    public:
        virtual double nbar_ent_p(double ent, const Param* par=0x0) const ;

        virtual double ener_ent_p(double ent, const Param* par=0x0) const ;

        virtual double press_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_nbar_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_ener_ent_p(double ent, const Param* par=0x0) const ;

        virtual double der_press_ent_p(double ent, const Param* par=0x0) const ;

};


        //------------------//
        //  Remaining EOS   //
        //------------------//
        
#include "eos_tabul.h"
#include "eos_mag.h"        

#endif

---