star_bhns.h

/*
 *  Definition of Lorene class Star_bhns
 *
 */

/*
 *   Copyright (c) 2005-2007 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 __STAR_BHNS_H_ 
#define __STAR_BHNS_H_ 

/*
 * $Id: star_bhns.h,v 1.3 2014/10/13 08:52:36 j_novak Exp $
 * $Log: star_bhns.h,v $
 * Revision 1.3  2014/10/13 08:52:36  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.2  2008/05/15 18:55:55  k_taniguchi
 * Change of some parameters.
 *
 * Revision 1.1  2007/06/22 01:04:35  k_taniguchi
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/star_bhns.h,v 1.3 2014/10/13 08:52:36 j_novak Exp $
 *
 */

// Lorene headers
#include "star.h"

namespace Lorene {

// External classes which appear in the declaration of class Star_bhns:
class Hole_bhns ; 

class Star_bhns : public Star {

    // Data : 
    // -----
    protected:
        Map_af mp_aff ;

    bool irrotational ;

    Scalar psi0 ;

    Vector d_psi ;

    Vector wit_w ;

    Scalar loggam ;

    Vector bsn ;

    Scalar gam ;

    Scalar gam0 ;

    Scalar pot_centri ;

        Scalar lapconf_auto ;

    Scalar lapconf_comp ;

    Scalar lapconf_tot ;

        Scalar lapse_auto ;  // = lapconf_auto / confo_tot

    Scalar lapse_tot ;

    Vector d_lapconf_auto ;

    Vector d_lapconf_comp ;

    Vector shift_auto ;

    Vector shift_comp ;

    Vector shift_tot ;

    Tensor d_shift_auto ;

    Tensor d_shift_comp ;

    Scalar confo_auto ;

    Scalar confo_comp ;

    Scalar confo_tot ;

    Vector d_confo_auto ;

    Vector d_confo_comp ;

    Scalar psi4 ;  // psi4 = pow(confo_tot, 4.)

    Sym_tensor taij_auto ;

    Scalar taij_quad_auto ;

    Metric_flat flat ;

    Scalar ssjm1_lapconf ;

    Scalar ssjm1_confo ;

    Scalar ssjm1_khi ;

    Vector ssjm1_wshift ;

    // Derived data
    // ------------
    protected:
    mutable double* p_mass_b_bhns ;  
    mutable double* p_mass_g_bhns ;  

    // Constructors - Destructor
    // -------------------------
    public:
    Star_bhns(Map& mp_i, int nzet_i, const Eos& eos_i, bool irrot_i) ;

    Star_bhns(const Star_bhns& ) ;      

    Star_bhns(Map& mp_i, const Eos& eos_i, FILE* fich) ;

    virtual ~Star_bhns() ;          
 

    // Memory management
    // -----------------
    protected:
    virtual void del_deriv() const ;

    void set_der_0x0() const ;

    // Mutators / assignment
    // ---------------------
    public:
    void operator=(const Star_bhns&) ;

    Scalar& set_pot_centri() ;

    Scalar& set_lapconf_auto() ;

    Scalar& set_lapconf_comp() ;

    Vector& set_shift_auto() ;

    Vector& set_shift_comp() ;

    Scalar& set_confo_auto() ;

    Scalar& set_confo_comp() ;
    
    // Accessors
    // ---------
    public:
    bool is_irrotational() const {return irrotational; } ;

    const Scalar& get_psi0() const {return psi0; } ;

    const Vector& get_d_psi() const {return d_psi; } ;

    const Vector& get_wit_w() const {return wit_w; } ;

    const Scalar& get_loggam() const {return loggam; } ;

    const Vector& get_bsn() const {return bsn; } ;

    const Scalar& get_gam() const {return gam; } ;

    const Scalar& get_gam0() const {return gam0; } ;

    const Scalar& get_pot_centri() const {return pot_centri; } ;

    const Scalar& get_lapconf_auto() const {return lapconf_auto; } ;

    const Scalar& get_lapconf_comp() const {return lapconf_comp; } ;

    const Scalar& get_lapconf_tot() const {return lapconf_tot; } ;

    // Returns the part of the lapse function generated by the star
    const Scalar& get_lapse_auto() const {return lapse_auto; } ;

    const Scalar& get_lapse_tot() const {return lapse_tot; } ;

    const Vector& get_d_lapconf_auto() const {return d_lapconf_auto; } ;

    const Vector& get_d_lapconf_comp() const {return d_lapconf_comp; } ;

    const Vector& get_shift_auto() const {return shift_auto; } ;

    const Vector& get_shift_comp() const {return shift_comp; } ;

    const Vector& get_shift_tot() const {return shift_tot; } ;

    const Tensor& get_d_shift_auto() const {return d_shift_auto; } ;

    const Tensor& get_d_shift_comp() const {return d_shift_comp; } ;

    const Scalar& get_confo_auto() const {return confo_auto; } ;

    const Scalar& get_confo_comp() const {return confo_comp; } ;

    const Scalar& get_confo_tot() const {return confo_tot; } ;

    const Vector& get_d_confo_auto() const {return d_confo_auto; } ;

    const Vector& get_d_confo_comp() const {return d_confo_comp; } ;

    const Scalar& get_psi4() const {return psi4; } ;

    const Sym_tensor& get_taij_auto() const {return taij_auto; } ;

    const Scalar& get_taij_quad_auto() const {return taij_quad_auto; } ;

    // Outputs
    // -------
    public:
    virtual void sauve(FILE *) const ;      

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

    // Global quantities
    // -----------------
    public:
    virtual double mass_b() const ;

    virtual double mass_b_bhns(bool kerrschild, const double& mass_bh,
                   const double& sepa) const ;

    virtual double mass_g() const ;

    virtual double mass_g_bhns() const ;

    // Computational routines
    // ----------------------
    public:
    void hydro_euler_bhns(bool kerrschild, const double& mass_bh,
                  const double& sepa) ;

    void update_metric_bhns(const Hole_bhns& hole,
                const Star_bhns& star_prev,
                double relax) ;

    void update_met_der_comp_bhns(const Hole_bhns& hole) ;

    void kinema_bhns(bool kerrschild, const double& mass_bh,
             const double& sepa, double omega,
             double x_rot, double y_rot) ;

    void fait_d_psi_bhns() ;

    void extr_curv_bhns() ;

    void equilibrium_bhns(double ent_c, const double& mass_bh,
                  const double& sepa, bool kerrschild,
                  int mer, int mermax_ns, int mermax_potvit,
                  int mermax_poisson, int filter_r, int filter_r_s,
                  int filter_p_s, double relax_poisson,
                  double relax_potvit, double thres_adapt,
                  double resize_ns,
                  const Tbl& fact_resize, Tbl& diff) ;

    double velo_pot_bhns(const double& mass_bh, const double& sepa,
                 bool kerrschild,
                 int mermax, double precis, double relax) ;

    double chi_rp(double radius, double phi) ;

    double radius_p(double phi) ;

    double phi_min() ;

    double phi_local_min(double phi_ini) ;

    void relax_bhns(const Star_bhns& star_prev, double relax_ent,
            double relax_met, int mer, int fmer_met) ;

    void equil_spher_bhns(double ent_c, double precis) ;

    friend class Bin_bhns ;

};

}
#endif