# Lorene::Etoile Class Reference [Stars and black holes]

Base class for stars *** DEPRECATED : use class Star instead ***. More...

#include <etoile.h>

Inheritance diagram for Lorene::Etoile:

List of all members.

## Public Member Functions

Etoile (Map &mp_i, int nzet_i, bool relat, const Eos &eos_i)
Standard constructor.
Etoile (const Etoile &)
Copy constructor.
Etoile (Map &mp_i, const Eos &eos_i, FILE *fich)
Constructor from a file (see sauve(FILE*) ).
virtual ~Etoile ()
Destructor.
void operator= (const Etoile &)
Assignment to another Etoile.
Mapset_mp ()
void set_enthalpy (const Cmp &)
Assignment of the enthalpy field.
virtual void equation_of_state ()
Computes the proper baryon and energy density, as well as pressure from the enthalpy.
virtual void hydro_euler ()
Computes the hydrodynamical quantities relative to the Eulerian observer from those in the fluid frame (nbar , ener and press ).
virtual void equilibrium_spher (double ent_c, double precis=1.e-14, const Tbl *ent_limit=0x0)
Computes a spherical static configuration.
void equil_spher_regular (double ent_c, double precis=1.e-14)
Computes a spherical static configuration.
virtual void equil_spher_falloff (double ent_c, double precis=1.e-14)
Computes a spherical static configuration with the outer boundary condition at a finite radius.
const Mapget_mp () const
Returns the mapping.
int get_nzet () const
Returns the number of domains occupied by the star.
bool is_relativistic () const
Returns true for a relativistic star, false for a Newtonian one.
const Eosget_eos () const
Returns the equation of state.
const Tenseurget_ent () const
Returns the enthalpy field.
const Tenseurget_nbar () const
Returns the proper baryon density.
const Tenseurget_ener () const
Returns the proper total energy density.
const Tenseurget_press () const
Returns the fluid pressure.
const Tenseurget_ener_euler () const
Returns the total energy density with respect to the Eulerian observer.
const Tenseurget_s_euler () const
Returns the trace of the stress tensor in the Eulerian frame.
const Tenseurget_gam_euler () const
Returns the Lorentz factor between the fluid and Eulerian observers.
const Tenseurget_u_euler () const
Returns the fluid 3-velocity with respect to the Eulerian observer.
const Tenseurget_logn_auto () const
Returns the logarithm of the part of the lapse N generated principaly by the star.
const Tenseurget_logn_auto_regu () const
Returns the regular part of the logarithm of the part of the lapse N generated principaly by the star.
const Tenseurget_logn_auto_div () const
Returns the divergent part of the logarithm of the part of the lapse N generated principaly by the star.
const Tenseurget_d_logn_auto_div () const
Returns the gradient of logn_auto_div.
const Tenseurget_beta_auto () const
Returns the logarithm of the part of the product AN generated principaly by the star.
const Tenseurget_nnn () const
Returns the total lapse function N.
const Tenseurget_shift () const
Returns the total shift vector .
const Tenseurget_a_car () const
Returns the total conformal factor .
virtual void sauve (FILE *) const
Save in a file.
double ray_eq () const
double ray_eq_pis2 () const
double ray_eq_pi () const
double ray_eq_3pis2 () const
double ray_pole () const
double ray_eq (int kk) const
virtual const Itbll_surf () const
Description of the stellar surface: returns a 2-D Itbl containing the values of the domain index l on the surface at the collocation points in .
const Tblxi_surf () const
Description of the stellar surface: returns a 2-D Tbl containing the values of the radial coordinate on the surface at the collocation points in .
virtual double mass_b () const
Baryon mass.
virtual double mass_g () const
Gravitational mass.

## Protected Member Functions

virtual void del_deriv () const
Deletes all the derived quantities.
virtual void set_der_0x0 () const
Sets to 0x0 all the pointers on derived quantities.
virtual void del_hydro_euler ()
Sets to ETATNONDEF (undefined state) the hydrodynamical quantities relative to the Eulerian observer.
virtual ostream & operator>> (ostream &) const
Operator >> (virtual function called by the operator <<).

