et_rot_bifluid.h

/*
 *  Definition of Lorene class Et_rot_bifluid
 *
 */

/*
 *   Copyright (c) 2001 Jerome Novak
 *             (c) 2015 Aurelien Sourie
 *
 *   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 __ET_ROT_BIFLUID_H_ 
#define __ET_ROT_BIFLUID_H_ 

/*
 * $Id: et_rot_bifluid.h,v 1.21 2017/10/06 12:36:33 a_sourie Exp $
 * $Log: et_rot_bifluid.h,v $
 * Revision 1.21  2017/10/06 12:36:33  a_sourie
 * Cleaning of tabulated 2-fluid EoS class + superfluid rotating star model.
 *
 * Revision 1.20  2015/06/26 14:10:08  j_novak
 * Modified comments.
 *
 * Revision 1.19  2015/06/11 13:50:18  j_novak
 * Minor corrections
 *
 * Revision 1.18  2015/06/10 14:39:17  a_sourie
 * New class Eos_bf_tabul for tabulated 2-fluid EoSs and associated functions for the computation of rotating stars with such EoSs.
 *
 * Revision 1.17  2014/10/13 08:52:34  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.16  2013/11/25 13:50:55  j_novak
 * The inheritance from Etoile_rot is no longer virtual.
 *
 * Revision 1.15  2011/10/06 14:55:36  j_novak
 * equation_of_state() is now virtual to be able to call to the magnetized
 * Eos_mag.
 *
 * Revision 1.14  2004/09/01 10:56:05  r_prix
 * added option of converging baryon-mass to equilibrium_bi()
 *
 * Revision 1.13  2004/03/22 13:12:41  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.12  2003/12/04 14:13:32  r_prix
 * added method get_typeos {return typeos}; and fixed some comments.
 *
 * Revision 1.11  2003/11/20 14:01:45  r_prix
 * changed member names to better conform to Lorene coding standards:
 * J_euler -> j_euler, EpS_euler -> enerps_euler, Delta_car -> delta_car
 *
 * Revision 1.10  2003/11/18 18:32:36  r_prix
 * added new class-member: EpS_euler := ener_euler + s_euler
 * has the advantage of a nice Newtonian limit -> rho
 * (ener_euler is no longer used in this class!)
 *
 * Revision 1.9  2003/11/13 12:02:03  r_prix
 * - adapted/extended some of the documentation
 * - changed xxx2 -> Delta_car
 * - added members J_euler, sphph_euler, representing 3+1 components of Tmunu
 *   (NOTE: these are not 2-fluid specific, and should ideally be moved into Class Etoile!)
 *
 * Revision 1.8  2003/09/17 08:27:50  j_novak
 * New methods: mass_b1() and mass_b2().
 *
 * Revision 1.7  2002/10/09 07:54:29  j_novak
 * Et_rot_bifluid and Et_rot_mag inheritate virtually from Etoile_rot
 *
 * Revision 1.6  2002/09/13 09:17:33  j_novak
 * Modif. commentaires
 *
 * Revision 1.5  2002/04/05 09:09:36  j_novak
 * The inversion of the EOS for 2-fluids polytrope has been modified.
 * Some errors in the determination of the surface were corrected.
 *
 * Revision 1.4  2002/01/16 15:03:28  j_novak
 * *** empty log message ***
 *
 * Revision 1.3  2002/01/08 14:43:53  j_novak
 * better determination of surfaces for 2-fluid stars
 *
 * Revision 1.2  2002/01/03 15:30:27  j_novak
 * Some comments modified.
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 1.3  2001/10/03  09:49:06  novak
 * *** empty log message ***
 *
 * Revision 1.2  2001/08/28 14:14:10  novak
 * overrided l_surf function
 *
 * Revision 1.1  2001/06/22 15:38:52  novak
 * Initial revision
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/et_rot_bifluid.h,v 1.21 2017/10/06 12:36:33 a_sourie Exp $
 *
 */

// Headers Lorene
#include "eos_bifluid.h"
#include "etoile.h"

namespace Lorene {

  // Local prototype (for determining the surface)
  Cmp prolonge_c1(const Cmp& uu, const int nzet) ;
  
  class Et_rot_bifluid : public Etoile_rot {
    
    // Data : 
    // -----
  protected:
    const Eos_bifluid& eos ; 
    
    double omega2 ; 
    
    // Fluid quantities with respect to the fluid frame
    // ------------------------------------------------
    
    Tenseur ent2 ;
    
    Tenseur nbar2 ; 
    
    Tenseur K_nn ;  
    Tenseur K_np ;  
    Tenseur K_pp ;  
    Tenseur alpha_eos ;  

    // Fluid quantities with respect to the Eulerian frame
    // ---------------------------------------------------
    
    // FIXME: the following three variables are not specific to 2-fluid stars
    //  and should ideally be moved to class Etoile!
    
    Tenseur sphph_euler;
    
    Tenseur j_euler;
    
    Tenseur j_euler1; 
    Tenseur j_euler2; 
    
    Tenseur enerps_euler;
    
