Lorene::Bin_ns_ncp Class Reference

Extended description of the class for Doc++ documentation. More...

#include <bin_ns_ncp.h>

List of all members.

Public Member Functions

 Bin_ns_ncp (Map &mp1, int nzet1, const Eos &eos1, int irrot1, Map &mp2, int nzet2, const Eos &eos2, int irrot2, int relat, int conf_flat, const Metrique &flat1, const Metrique &flat2, const Tenseur_sym &source1, const Tenseur_sym &source2)
 Standard constructor.
 Bin_ns_ncp (const Bin_ns_ncp &)
 Bin_ns_ncp (Map &mp1, const Eos &eos1, Map &mp2, const Eos &eos2, const Metrique &flat1, const Metrique &flat2, FILE *fich)
 Copy constructor.
void operator= (const Bin_ns_ncp &)
 Assignment to another { Bin_ns_ncp}.
Et_bin_ncp & set (int i)
 Read/write of the star no. i.
double & set_omega ()
 Sets the orbital angular velocity [{ f}].
double & set_x_axe ()
 Sets the absolute coordinate X of the rotation axis [{ r}].
const Et_bin_ncp & operator() (int i) const
 Returns a reference to the star no. i.
double get_omega () const
 Returns the orbital angular velocity [{ f}].
double get_x_axe () const
 Returns the absolute coordinate X of the rotation axis [{ r}].
double separation () const
 Returns the coordinate separation of the two stellar centers [{ r}].
void sauve (FILE *) const
void display_poly (ostream &) const
 Display in polytropic units.
void write_global (ostream &) const
 Write global quantities in a formatted file.
double mass_adm () const
 Total ADM mass.
double mass_kom () const
 Total Komar mass.
const Tblangu_mom () const
 Total angular momentum.
double total_ener () const
 Total energy (excluding the rest mass energy).
double virial () const
 Estimates the relative error on the virial theorem (for a relativistic one, it returns $|1 - M_{ Komar} / M_{ ADM}|$).
