eos_compose.h

/*
 *  Definition of Lorene classes Eos_CompOSE
 *                               Eos_consistent
 */

/*
 *   Copyright (c) 2014-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 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_COMPOSE_H_
#define __EOS_COMPOSE_H_

/*
 * $Id: eos_compose.h,v 1.6 2021/05/31 11:31:23 g_servignat Exp $
 * $Log: eos_compose.h,v $
 * Revision 1.6  2021/05/31 11:31:23  g_servignat
 * Added csound_square_ent routine to calculate the sound speed from enthalpy to Eos_consistent and corrected error outputs
 *
 * 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  2021/05/06 14:33:17  j_novak
 * New conversion function from Eos to Dyn_eos.
 *
 * Revision 1.3  2019/04/09 12:50:22  j_novak
 * Improved documentation
 *
 * Revision 1.2  2019/03/28 13:41:01  j_novak
 * Improved managed of saved EoS (functions sauve and constructor form FILE*)
 *
 * Revision 1.1  2015/08/04 14:41:28  j_novak
 * Back to previous version for Eos_CompOSE. Enthalpy-consistent EoS can be accessed using Eos_consistent class (derived from Eos_CompOSE).
 *
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/eos_compose.h,v 1.6 2021/05/31 11:31:23 g_servignat Exp $
 *
 */

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

// Headers C
#include <cstdio>

// Lorene classes
namespace Lorene {
class Tbl ;


            //------------------------------------//
            //       class Eos_CompOSE            //
            //------------------------------------//


class Eos_CompOSE : public Eos_tabul {

  // Data
  //--------
  
 protected:
  int format ; 
  
  // Constructors - Destructor
  // -------------------------
 public:
  
  Eos_CompOSE(const string& files_path) ;
  
  Eos_CompOSE(const char* file_name) ;  

    
 protected:
  Eos_CompOSE(FILE* ) ;
  
  Eos_CompOSE(ifstream&) ;
  
 private:   
  Eos_CompOSE(const Eos_CompOSE& ) ;    
  
    
  friend Eos* Eos::eos_from_file(FILE* ) ;
  friend Eos* Eos::eos_from_file(ifstream& ) ;
  
 public:
  virtual ~Eos_CompOSE() ;          

  // Miscellaneous
  // -------------
public:
  int get_format() const {return format ;} ;
  
 protected:     
  virtual void read_compose_data() ;

 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 ;    
  
  
};

            //------------------------------------//
            //       class Eos_consistent         //
            //------------------------------------//


class Eos_consistent : public Eos_CompOSE {

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

  Eos_consistent(const string& files_path) ;
  
  Eos_consistent(const char* file_name) ;   

    
 protected:
  Eos_consistent(FILE* ) ;
  
  Eos_consistent(ifstream&) ;
  
 private:   
  Eos_consistent(const Eos_consistent& ) ;  
  
    
  friend Eos* Eos::eos_from_file(FILE* ) ;
  friend Eos* Eos::eos_from_file(ifstream& ) ;
  
 public:
  virtual ~Eos_consistent() ;           
  
  // Miscellaneous
  // -------------
  
 public :
  virtual bool operator==(const Eos& ) const ;
  
  virtual bool operator!=(const Eos& ) const ;
  
  virtual int identify() const ;
  
 protected:     
  virtual void read_table() ;
  
  virtual void read_compose_data() ;

  // Outputs
  // -------
  
 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 csound_square_ent_p(double, const Param*) const ;
};



}
#endif