## Protected Attributes

Mapmp
Mapping associated with the star.
int nzet
Number of domains of *mp occupied by the star.
bool relativistic
Indicator of relativity: true for a relativistic star, false for a Newtonian one.
double unsurc2
: unsurc2=1 for a relativistic star, 0 for a Newtonian one.
int k_div
Index of regularity of the gravitational potential logn_auto .
const Eoseos
Equation of state of the stellar matter.
Tenseur ent
Log-enthalpy (relativistic case) or specific enthalpy (Newtonian case).
Tenseur nbar
Baryon density in the fluid frame.
Tenseur ener
Total energy density in the fluid frame.
Tenseur press
Fluid pressure.
Tenseur ener_euler
Total energy density in the Eulerian frame.
Tenseur s_euler
Trace of the stress tensor in the Eulerian frame.
Tenseur gam_euler
Lorentz factor between the fluid and Eulerian observers.
Tenseur u_euler
Fluid 3-velocity with respect to the Eulerian observer.
Tenseur logn_auto
Total of the logarithm of the part of the lapse N generated principaly by the star.
Tenseur logn_auto_regu
Regular part of the logarithm of the part of the lapse N generated principaly by the star.
Tenseur logn_auto_div
Divergent part (if k_div!=0 ) of the logarithm of the part of the lapse N generated principaly by the star.
Tenseur d_logn_auto_div
Gradient of logn_auto_div (if k_div!=0 ).
Tenseur beta_auto
Logarithm of the part of the product AN generated principaly by by the star.
Tenseur nnn
Total lapse function.
Tenseur shift
Total shift vector.
Tenseur a_car
Total conformal factor .
double * p_ray_eq
double * p_ray_eq_pis2
double * p_ray_eq_pi
double * p_ray_eq_3pis2
double * p_ray_pole
Itblp_l_surf
Description of the stellar surface: 2-D Itbl containing the values of the domain index l on the surface at the collocation points in .
Tblp_xi_surf
Description of the stellar surface: 2-D Tbl containing the values of the radial coordinate on the surface at the collocation points in .
double * p_mass_b
Baryon mass.
double * p_mass_g
Gravitational mass.

## Friends

ostream & operator<< (ostream &, const Etoile &)
Display.

## Detailed Description

Base class for stars *** DEPRECATED : use class Star instead ***.

()

An Etoile is constructed upon (i) a mapping (derived class of Map ), the center of which defines the center of the star, and (ii) an equation of state (derived class of Eos ). It contains tensor fields (class Tenseur ) which describle the hydrodynamical quantities as well as the gravitational field (spacetime metric).

According to the 3+1 formalism, the spacetime metric is written

where is a 3-metric, the exact form of which is specified in the derived classes of Etoile . The base class Etoile by itself provides only storage for the lapse function N (member nnn ), the shift vector (member shift ) and the conformal factor (member a_car ).

The 3+1 formalism introduces two kinds of priviledged observers: the fluid comoving observer and the Eulerian observer, whose 4-velocity is the unit future directed normal to the t = const hypersurfaces. The hydrodynamical quantities measured by the fluid observer correspond to the members ent , nbar , ener , and press . The hydrodynamical quantities measured by the Eulerian observer correspond to the members ener_euler , s_euler , gam_euler , and u_euler .

A star of class Etoile can be either relativistic or Newtonian, depending on the boolean indicator relativistic . For a Newtonian star, the metric coefficients N and A are set to 1, and is set to zero; the only relevant gravitational quantity in this case is logn_auto which represents the (regular part of) the Newtonian gravitational potential generated by the star.

Definition at line 424 of file etoile.h.

## Constructor & Destructor Documentation

 Lorene::Etoile::Etoile ( Map & mp_i, int nzet_i, bool relat, const Eos & eos_i )

Standard constructor.

Parameters:
 mp_i Mapping on which the star will be defined nzet_i Number of domains occupied by the star relat should be true for a relativistic star, false for a Newtonian one eos_i Equation of state of the stellar matter