double virial_gb () const
 Estimates the relative error on the virial theorem calculated by E.Gourgoulhon and S.Bonazzola (Class.
double virial_fus () const
 Estimates the relative error on the virial theorem calculated by J.L.Friedman, K.Uryu, and M.Shibata (PRD accepted, gr-qc/0108070).
double ham_constr () const
 Estimates the relative error on the Hamiltonian constraint equation by comparing $ A$ with {equation} -4 A^2 E - {A^2 4} K_{ij} K^{ij} - {1 2} {}_i A {}^i A {equation}.
const Tblmom_constr () const
 Estimates the relative error on the momentum constraint equation by comparing ${}_j K^{ij}$ with {equation} 8 J^i - 5 K^{ij} {}_j A {equation}.
void orbit (double fact_omeg_min, double fact_omeg_max, double &xgg1, double &xgg2)
 Computes the orbital angular velocity { omega} and the position of the rotation axis { x}.
void analytical_omega ()
 Sets the orbital angular velocity to some 2-PN analytical value (Keplerian value in the Newtonian case).
void analytical_shift ()
 Sets some analytical template for the shift vector (via the members { w} and { khi} of the two { Etoile}.
void fait_decouple ()
 Calculates {tt decouple} which is used to obtain { a_car} by the formula : { a_car} = { decouple} * { a_car}.

Protected Member Functions

void del_deriv () const
 Destructor.
void set_der_0x0 () const
 Sets to { 0x0} all the pointers on derived quantities.

Protected Attributes

Et_bin_ncp star1
 First star ncp of the system.
Et_bin_ncp star2
 Second star ncp of the system.
Et_bin_ncp * et [2]
 Array of the two stars (to perform loops on the stars): { et[0]} contains the address of { star1} and { et[1]} that of { star2}.
double omega
 Angular velocity with respect to an asymptotically inertial observer.
double x_axe
 Absolute X coordinate of the rotation axis.
double * p_mass_adm
 Total ADM mass of the system.
double * p_mass_kom
 Total Komar mass of the system.
Tblp_angu_mom
 Total angular momentum of the system.
double * p_total_ener
 Total energy of the system.
double * p_virial
 Virial theorem error.
double * p_virial_gb
 Virial theorem error by E.Gourgoulhon and S.Bonazzola.
double * p_virial_fus
 Virial theorem error by J.L.Friedman, K.Uryu, and M.Shibata.
double * p_ham_constr
 Relative error on the Hamiltonian constraint.
Tblp_mom_constr
 Relative error on the momentum constraint.

Private Member Functions

ostream & operator>> (ostream &) const
 Operator >> (function called by the operator <<).

Friends

ostream & operator<< (ostream &, const Bin_ns_ncp &)
 Save in a file.

Detailed Description

Extended description of the class for Doc++ documentation.

Version:
$Id: bin_ns_ncp.h,v 1.9 2017/02/24 15:34:59 j_novak Exp $#

Definition at line 76 of file bin_ns_ncp.h.


Constructor & Destructor Documentation

Lorene::Bin_ns_ncp::Bin_ns_ncp ( Map mp1,
int  nzet1,
const Eos eos1,
int  irrot1,
Map mp2,
int  nzet2,
const Eos eos2,
int  irrot2,
int  relat,
int  conf_flat,
const Metrique &  flat1,
const Metrique &  flat2,
const Tenseur_sym source1,
const Tenseur_sym source2 
)

Standard constructor.

Parameters:
mp1 Mapping on which { star1} will be defined
nzet1 Number of domains occupied by { star1}
eos1 Equation of state of { star1}
irrot1 should be { true} if { star1} is irrotational, { false} if { star1} is corotating
mp2 Mapping on which { star2} will be defined
nzet2 Number of domains occupied by { star2}
eos2 Equation of state of { star2}
irrot2 should be { true} if { star2} is irrotational, { false} if { star2} is corotating
relat should be { true} for a relativistic configuration, { false} for a Newtonian one
Lorene::Bin_ns_ncp::Bin_ns_ncp ( Map mp1,
const Eos eos1,
Map mp2,
const Eos eos2,
const Metrique &  flat1,
const Metrique &  flat2,
FILE *  fich 
)

Copy constructor.

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

Parameters:
mp1 Mapping on which { star1} will be defined
eos1 Equation of state of { star1}
mp2 Mapping on which { star2} will be defined
eos2 Equation of state of { star2}
fich input file (must have been created by the function { sauve})

Member Function Documentation

void Lorene::Bin_ns_ncp::analytical_omega (  ) 

Sets the orbital angular velocity to some 2-PN analytical value (Keplerian value in the Newtonian case).

void Lorene::Bin_ns_ncp::analytical_shift (  ) 

Sets some analytical template for the shift vector (via the members { w} and { khi} of the two { Etoile}.

const Tbl& Lorene::Bin_ns_ncp::angu_mom (  )  const

Total angular momentum.

Returns:
1-D { Tbl} of size 3, according to \ { angu()(0)} = $J^X$, \ { angu()(1)} = $J^Y$, \ { angu()(2)} = $J^Z$.
void Lorene::Bin_ns_ncp::del_deriv (  )  const [protected]

Destructor.

Deletes all the derived quantities

void Lorene::Bin_ns_ncp::display_poly ( ostream &   )  const

Display in polytropic units.

void Lorene::Bin_ns_ncp::fait_decouple (  ) 

Calculates {tt decouple} which is used to obtain { a_car} by the formula : { a_car} = { decouple} * { a_car}.

(see the membre {tt Cmp decouple} for more precisions about its value).

double Lorene::Bin_ns_ncp::get_omega (  )  const [inline]

Returns the orbital angular velocity [{ f}].

Definition at line 218 of file bin_ns_ncp.h.

References omega.

double Lorene::Bin_ns_ncp::get_x_axe (  )  const [inline]

Returns the absolute coordinate X of the rotation axis [{ r}].

Definition at line 221 of file bin_ns_ncp.h.

References x_axe.

double Lorene::Bin_ns_ncp::ham_constr (  )  const

Estimates the relative error on the Hamiltonian constraint equation by comparing $ A$ with {equation} -4 A^2 E - {A^2 4} K_{ij} K^{ij} - {1 2} {}_i A {}^i A {equation}.

double Lorene::Bin_ns_ncp::mass_adm (  )  const

Total ADM mass.

double Lorene::Bin_ns_ncp::mass_kom (  )  const

Total Komar mass.

const Tbl& Lorene::Bin_ns_ncp::mom_constr (  )  const

Estimates the relative error on the momentum constraint equation by comparing ${}_j K^{ij}$ with {equation} 8 J^i - 5 K^{ij} {}_j A {equation}.

const Et_bin_ncp& Lorene::Bin_ns_ncp::operator() ( int  i  )  const [inline]

Returns a reference to the star no. i.

Definition at line 213 of file bin_ns_ncp.h.

References et.

void Lorene::Bin_ns_ncp::operator= ( const Bin_ns_ncp  ) 

Assignment to another { Bin_ns_ncp}.

ostream& Lorene::Bin_ns_ncp::operator>> ( ostream &   )  const [private]

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

void Lorene::Bin_ns_ncp::orbit ( double  fact_omeg_min,
double  fact_omeg_max,
double &  xgg1,
double &  xgg2 
)

Computes the orbital angular velocity { omega} and the position of the rotation axis { x}.

Parameters:
fact_omeg_min [input] : determines the lower bound of the interval { [omega, omega]} in which { omega} is searched by { omega = fact * omega}, where { omega} is the previous value of the angular velocity (typical value : { fact = 0.5})
fact_omeg_max [input] : determines the higher bound of the interval { [omega, omega]} in which { omega} is searched by { omega = fact * omega}, where { omega} is the previous value of the angular velocity. (typical value : { fact = 1.5})
xgg1 [output] : x coordinate (relative to star 1 mapping) of the ``center of mass'' of star 1
xgg2 [output] : x coordinate (relative to star 2 mapping) of the ``center of mass'' of star 2
double Lorene::Bin_ns_ncp::separation (  )  const

Returns the coordinate separation of the two stellar centers [{ r}].

Et_bin_ncp& Lorene::Bin_ns_ncp::set ( int  i  )  [inline]

Read/write of the star no. i.

Definition at line 197 of file bin_ns_ncp.h.

References del_deriv(), and et.

void Lorene::Bin_ns_ncp::set_der_0x0 (  )  const [protected]

Sets to { 0x0} all the pointers on derived quantities.

double& Lorene::Bin_ns_ncp::set_omega (  )  [inline]

Sets the orbital angular velocity [{ f}].

Definition at line 203 of file bin_ns_ncp.h.

References omega.

double& Lorene::Bin_ns_ncp::set_x_axe (  )  [inline]

Sets the absolute coordinate X of the rotation axis [{ r}].

Definition at line 206 of file bin_ns_ncp.h.

References x_axe.

double Lorene::Bin_ns_ncp::total_ener (  )  const

Total energy (excluding the rest mass energy).

In the Newtonian case, it is defined as the sum of kinetic, internal, and gravitational potential energies.

In the relativistic case, it is defined as $M_{ ADM} - M_{ bar,1} - M_{ bar,2}$.

double Lorene::Bin_ns_ncp::virial (  )  const

Estimates the relative error on the virial theorem (for a relativistic one, it returns $|1 - M_{ Komar} / M_{ ADM}|$).

double Lorene::Bin_ns_ncp::virial_fus (  )  const

Estimates the relative error on the virial theorem calculated by J.L.Friedman, K.Uryu, and M.Shibata (PRD accepted, gr-qc/0108070).

The expression used in the LORENE is Eq.(5.7) in the paper by M.Shibata and K.Uryu (PRD64, 104017 (2001))

double Lorene::Bin_ns_ncp::virial_gb (  )  const

Estimates the relative error on the virial theorem calculated by E.Gourgoulhon and S.Bonazzola (Class.

Quantum Grav. 11, 443 (1994): Eq.(29)) normalized by $2 G$.

void Lorene::Bin_ns_ncp::write_global ( ostream &   )  const

Write global quantities in a formatted file.

This file can be read by an external program.


Friends And Related Function Documentation

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

Save in a file.


Member Data Documentation

Et_bin_ncp* Lorene::Bin_ns_ncp::et[2] [protected]

Array of the two stars (to perform loops on the stars): { et[0]} contains the address of { star1} and { et[1]} that of { star2}.

Definition at line 92 of file bin_ns_ncp.h.

double Lorene::Bin_ns_ncp::omega [protected]

Angular velocity with respect to an asymptotically inertial observer.

Definition at line 97 of file bin_ns_ncp.h.

Tbl* Lorene::Bin_ns_ncp::p_angu_mom [mutable, protected]

Total angular momentum of the system.

Definition at line 114 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_ham_constr [mutable, protected]

Relative error on the Hamiltonian constraint.

Definition at line 129 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_mass_adm [mutable, protected]

Total ADM mass of the system.

Definition at line 108 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_mass_kom [mutable, protected]

Total Komar mass of the system.

Definition at line 111 of file bin_ns_ncp.h.

Tbl* Lorene::Bin_ns_ncp::p_mom_constr [mutable, protected]

Relative error on the momentum constraint.

Definition at line 132 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_total_ener [mutable, protected]

Total energy of the system.

Definition at line 117 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_virial [mutable, protected]

Virial theorem error.

Definition at line 120 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_virial_fus [mutable, protected]

Virial theorem error by J.L.Friedman, K.Uryu, and M.Shibata.

Definition at line 126 of file bin_ns_ncp.h.

double* Lorene::Bin_ns_ncp::p_virial_gb [mutable, protected]

Virial theorem error by E.Gourgoulhon and S.Bonazzola.

Definition at line 123 of file bin_ns_ncp.h.

Et_bin_ncp Lorene::Bin_ns_ncp::star1 [protected]

First star ncp of the system.

Definition at line 83 of file bin_ns_ncp.h.

Et_bin_ncp Lorene::Bin_ns_ncp::star2 [protected]

Second star ncp of the system.

Definition at line 86 of file bin_ns_ncp.h.

double Lorene::Bin_ns_ncp::x_axe [protected]

Absolute X coordinate of the rotation axis.

Definition at line 101 of file bin_ns_ncp.h.


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

Generated on 7 Dec 2019 for LORENE by  doxygen 1.6.1