    Tenseur uuu2 ;
    
    Tenseur gam_euler2 ;
    
    Tenseur delta_car ; 
    
    // Derived data : 
    // ------------
  protected:
    mutable double* p_ray_eq2 ; 
    
    mutable double* p_ray_eq2_pis2 ;
    
    mutable double* p_ray_eq2_pi ;
    
    mutable double* p_ray_pole2 ;
    
    mutable Itbl* p_l_surf2 ; 
    
    mutable Tbl* p_xi_surf2 ; 
    
    mutable double* p_r_circ2 ; 
    mutable double* p_area2 ;   
    mutable double* p_aplat2 ;  
    
    mutable double* p_mass_b1 ; 
    mutable double* p_mass_b2 ; 
    
    mutable double* p_angu_mom_1;   
    mutable double* p_angu_mom_2;   
   
    mutable double* p_coupling_mominert_1;  
    mutable double* p_coupling_mominert_2;  
    mutable double* p_coupling_entr;        
    mutable double* p_coupling_LT_1;        
    mutable double* p_coupling_LT_2;        

    
    // Constructors - Destructor
    // -------------------------
  public:
    
    Et_rot_bifluid(Map& mp_i, int nzet_i, bool relat, 
           const Eos_bifluid& eos_i) ;     
    
    Et_rot_bifluid(const Et_rot_bifluid& ) ;       
    
    Et_rot_bifluid(Map& mp_i, const Eos_bifluid& eos_i, FILE* fich) ;    
    
    virtual ~Et_rot_bifluid() ;         
    
    // Memory management
    // -----------------
  protected:
    
    virtual void del_deriv() const ; 
    
    virtual void set_der_0x0() const ; 
    
    virtual void del_hydro_euler() ; 
    
    // Mutators / assignment
    // ---------------------
  public:
    
    void operator=(const Et_rot_bifluid&) ; 
    
    void set_enthalpies(const Cmp&, const Cmp&) ;
    
    void equilibrium_spher_bi(double ent_c, double ent_c2, 
                  double precis = 1.e-14) ;
    
    void equil_spher_regular(double ent_c, double ent_c2, 
                 double precis = 1.e-14) ;
    
    // Accessors
    // ---------
  public:
    
    const Eos_bifluid& get_eos() const {return eos; } ;
    
    const Tenseur& get_ent2() const {return ent2 ; } ;
    
    const Tenseur& get_nbar2() const {return nbar2 ; } ;
    
    const Tenseur& get_K_nn() const {return K_nn ; } ;
    
    const Tenseur& get_K_np() const {return K_np ; } ;
    
    const Tenseur& get_K_pp() const {return K_pp ; } ;
    
    const Tenseur& get_alpha_eos() const {return alpha_eos ; } ;    

    const Tenseur& get_delta_car() const {return delta_car ; } ;
    
    const Tenseur& get_gam_euler2() const {return gam_euler2 ; } ;
    
    double get_omega2() const {return omega2 ; } ;

    const Tenseur& get_uuu2() const {return uuu2 ; } ;
    
    // Outputs
    // -------
  public:
    virtual void sauve(FILE *) const ;      
    
    virtual ostream& operator>>(ostream& ) const ;    
    
    virtual void partial_display(ostream& ) const ;    
    
    // Global quantities
    // -----------------
  public:
    
    virtual const Itbl& l_surf() const ; 
    
    const Itbl& l_surf2() const ; 
    
    const Tbl& xi_surf2() const ; 

    double ray_eq2() const ; 
    
    double ray_eq2_pis2() const ; 
    
    double ray_eq2_pi() const ; 
    
    double ray_pole2() const ; 
    
    double mass_b1() const ;
    
    double mass_b2() const ;
    
    virtual double mass_b() const ; 
    virtual double mass_g() const ; 
    virtual double angu_mom() const ;   
    
    virtual double grv2() const ;       
    
    virtual double grv3(ostream* ost = 0x0) const ; 
    
    virtual double r_circ2() const ;       
    virtual double area2() const ;         
    virtual double mean_radius2() const ;  
    virtual double aplat2() const ;        

    virtual double mom_quad() const ;   
    
    virtual double mom_quad_old() const ;
    
    virtual double mom_quad_Bo() const ;
    
    virtual double angu_mom_1() const ; 
    virtual double angu_mom_2() const ; 
    
    virtual double coupling_mominert_1() const ;
    virtual double coupling_mominert_2() const ;
    virtual double coupling_entr() const ;
    virtual double coupling_LT_1() const ;
    virtual double coupling_LT_2() const ;

    // Computational routines
    // ----------------------
  public: 
    virtual void hydro_euler() ; 
    
    virtual void equation_of_state() ; 
    
    void equilibrium_bi(double ent_c, double ent_c2, double omega0, 
            double omega20, const Tbl& ent_limit, 
            const Tbl& ent2_limit, const Itbl& icontrol, 
            const Tbl& control, Tbl& diff,
            int mer_mass, double mbar1_wanted, double mbar2_wanted, 
            double aexp_mass);
  };
  
}
#endif