Definition at line 146 of file etoile.C.

 Lorene::Etoile::Etoile ( const Etoile & et )

Copy constructor.

Definition at line 248 of file etoile.C.

References set_der_0x0().

 Lorene::Etoile::Etoile ( Map & mp_i, const Eos & eos_i, FILE * fich )

Constructor from a file (see sauve(FILE*) ).

Parameters:
 mp_i Mapping on which the star will be defined eos_i Equation of state of the stellar matter fich input file (must have been created by the function sauve )

Definition at line 278 of file etoile.C.

 Lorene::Etoile::~Etoile ( )  [virtual]

Destructor.

Definition at line 370 of file etoile.C.

References del_deriv().

## Member Function Documentation

 void Lorene::Etoile::del_deriv ( ) const [protected, virtual]

Deletes all the derived quantities.

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Et_rot_mag, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 381 of file etoile.C.

 void Lorene::Etoile::del_hydro_euler ( )  [protected, virtual]

Sets to ETATNONDEF (undefined state) the hydrodynamical quantities relative to the Eulerian observer.

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Et_rot_mag, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 413 of file etoile.C.

References del_deriv(), ener_euler, gam_euler, s_euler, Lorene::Tenseur::set_etat_nondef(), and u_euler.

 void Lorene::Etoile::equation_of_state ( )  [virtual]

Computes the proper baryon and energy density, as well as pressure from the enthalpy.

Reimplemented in Lorene::Et_rot_bifluid, and Lorene::Et_magnetisation.

Definition at line 569 of file etoile.C.

 void Lorene::Etoile::equil_spher_falloff ( double ent_c, double precis = 1.e-14 )  [virtual]

Computes a spherical static configuration with the outer boundary condition at a finite radius.

Parameters:
 ent_c [input] central value of the enthalpy precis [input] threshold in the relative difference between the enthalpy fields of two consecutive steps to stop the iterative procedure (default value: 1.e-14)

Definition at line 60 of file etoile_eqsph_falloff.C.

 void Lorene::Etoile::equil_spher_regular ( double ent_c, double precis = 1.e-14 )

Computes a spherical static configuration.

The sources for Poisson equations are regularized by extracting analytical diverging parts.

Parameters:
 ent_c [input] central value of the enthalpy precis [input] threshold in the relative difference between the enthalpy fields of two consecutive steps to stop the iterative procedure (default value: 1.e-14)

Definition at line 118 of file et_equil_spher_regu.C.

 void Lorene::Etoile::equilibrium_spher ( double ent_c, double precis = 1.e-14, const Tbl * ent_limit = 0x0 )  [virtual]

Computes a spherical static configuration.

Parameters:
 ent_c [input] central value of the enthalpy precis [input] threshold in the relative difference between the enthalpy fields of two consecutive steps to stop the iterative procedure (default value: 1.e-14) ent_limit [input] : array of enthalpy values to be set at the boundaries between the domains; if set to 0x0 (default), the initial values will be kept.

Definition at line 90 of file etoile_equil_spher.C.

 const Tenseur& Lorene::Etoile::get_a_car ( ) const [inline]

Returns the total conformal factor .

Definition at line 733 of file etoile.h.

References a_car.

 const Tenseur& Lorene::Etoile::get_beta_auto ( ) const [inline]

Returns the logarithm of the part of the product AN generated principaly by the star.

Definition at line 724 of file etoile.h.

References beta_auto.

 const Tenseur& Lorene::Etoile::get_d_logn_auto_div ( ) const [inline]

Returns the gradient of logn_auto_div.

Definition at line 719 of file etoile.h.

References d_logn_auto_div.

 const Tenseur& Lorene::Etoile::get_ener ( ) const [inline]

Returns the proper total energy density.

Definition at line 679 of file etoile.h.

References ener.

 const Tenseur& Lorene::Etoile::get_ener_euler ( ) const [inline]

Returns the total energy density with respect to the Eulerian observer.

Definition at line 685 of file etoile.h.

References ener_euler.

 const Tenseur& Lorene::Etoile::get_ent ( ) const [inline]

