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

#include <bin_ns_ncp.h>

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. More...

	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. More...

void	operator= (const Bin_ns_ncp &)
	Assignment to another { Bin_ns_ncp}. More...

Et_bin_ncp &	set (int i)
	Read/write of the star no. i. More...

double &	set_omega ()
	Sets the orbital angular velocity [{ f_unit}]. More...

double &	set_x_axe ()
	Sets the absolute coordinate X of the rotation axis [{ r_unit}]. More...

const Et_bin_ncp &	operator() (int i) const
	Returns a reference to the star no. i. More...

double	get_omega () const
	Returns the orbital angular velocity [{ f_unit}]. More...

double	get_x_axe () const
	Returns the absolute coordinate X of the rotation axis [{ r_unit}]. More...

double	separation () const
	Returns the coordinate separation of the two stellar centers [{ r_unit}]. More...

void	sauve (FILE *) const

void	display_poly (ostream &) const
	Display in polytropic units. More...

void	write_global (ostream &) const
	Write global quantities in a formatted file. More...

double	mass_adm () const
	Total ADM mass. More...

double	mass_kom () const
	Total Komar mass. More...

const Tbl &	angu_mom () const
	Total angular momentum. More...

double	total_ener () const
	Total energy (excluding the rest mass energy). More...

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

double	virial_gb () const
	Estimates the relative error on the virial theorem calculated by E.Gourgoulhon and S.Bonazzola (Class. More...

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) More...

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}. More...

const Tbl &	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}. More...

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_axe}. More...

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

void	analytical_shift ()
	Sets some analytical template for the shift vector (via the members { w_shift} and { khi_shift} of the two { Etoile_bin}. More...

void	fait_decouple ()
	Calculates {tt decouple} which is used to obtain { a_car_auto} by the formula : { a_car_auto} = { decouple} * { a_car_tot}. More...

Protected Member Functions
void	del_deriv () const
	Destructor. More...

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

Protected Attributes
Et_bin_ncp	star1
	First star ncp of the system. More...

Et_bin_ncp	star2
	Second star ncp of the system. More...

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}. More...

double	omega
	Angular velocity with respect to an asymptotically inertial observer. More...

double	x_axe
	Absolute X coordinate of the rotation axis. More...

double *	p_mass_adm
	Total ADM mass of the system. More...

double *	p_mass_kom
	Total Komar mass of the system. More...

Tbl *	p_angu_mom
	Total angular momentum of the system. More...

double *	p_total_ener
	Total energy of the system. More...

double *	p_virial
	Virial theorem error. More...

double *	p_virial_gb
	Virial theorem error by E.Gourgoulhon and S.Bonazzola. More...

double *	p_virial_fus
	Virial theorem error by J.L.Friedman, K.Uryu, and M.Shibata. More...

double *	p_ham_constr
	Relative error on the Hamiltonian constraint. More...

Tbl *	p_mom_constr
	Relative error on the momentum constraint. More...

Private Member Functions
ostream &	operator>> (ostream &) const
	Operator >> (function called by the operator <<). More...

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

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

◆ Bin_ns_ncp() [1/2]

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

◆ Bin_ns_ncp() [2/2]

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

◆ analytical_omega()

void Lorene::Bin_ns_ncp::analytical_omega ( )

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

◆ analytical_shift()

void Lorene::Bin_ns_ncp::analytical_shift ( )

Sets some analytical template for the shift vector (via the members { w_shift} and { khi_shift} of the two { Etoile_bin}.

◆ angu_mom()

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

Total angular momentum.

Returns: 1-D { Tbl} of size 3, according to \ { angu_mom()(0)} = $J^X$, \ { angu_mom()(1)} = $J^Y$, \ { angu_mom()(2)} = $J^Z$.

◆ del_deriv()

void Lorene::Bin_ns_ncp::del_deriv ( ) const

protected

Destructor.

Deletes all the derived quantities

◆ display_poly()

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

Display in polytropic units.

◆ fait_decouple()

void Lorene::Bin_ns_ncp::fait_decouple ( )

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

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

◆ get_omega()

double Lorene::Bin_ns_ncp::get_omega ( ) const

inline

Returns the orbital angular velocity [{ f_unit}].

Definition at line 218 of file bin_ns_ncp.h.

References omega.

◆ get_x_axe()

double Lorene::Bin_ns_ncp::get_x_axe ( ) const

inline

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

Definition at line 221 of file bin_ns_ncp.h.

References x_axe.

◆ ham_constr()

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

◆ mass_adm()

double Lorene::Bin_ns_ncp::mass_adm ( ) const

Total ADM mass.

◆ mass_kom()

double Lorene::Bin_ns_ncp::mass_kom ( ) const

Total Komar mass.

◆ mom_constr()

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

◆ operator()()

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.

◆ operator=()

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

Assignment to another { Bin_ns_ncp}.

◆ operator>>()

ostream& Lorene::Bin_ns_ncp::operator>> ( ostream & ) const

private

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

◆ orbit()

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_axe}.

