eos_multi_poly.h

/*
 *  Definition of Lorene class Eos_multi_poly
 *
 */

/*
 *   Copyright (c) 2009 Keisuke Taniguchi
 *   Copyright (c) 2004 Keisuke Taniguchi
 *
 *   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 __EOS_MULTI_POLY_H_
#define __EOS_MULTI_POLY_H_

/*
 * $Id: eos_multi_poly.h,v 1.7 2021/05/14 15:39:22 g_servignat Exp $
 * $Log: eos_multi_poly.h,v $
 * Revision 1.7  2021/05/14 15:39:22  g_servignat
 * Added sound speed computation from enthalpy to Eos class and tabulated+polytropic derived classes
 *
 * Revision 1.6  2014/10/13 08:52:33  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.5  2014/10/06 15:09:39  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.4  2009/06/23 14:33:31  k_taniguchi
 * Completely revised.
 *
 * Revision 1.3  2004/05/14 11:35:17  k_taniguchi
 * Minor changes in some comments.
 *
 * Revision 1.2  2004/05/07 13:04:01  j_novak
 * Forgotten #include<assert.h>
 *
 * Revision 1.1  2004/05/07 08:09:56  k_taniguchi
 * Initial revision
 *
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/eos_multi_poly.h,v 1.7 2021/05/14 15:39:22 g_servignat Exp $
 *
 */

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

// Headers C
#include <cstdio>
#include <cassert>

// Lorene classes
#include "eos.h"
#include "param.h"
namespace Lorene {
class Tbl ;
class Cmp ;
class Param ;
class Eos ;

           //-------------------------------------------//
           //   base class Eos for multiple polytrope   //
           //-------------------------------------------//

class Eos_multi_poly : public Eos {

    // Data : 
    // -----

    protected:
    int npeos ;

    double* gamma ;

    double kappa0 ;

    double logP1 ;

    double* logRho ;

    double* kappa ;

    double* nbCrit ;

    double* entCrit ;

    double* decInc ;

    double m0 ;

        double* mu0 ;


    // Constructors - Destructor
    // -------------------------
    public:
    Eos_multi_poly(int npoly, double* gamma_i, double kappa0_i,
               double logP1_i, double* logRho_i, double* decInc_i) ;

    Eos_multi_poly(const Eos_multi_poly& ) ;     

    protected:
    Eos_multi_poly(FILE* ) ;            

    Eos_multi_poly(ifstream& ) ;

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

    public:
    virtual ~Eos_multi_poly() ;         
 

    // Assignment
    // ----------
    public:
    void operator=(const Eos_multi_poly&) ; 

    //  double& set_kappa(int n) ;


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

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

    virtual int identify() const ;

    const int& get_npeos() const { return npeos ; } ;

    const double& get_gamma(int n) const { 
        assert(n>=0 && n<npeos) ;
        return gamma[n] ;
    } ;

    const double& get_kappa0() const { return kappa0 ; } ;

    const double& get_logP1() const { return logP1 ; } ;

    const double& get_logRho(int n) const {
        assert(n>=0 && n<npeos-1) ;
        return logRho[n] ;
    } ;

    const double& get_kappa(int n) const { 
        assert(n>=0 && n<npeos) ;
        return kappa[n] ;
    } ;

    const double& get_nbCrit(int n) const { 
        assert(n>=0 && n<npeos-1) ;
        return nbCrit[n] ;
    } ;

    const double& get_entCrit(int n) const { 
        assert(n>=0 && n<npeos-1) ;
        return entCrit[n] ;
    } ;

    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 ;

        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