Returns the enthalpy field.

Definition at line 673 of file etoile.h.

References ent.

 const Eos& Lorene::Etoile::get_eos ( ) const [inline]

Returns the equation of state.

Reimplemented in Lorene::Et_rot_bifluid.

Definition at line 670 of file etoile.h.

References eos.

 const Tenseur& Lorene::Etoile::get_gam_euler ( ) const [inline]

Returns the Lorentz factor between the fluid and Eulerian observers.

Definition at line 691 of file etoile.h.

References gam_euler.

 const Tenseur& Lorene::Etoile::get_logn_auto ( ) const [inline]

Returns the logarithm of the part of the lapse N generated principaly by the star.

In the Newtonian case, this is the Newtonian gravitational potential (in units of ).

Definition at line 701 of file etoile.h.

References logn_auto.

 const Tenseur& Lorene::Etoile::get_logn_auto_div ( ) const [inline]

Returns the divergent part of the logarithm of the part of the lapse N generated principaly by the star.

In the Newtonian case, this is the diverging part of the Newtonian gravitational potential (in units of ).

Definition at line 715 of file etoile.h.

References logn_auto_div.

 const Tenseur& Lorene::Etoile::get_logn_auto_regu ( ) const [inline]

Returns the regular part of the logarithm of the part of the lapse N generated principaly by the star.

In the Newtonian case, this is the Newtonian gravitational potential (in units of ).

Definition at line 708 of file etoile.h.

References logn_auto_regu.

 const Map& Lorene::Etoile::get_mp ( ) const [inline]

Returns the mapping.

Definition at line 659 of file etoile.h.

References mp.

 const Tenseur& Lorene::Etoile::get_nbar ( ) const [inline]

Returns the proper baryon density.

Definition at line 676 of file etoile.h.

References nbar.

 const Tenseur& Lorene::Etoile::get_nnn ( ) const [inline]

Returns the total lapse function N.

Definition at line 727 of file etoile.h.

References nnn.

 int Lorene::Etoile::get_nzet ( ) const [inline]

Returns the number of domains occupied by the star.

Definition at line 662 of file etoile.h.

References nzet.

 const Tenseur& Lorene::Etoile::get_press ( ) const [inline]

Returns the fluid pressure.

Definition at line 682 of file etoile.h.

References press.

 const Tenseur& Lorene::Etoile::get_s_euler ( ) const [inline]

Returns the trace of the stress tensor in the Eulerian frame.

Definition at line 688 of file etoile.h.

References s_euler.

 const Tenseur& Lorene::Etoile::get_shift ( ) const [inline]

Returns the total shift vector .

Definition at line 730 of file etoile.h.

References shift.

 const Tenseur& Lorene::Etoile::get_u_euler ( ) const [inline]

Returns the fluid 3-velocity with respect to the Eulerian observer.

Definition at line 694 of file etoile.h.

References u_euler.

 void Lorene::Etoile::hydro_euler ( )  [virtual]

Computes the hydrodynamical quantities relative to the Eulerian observer from those in the fluid frame (nbar , ener and press ).

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Et_rot_diff, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 687 of file etoile.C.

 bool Lorene::Etoile::is_relativistic ( ) const [inline]

Returns true for a relativistic star, false for a Newtonian one.

Definition at line 667 of file etoile.h.

References relativistic.

 const Itbl & Lorene::Etoile::l_surf ( ) const [virtual]

Description of the stellar surface: returns a 2-D Itbl containing the values of the domain index l on the surface at the collocation points in .

The stellar surface is defined as the location where the enthalpy (member ent ) vanishes.

Reimplemented in Lorene::Et_rot_bifluid, and Lorene::Etoile_rot.

Definition at line 78 of file etoile_global.C.

 double Lorene::Etoile::mass_b ( ) const [virtual]

Baryon mass.

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 528 of file etoile_global.C.

References Lorene::Tenseur::get_etat(), nbar, p_mass_b, and relativistic.

 double Lorene::Etoile::mass_g ( ) const [virtual]

