eos_mag.h

/*
 *  Definition of Lorene classes Eos_mag
 */

/*
 *   Copyright (c) 2011 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 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_MAG_H_
#define __EOS_MAG_H_

/*
 * $Id: eos_mag.h,v 1.5 2021/05/14 15:39:22 g_servignat Exp $
 * $Log: eos_mag.h,v $
 * Revision 1.5  2021/05/14 15:39:22  g_servignat
 * Added sound speed computation from enthalpy to Eos class and tabulated+polytropic derived classes
 *
 * Revision 1.4  2014/10/13 08:52:33  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.3  2013/12/13 16:36:51  j_novak
 * Addition and computation of magnetisation terms in the Einstein equations.
 *
 * Revision 1.2  2011/10/04 16:05:18  j_novak
 * Update of Eos_mag class. Suppression of loge, re-definition of the derivatives
 * and use of interpol_herm_2d.
 *
 * Revision 1.1  2011/06/16 10:49:18  j_novak
 * New class Eos_mag for EOSs depending on density and magnetic field.
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/eos_mag.h,v 1.5 2021/05/14 15:39:22 g_servignat Exp $
 *
 */

// Standard C++
#include "headcpp.h"
#include <string>

// Headers C
#include <cstdio>

// Lorene classes
namespace Lorene {
class Tbl ;
class Cmp ;

        
            //------------------------------------//
            //      class Eos_mag         //
            //------------------------------------//


class Eos_mag : public Eos {

    // Data :
    // -----

    protected:
        string tablename ;
        
        double hmin ;
        
        double hmax ;
        
        double Bmax ;
        
        Tbl* logp ;
        
        Tbl* logh ;
        
        Tbl* Bfield ;
        
        Tbl* dlpsdlh ;
        
        Tbl* dlpsdB ;
        
        Tbl* d2lp ;
                
                
    // Constructors - Destructor
    // -------------------------
    protected:

    Eos_mag(const char* name_i, const char* table, const char* path) ;  

    Eos_mag(const char* name_i, const char* file_name) ;

    Eos_mag(const Eos_mag& ) ;  
    
    protected:
    
    Eos_mag(FILE* ) ;
    
    Eos_mag(ifstream& ist, const char* table) ;
    
    Eos_mag(ifstream& ist) ;
    
    friend Eos* Eos::eos_from_file(FILE* ) ;
    friend Eos* Eos::eos_from_file(ifstream& ) ;

    public:
    virtual ~Eos_mag() ;            


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

    protected:  
        void read_table() ;

     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:
    double mag_ent_p(double ent, const Param* par=0x0) const ;

        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 ; 

        virtual double der_press_nbar_p(double ent, const Param* par=0x0) const ; 
    
    virtual double csound_square_ent_p(double, const Param*) const {
        c_est_pas_fait(__FILE__) ;
        return 0;
    } ;
};


}
#endif