Parameters

fact_omeg_min	[input] : determines the lower bound of the interval { [omega_min, omega_max]} in which { omega} is searched by { omega_min = fact_omeg_min * omega}, where { omega} is the previous value of the angular velocity (typical value : { fact_omeg_min = 0.5})
fact_omeg_max	[input] : determines the higher bound of the interval { [omega_min, omega_max]} in which { omega} is searched by { omega_max = fact_omeg_max * omega}, where { omega} is the previous value of the angular velocity. (typical value : { fact_omeg_max = 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

◆ separation()

double Lorene::Bin_ns_ncp::separation ( ) const

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

◆ set()

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.

◆ set_der_0x0()

void Lorene::Bin_ns_ncp::set_der_0x0 ( ) const

protected

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

◆ set_omega()

double& Lorene::Bin_ns_ncp::set_omega ( )

inline

Sets the orbital angular velocity [{ f_unit}].

Definition at line 203 of file bin_ns_ncp.h.

References omega.

◆ set_x_axe()

double& Lorene::Bin_ns_ncp::set_x_axe ( )

inline

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

Definition at line 206 of file bin_ns_ncp.h.

References x_axe.

◆ total_ener()

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}$.

◆ virial()

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}|$)

◆ virial_fus()

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))

◆ virial_gb()

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$.

◆ write_global()

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

◆ operator<<

ostream& operator<<	(	ostream &	,
		const Bin_ns_ncp &
	)

friend

Save in a file.

Member Data Documentation

◆ et

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.

◆ omega

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.

◆ p_angu_mom

Tbl* Lorene::Bin_ns_ncp::p_angu_mom

mutableprotected

Total angular momentum of the system.

Definition at line 114 of file bin_ns_ncp.h.

◆ p_ham_constr

double* Lorene::Bin_ns_ncp::p_ham_constr

mutableprotected

Relative error on the Hamiltonian constraint.

Definition at line 129 of file bin_ns_ncp.h.

◆ p_mass_adm

double* Lorene::Bin_ns_ncp::p_mass_adm

mutableprotected

Total ADM mass of the system.

Definition at line 108 of file bin_ns_ncp.h.

◆ p_mass_kom

double* Lorene::Bin_ns_ncp::p_mass_kom

mutableprotected

Total Komar mass of the system.

Definition at line 111 of file bin_ns_ncp.h.

◆ p_mom_constr

Tbl* Lorene::Bin_ns_ncp::p_mom_constr

mutableprotected

Relative error on the momentum constraint.

Definition at line 132 of file bin_ns_ncp.h.

◆ p_total_ener

double* Lorene::Bin_ns_ncp::p_total_ener

mutableprotected

Total energy of the system.

Definition at line 117 of file bin_ns_ncp.h.

◆ p_virial

double* Lorene::Bin_ns_ncp::p_virial

mutableprotected

Virial theorem error.

Definition at line 120 of file bin_ns_ncp.h.

◆ p_virial_fus

double* Lorene::Bin_ns_ncp::p_virial_fus

mutableprotected

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

Definition at line 126 of file bin_ns_ncp.h.

◆ p_virial_gb

double* Lorene::Bin_ns_ncp::p_virial_gb

mutableprotected

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

Definition at line 123 of file bin_ns_ncp.h.

◆ star1

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.

◆ star2

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.

◆ x_axe

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:

bin_ns_ncp.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Bin_ns_ncp() [1/2]

◆ Bin_ns_ncp() [2/2]

Member Function Documentation

◆ analytical_omega()

◆ analytical_shift()

◆ angu_mom()

◆ del_deriv()

◆ display_poly()

◆ fait_decouple()

◆ get_omega()

◆ get_x_axe()

◆ ham_constr()

◆ mass_adm()

◆ mass_kom()

◆ mom_constr()

◆ operator()()

◆ operator=()

◆ operator>>()

◆ orbit()

◆ separation()

◆ set()

◆ set_der_0x0()

◆ set_omega()

◆ set_x_axe()

◆ total_ener()

◆ virial()

◆ virial_fus()

◆ virial_gb()

◆ write_global()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ et

◆ omega

◆ p_angu_mom

◆ p_ham_constr

◆ p_mass_adm

◆ p_mass_kom

◆ p_mom_constr

◆ p_total_ener

◆ p_virial

◆ p_virial_fus

◆ p_virial_gb

◆ star1

◆ star2

◆ x_axe