Gravitational mass.

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Et_rot_mag, Lorene::Et_magnetisation, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 554 of file etoile_global.C.

References mass_b(), p_mass_g, and relativistic.

 void Lorene::Etoile::operator= ( const Etoile & et )

Assignment to another Etoile.

Definition at line 433 of file etoile.C.

 ostream & Lorene::Etoile::operator>> ( ostream & ost ) const [protected, virtual]

Operator >> (virtual function called by the operator <<).

Definition at line 514 of file etoile.C.

References a_car, ener, ent, eos, k_div, mass_b(), mass_g(), nbar, nnn, nzet, press, ray_eq(), ray_eq_pi(), ray_eq_pis2(), ray_pole(), and relativistic.

 double Lorene::Etoile::ray_eq ( int kk ) const

Definition at line 443 of file etoile_global.C.

 double Lorene::Etoile::ray_eq ( ) const

Definition at line 123 of file etoile_global.C.

 double Lorene::Etoile::ray_eq_3pis2 ( ) const

Definition at line 338 of file etoile_global.C.

 double Lorene::Etoile::ray_eq_pi ( ) const

Definition at line 259 of file etoile_global.C.

 double Lorene::Etoile::ray_eq_pis2 ( ) const

Definition at line 172 of file etoile_global.C.

 double Lorene::Etoile::ray_pole ( ) const

Definition at line 418 of file etoile_global.C.

 void Lorene::Etoile::sauve ( FILE * fich ) const [virtual]

Save in a file.

Definition at line 486 of file etoile.C.

 void Lorene::Etoile::set_der_0x0 ( ) const [protected, virtual]

Sets to 0x0 all the pointers on derived quantities.

Reimplemented in Lorene::Et_rot_bifluid, Lorene::Et_rot_mag, Lorene::Etoile_bin, and Lorene::Etoile_rot.

Definition at line 399 of file etoile.C.

References p_l_surf, p_mass_b, p_mass_g, p_ray_eq, p_ray_eq_3pis2, p_ray_eq_pi, p_ray_eq_pis2, p_ray_pole, and p_xi_surf.

 void Lorene::Etoile::set_enthalpy ( const Cmp & ent_i )

Assignment of the enthalpy field.

Definition at line 468 of file etoile.C.

References del_deriv(), ent, and equation_of_state().

 Map& Lorene::Etoile::set_mp ( )  [inline]

Definition at line 601 of file etoile.h.

References mp.

 const Tbl & Lorene::Etoile::xi_surf ( ) const

Description of the stellar surface: returns a 2-D Tbl containing the values of the radial coordinate on the surface at the collocation points in .

The stellar surface is defined as the location where the enthalpy (member ent ) vanishes.

Definition at line 104 of file etoile_global.C.

References l_surf(), p_l_surf, and p_xi_surf.

## Friends And Related Function Documentation

 ostream& operator<< ( ostream & , const Etoile & )  [friend]

Display.

## Member Data Documentation

 Tenseur Lorene::Etoile::a_car [protected]

Total conformal factor .

Definition at line 515 of file etoile.h.

 Tenseur Lorene::Etoile::beta_auto [protected]

Logarithm of the part of the product AN generated principaly by by the star.

Definition at line 506 of file etoile.h.

 Tenseur Lorene::Etoile::d_logn_auto_div [protected]

Gradient of logn_auto_div (if k_div!=0 ).

Definition at line 501 of file etoile.h.

 Tenseur Lorene::Etoile::ener [protected]

Total energy density in the fluid frame.

Definition at line 460 of file etoile.h.

 Tenseur Lorene::Etoile::ener_euler [protected]

Total energy density in the Eulerian frame.

Definition at line 465 of file etoile.h.

 Tenseur Lorene::Etoile::ent [protected]

Log-enthalpy (relativistic case) or specific enthalpy (Newtonian case).

Definition at line 457 of file etoile.h.

 const Eos& Lorene::Etoile::eos [protected]

Equation of state of the stellar matter.

Reimplemented in Lorene::Et_rot_bifluid.

Definition at line 451 of file etoile.h.

 Tenseur Lorene::Etoile::gam_euler [protected]

Lorentz factor between the fluid and Eulerian observers.

Definition at line 471 of file etoile.h.

 int Lorene::Etoile::k_div [protected]

Index of regularity of the gravitational potential logn_auto .

If k_div=0 , logn_auto contains the total potential generated principaly by the star, otherwise it should be supplemented by logn_auto_div .

Definition at line 449 of file etoile.h.

 Tenseur Lorene::Etoile::logn_auto [protected]

Total of the logarithm of the part of the lapse N generated principaly by the star.

In the Newtonian case, this is the Newtonian gravitational potential (in units of ).

Definition at line 484 of file etoile.h.

 Tenseur Lorene::Etoile::logn_auto_div [protected]

Divergent part (if k_div!=0 ) of the logarithm of the part of the lapse N generated principaly by the star.

Definition at line 497 of file etoile.h.

 Tenseur Lorene::Etoile::logn_auto_regu [protected]

Regular part of the logarithm of the part of the lapse N generated principaly by the star.

In the Newtonian case, this is the Newtonian gravitational potential (in units of ).

Definition at line 491 of file etoile.h.

 Map& Lorene::Etoile::mp [protected]

Mapping associated with the star.

Definition at line 429 of file etoile.h.

 Tenseur Lorene::Etoile::nbar [protected]

Baryon density in the fluid frame.

Definition at line 459 of file etoile.h.

 Tenseur Lorene::Etoile::nnn [protected]

Total lapse function.

Definition at line 509 of file etoile.h.

 int Lorene::Etoile::nzet [protected]

Number of domains of *mp occupied by the star.

Definition at line 432 of file etoile.h.

 Itbl* Lorene::Etoile::p_l_surf [mutable, protected]

Description of the stellar surface: 2-D Itbl containing the values of the domain index l on the surface at the collocation points in .

Definition at line 539 of file etoile.h.

 double* Lorene::Etoile::p_mass_b [mutable, protected]

Baryon mass.

Definition at line 547 of file etoile.h.

 double* Lorene::Etoile::p_mass_g [mutable, protected]

Gravitational mass.

Definition at line 548 of file etoile.h.

 double* Lorene::Etoile::p_ray_eq [mutable, protected]

Definition at line 521 of file etoile.h.

 double* Lorene::Etoile::p_ray_eq_3pis2 [mutable, protected]

Definition at line 530 of file etoile.h.

 double* Lorene::Etoile::p_ray_eq_pi [mutable, protected]

Definition at line 527 of file etoile.h.

 double* Lorene::Etoile::p_ray_eq_pis2 [mutable, protected]

Definition at line 524 of file etoile.h.

 double* Lorene::Etoile::p_ray_pole [mutable, protected]

Definition at line 533 of file etoile.h.

 Tbl* Lorene::Etoile::p_xi_surf [mutable, protected]

Description of the stellar surface: 2-D Tbl containing the values of the radial coordinate on the surface at the collocation points in .

Definition at line 545 of file etoile.h.

 Tenseur Lorene::Etoile::press [protected]

Fluid pressure.

Definition at line 461 of file etoile.h.

 bool Lorene::Etoile::relativistic [protected]

Indicator of relativity: true for a relativistic star, false for a Newtonian one.

Definition at line 437 of file etoile.h.

 Tenseur Lorene::Etoile::s_euler [protected]

Trace of the stress tensor in the Eulerian frame.

Definition at line 468 of file etoile.h.

 Tenseur Lorene::Etoile::shift [protected]

Total shift vector.

Definition at line 512 of file etoile.h.

 Tenseur Lorene::Etoile::u_euler [protected]

Fluid 3-velocity with respect to the Eulerian observer.

Definition at line 474 of file etoile.h.

 double Lorene::Etoile::unsurc2 [protected]

: unsurc2=1 for a relativistic star, 0 for a Newtonian one.

Definition at line 442 of file etoile.h.

The documentation for this class was generated from the following files:

Generated on 7 Dec 2019 for LORENE by  1.6.1