bnslorene – SPHINCS

type, public, extends(bnsbase) :: bnslorene

TYPE representing a binary system of neutron stars ($\mathrm{BNS}$) produced with $\texttt{LORENE}$

Inherits

Variables

adm_mass angular_momentum_x angular_momentum_y angular_momentum_z angular_vel area_radius1 area_radius2 barycenter barycenter1_x barycenter2_x barycenter_system baryon_density bns_identifier bns_ptr center center1_x center2_x construction_timer distance distance_com energy_density energy_density_center1 energy_density_center2 ent_center1 ent_center2 eos1 eos1_id eos1_loreneid eos2 eos2_id eos2_loreneid eos_filenames eos_table1 eos_table2 finalize_sph_id_ptr g_xx g_xy g_xz g_yy g_yz g_zz gamma0_1 gamma0_2 gamma1_1 gamma1_2 gamma2_1 gamma2_2 gamma3_1 gamma3_2 gamma_1 gamma_2 k_xx k_xy k_xz k_yy k_yz k_zz kappa0_1 kappa0_2 kappa1_1 kappa1_2 kappa2_1 kappa2_2 kappa3_1 kappa3_2 kappa_1 kappa_2 lapse linear_momentum_x linear_momentum_y linear_momentum_z logP1_1 logP1_2 logRho0_1 logRho0_2 logRho1_1 logRho1_2 logRho2_1 logRho2_2 mOmega mass mass1 mass2 mass_grav mass_grav1 mass_grav2 nbar_center1 nbar_center2 npeos_1 npeos_2 pressure pressure_center1 pressure_center2 radii radius1_x_comp radius1_x_opp radius1_y radius1_z radius2_x_comp radius2_x_opp radius2_y radius2_z rho_center1 rho_center2 shift_x shift_y shift_z specific_energy specific_energy_center1 specific_energy_center2 surfaces t_merger tab_eos v_euler_x v_euler_y v_euler_z

Type-Bound Procedures

allocate_bnslorene_memory check_i_matter construct_binary correct_adm_linear_momentum deallocate_bnslorene_memory derived_type_constructor destruct_binary estimate_lengthscale_field find_center find_print_surfaces find_radius find_surface get_adm_mass get_angular_momentum get_angular_vel get_barycenter1_x get_barycenter2_x get_bns_identifier get_center1_x get_center2_x get_cold_system get_distance get_distance_com get_energy_density_center1 get_energy_density_center2 get_ent_center1 get_ent_center2 get_eos1 get_eos1_id get_eos1_loreneid get_eos2 get_eos2_id get_eos2_loreneid get_eos_id get_estimate_length_scale get_fa get_field get_fv get_gamma0_1 get_gamma0_2 get_gamma1_1 get_gamma1_2 get_gamma2_1 get_gamma2_2 get_gamma3_1 get_gamma3_2 get_gamma_1 get_gamma_2 get_grav_mass1 get_grav_mass2 get_kappa0_1 get_kappa0_2 get_kappa1_1 get_kappa1_2 get_kappa2_1 get_kappa2_2 get_kappa3_1 get_kappa3_2 get_kappa_1 get_kappa_2 get_linear_momentum get_logP1_1 get_logP1_2 get_logRho0_1 get_logRho0_2 get_logRho1_1 get_logRho1_2 get_logRho2_1 get_logRho2_2 get_mass1 get_mass2 get_n_matter get_nbar_center1 get_nbar_center2 get_npeos_1 get_npeos_2 get_one_lapse get_pressure_center1 get_pressure_center2 get_radius1_x_comp get_radius1_x_opp get_radius1_y get_radius1_z get_radius2_x_comp get_radius2_x_opp get_radius2_y get_radius2_z get_rho_center1 get_rho_center2 get_specific_energy_center1 get_specific_energy_center2 get_total_spatial_extent get_zero_shift initialize initialize_id integrate_baryon_mass_density nothing print_bns_properties print_summary print_summary_derived read_bns_properties read_id_full read_id_hydro read_id_int read_id_k read_id_mass_b read_id_particles read_id_spacetime read_mass_density read_pressure read_spatial_metric return_adm_mass return_barycenter return_center return_eos_name return_eos_parameters return_mass return_spatial_extent sanity_check set_cold_system set_estimate_length_scale set_n_matter set_one_lapse set_zero_shift test_position

Source Code

bnslorene

Components

Type	Visibility	Attributes		Name		Initial
double precision,	public		::	adm_mass			ADM mass of the system $[M_\odot]$
double precision,	public		::	angular_momentum_x	=	0.0D0	$x$ component of the angular momentum of the BNS system
double precision,	public		::	angular_momentum_y	=	0.0D0	$y$ component of the angular momentum of the BNS system
double precision,	public		::	angular_momentum_z	=	0.0D0	$z$ component of the angular momentum of the BNS system
double precision,	public		::	angular_vel			Angular velocity $[{\rm rad/s}]$
double precision,	public		::	area_radius1			Areal (or circumferential) radius of star 1 $[L_\odot]$ Note that these is the areal radius of the star in the binary system, which is different than that of an isolated star. The latter is used in the mass-radius diagrams, together with the gravitatonal mass
double precision,	public		::	area_radius2			Areal (or circumferential) radius of star 2 $[L_\odot]$ Note that these is the areal radius of the star in the binary system, which is different than that of an isolated star. The latter is used in the mass-radius diagrams, together with the gravitatonal mass
double precision,	public,	DIMENSION(2,3)	::	barycenter			Array containing the barycenters of the stars Todo add details
double precision,	public		::	barycenter1_x			Barycenter of star 1 $[L_\odot]$
double precision,	public		::	barycenter2_x			Barycenter of star 2 $[L_\odot]$
double precision,	public,	DIMENSION(3)	::	barycenter_system			Array containing the barycenters of the stars Todo add details
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	baryon_density			1-D array storing the baryon mass density in the fluid frame [kg m^{-3}]
integer,	private		::	bns_identifier	=	0	Identifier of the bnslorene object
type(C_PTR),	private		::	bns_ptr			C pointer to the $\texttt{LORENE}$'s $\texttt{Bin_NS}$ object N.B. This variable is global. The pointer to the second $\texttt{LORENE}$ $\texttt{Bin_NS}$ object will overwrite the first one, and so on. This variable stores the pointer to the last defined $\texttt{LORENE}$ $\texttt{Bin_NS}$ object. That's why it is not freed in the destructor of a bns object. Presently, it has to be freed by the user at the end of the PROGRAM. See the last part of the PROGRAM in setup_lorene_id.f90, for example.
double precision,	public,	DIMENSION(2,3)	::	center			Array containing the centers of the stars Todo add details
double precision,	public		::	center1_x			Stellar center of star 1 (origin of the LORENE chart centered on star 1) $[L_\odot]$
double precision,	public		::	center2_x			Stellar center of star 2 (origin of the LORENE chart centered on star 2) $[L_\odot]$
type(timer),	public		::	construction_timer			Timer that times the construction of the appropriate object
double precision,	public		::	distance			Distance $d$ between the points of maximum baryon density $[{\rm km}]$
double precision,	public		::	distance_com			Distance between the centers of mass $[L_\odot(=1.47662503825040{\rm km})]$
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	energy_density			1-D array storing the energy density [kg c^2 m^{-3}]
double precision,	public		::	energy_density_center1			Central energy density for star 1 $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public		::	energy_density_center2			Central energy density for star 2 $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public		::	ent_center1			Central enthalpy for star 1 $[c^2]$
double precision,	public		::	ent_center2			Central enthalpy for star 2 $[c^2]$
character(len=:),	public,	ALLOCATABLE	::	eos1			Name of the equation of state ($\mathrm{EOS}$) of star 1
integer,	public		::	eos1_id			$\texttt{SPHINCS_ID}$ identifier for the $\mathrm{EOS}$ of star 1
integer,	private		::	eos1_loreneid			$\texttt{LORENE}$ identifier for the $\mathrm{EOS}$ of star 1
character(len=:),	public,	ALLOCATABLE	::	eos2			Name of the equation of state ($\mathrm{EOS}$) of star 2
integer,	public		::	eos2_id			$\texttt{SPHINCS_ID}$ identifier for the $\mathrm{EOS}$ of star 2
integer,	private		::	eos2_loreneid			$\texttt{LORENE}$ identifier for the $\mathrm{EOS}$ of star 2
character(len=max_length),	public,	DIMENSION(2)	::	eos_filenames			Array of strings containing the names of the files containing the $\mathrm{EOS}$ to be used for each matter object.
character(len=:),	public,	ALLOCATABLE	::	eos_table1			String containing the path to the files containing the table of the $\mathrm{EOS}$ for star 1.
character(len=:),	public,	ALLOCATABLE	::	eos_table2			String containing the path to the files containing the table of the $\mathrm{EOS}$ for star 2.
procedure,	public,	POINTER, NOPASS	::	finalize_sph_id_ptr			Pointer to a procedure that finalize the $\mathrm{SPH}$ $\mathrm{ID}$; for example, correct for the residual ADM linear momentum.
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_xx			1-D array storing the xx component of the spatial metric [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_xy			1-D array storing the xy component of the spatial metric [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_xz			1-D array storing the xz component of the spatial metric [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_yy			1-D array storing the yy component of the spatial metric [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_yz			1-D array storing the yz component of the spatial metric [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	g_zz			1-D array storing the zz component of the spatial metric [pure number]
double precision,	public		::	gamma0_1			Piecewise polytrope: polytropic index $\gamma_0$ for star 1
double precision,	public		::	gamma0_2			Piecewise polytrope: polytropic index $\gamma_0$ for star 2
double precision,	public		::	gamma1_1			Piecewise polytrope: polytropic index $\gamma_1$ for star 1
double precision,	public		::	gamma1_2			Piecewise polytrope: polytropic index $\gamma_1$ for star 2
double precision,	public		::	gamma2_1			Piecewise polytrope: polytropic index $\gamma_2$ for star 1
double precision,	public		::	gamma2_2			Piecewise polytrope: polytropic index $\gamma_2$ for star 2
double precision,	public		::	gamma3_1			Piecewise polytrope: polytropic index $\gamma_3$ for star 1
double precision,	public		::	gamma3_2			Piecewise polytrope: polytropic index $\gamma_3$ for star 2
double precision,	public		::	gamma_1			Single polytrope: polytropic index for star 1
double precision,	public		::	gamma_2			Single polytrope: polytropic index for star 2
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_xx			1-D array storing the xx component of the extrinsic curvature [c/MSun_geo]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_xy			1-D array storing the xy component of the extrinsic curvature [c/MSun_geo]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_xz			1-D array storing the xz component of the extrinsic curvature [c/MSun_geo]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_yy			1-D array storing the yy component of the extrinsic curvature [c/MSun_geo]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_yz			1-D array storing the yz component of the extrinsic curvature [c/MSun_geo]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	k_zz			1-D array storing the zz component of the extrinsic curvature [c/MSun_geo]
double precision,	public		::	kappa0_1			Piecewise polytrope: polytropic constant $\kappa_0$ for star 1 [pure number]
double precision,	public		::	kappa0_2			Piecewise polytrope: polytropic constant $\kappa_0$ for star 2 [pure number]
double precision,	public		::	kappa1_1			Piecewise polytrope: polytropic constant $\kappa_1$ for star 1 [pure number]
double precision,	public		::	kappa1_2			Piecewise polytrope: polytropic constant $\kappa_1$ for star 2 [pure number]
double precision,	public		::	kappa2_1			Piecewise polytrope: polytropic constant $\kappa_2$ for star 1 [pure number]
double precision,	public		::	kappa2_2			Piecewise polytrope: polytropic constant $\kappa_2$ for star 2 [pure number]
double precision,	public		::	kappa3_1			Piecewise polytrope: polytropic constant $\kappa_3$ for star 1 [pure number]
double precision,	public		::	kappa3_2			Piecewise polytrope: polytropic constant $\kappa_3$ for star 2 [pure number]
double precision,	public		::	kappa_1			Single polytrope: polytropic constant for star 1 [pure number]
double precision,	public		::	kappa_2			Single polytrope: polytropic constant for star 2 [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	lapse			1-D array storing the lapse function
double precision,	public		::	linear_momentum_x	=	0.0D0	$x$ component of the ADM linear momentum of the system
double precision,	public		::	linear_momentum_y	=	0.0D0	$y$ component of the ADM linear momentum of the system
double precision,	public		::	linear_momentum_z	=	0.0D0	$z$ component of the ADM linear momentum of the system
double precision,	public		::	logP1_1			Piecewise polytrope: Base 10 exponent of the pressure at the first fiducial density (between $\gamma_0$ and $\gamma_1$ ) $[{\rm dyne/cm^2}]$ for star 1
double precision,	public		::	logP1_2			Piecewise polytrope: Base 10 exponent of the pressure at the first fiducial density (between $\gamma_0$ and $\gamma_1$ ) $[{\rm dyne/cm^2}]$ for star 2
double precision,	public		::	logRho0_1			Piecewise polytrope: Base 10 exponent of the first fiducial density (between $\gamma_0$ and $\gamma_1$ ) $[{\rm g/cm^3}]$ for star 1
double precision,	public		::	logRho0_2			Piecewise polytrope: Base 10 exponent of the second fiducial density (between $\gamma_1$ and $\gamma_2$ ) $[{\rm g/cm^3}]$ for star 2
double precision,	public		::	logRho1_1			Piecewise polytrope: Base 10 exponent of the second fiducial density (between $\gamma_1$ and $\gamma_2$ ) $[{\rm g/cm^3}]$ for star 1
double precision,	public		::	logRho1_2			Piecewise polytrope: Base 10 exponent of the second fiducial density (between $\gamma_1$ and $\gamma_2$ ) $[{\rm g/cm^3}]$ for star 2
double precision,	public		::	logRho2_1			Piecewise polytrope: Base 10 exponent of the third fiducial density (between $\gamma_2$ and $\gamma_3$ ) $[{\rm g/cm^3}]$ for star 1
double precision,	public		::	logRho2_2			Piecewise polytrope: Base 10 exponent of the third fiducial density (between $\gamma_2$ and $\gamma_3$ ) $[{\rm g/cm^3}]$ for star 2
double precision,	public		::	mOmega			mOmega= ( angular_vel $[{\rm km^{-1}}]$ ) $\times$ ( mass_grav1 $[{\rm km}]$ + mass_grav2 $[{\rm km}]$ ) [pure number] Constant used in K. Hotokezaka et al, Phys. Rev. D 87, 024001 (see Sec. IIB) to determine when the BNS is at approximately 3-4 quasicircular orbits from merger. For the EOS APR4 and ALF2, this requirement is approximately satisfied for mOmega $=0.026$ ; for the EOS H4 and MS1, for mOmega $=0.025$ .
double precision,	public,	DIMENSION(2)	::	mass			Array containing the baryonic masses $[M_\odot]$
double precision,	public		::	mass1			Baryonic mass of star 1 $[M_\odot]$
double precision,	public		::	mass2			Baryonic mass of star 2 $[M_\odot]$
double precision,	public,	DIMENSION(2)	::	mass_grav			Array containing the gravitational masses $[M_\odot]$
double precision,	public		::	mass_grav1			Gravitational mass of star 1 $[M_\odot]$
double precision,	public		::	mass_grav2			Gravitational mass of star 2 $[M_\odot]$
double precision,	public		::	nbar_center1			Central baryon number density for star 1 $[L_\odot^{-3}]$
double precision,	public		::	nbar_center2			Central baryon number density for star 2 $[L_\odot^{-3}]$
integer,	public		::	npeos_1			Piecewise polytrope: Number of polytropic pieces for star 1
integer,	public		::	npeos_2			Piecewise polytrope: Number of polytropic pieces for star 2
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	pressure			1-D array storing the pressure
double precision,	public		::	pressure_center1			Central pressure for star 1 $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public		::	pressure_center2			Central pressure for star 2 $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public,	DIMENSION(2,6)	::	radii			Array containing the signed radii of the stars Todo add details
double precision,	public		::	radius1_x_comp			Radius of star 1, in the x direction, towards the companion $[L_\odot]$
double precision,	public		::	radius1_x_opp			Radius of star 1, in the x direction, opposite to companion $[L_\odot]$
double precision,	public		::	radius1_y			Radius of star 1, in the y direction $[L_\odot]$
double precision,	public		::	radius1_z			Radius of star 1, in the z direction $[L_\odot]$
double precision,	public		::	radius2_x_comp			Radius of star 2, in the x direction, towards the companion $[L_\odot]$
double precision,	public		::	radius2_x_opp			Radius of star 2, in the x direction, opposite to companion $[L_\odot]$
double precision,	public		::	radius2_y			Radius of star 2, in the y direction $[L_\odot]$
double precision,	public		::	radius2_z			Radius of star 2, in the z direction $[L_\odot]$
double precision,	public		::	rho_center1			Central baryon mass density for star 1 $[M_\odot L_\odot^{-3}]$
double precision,	public		::	rho_center2			Central baryon mass density for star 2 $[M_\odot L_\odot^{-3}]$
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	shift_x			1-D array storing the x component of the shift vector [c]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	shift_y			1-D array storing the y component of the shift vector [c]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	shift_z			1-D array storing the z component of the shift vector [c]
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	specific_energy			1-D array storing the specific internal energy [c^2]
double precision,	public		::	specific_energy_center1			Central specific energy for star 1 $[c^2]$
double precision,	public		::	specific_energy_center2			Central specific energy for star 2 $[c^2]$
type(surface),	public,	DIMENSION(:), ALLOCATABLE	::	surfaces			Array containing, for each matter object, a set of coordinates of some points modelling the surfaces. Todo TODO: make PRIVATE
double precision,	public		::	t_merger			Estimated time of the merger $[M_\odot]$ $t_\mathrm{merger}=\dfrac{5}{256} \dfrac{d^4}{M^1_\mathrm{g}M^2_\mathrm{g}(M^1_\mathrm{g}+M^2_\mathrm{g})}$ P. C. Peters, "Gravitational Radiation and the Motion of Two Point Masses", Phys. Rev. 136, B1224 (1964)
type(tabu_eos),	public,	DIMENSION(:), ALLOCATABLE	::	tab_eos			Array containing a tabulated $\mathrm{EOS}$ for each matter object, when used. Todo TODO: make PRIVATE
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	v_euler_x			1-D array storing the x component of the fluid 3-velocity with respect to
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	v_euler_y			1-D array storing the y component of the fluid 3-velocity with respect to
double precision,	private,	DIMENSION(:), ALLOCATABLE	::	v_euler_z			1-D array storing the z component of the fluid 3-velocity with respect to

Finalization Procedures

final :: destruct_bnslorene

Finalizer (Destructor) of a bnslorene object

public interface destruct_bnslorene()

Arguments
None

Type-Bound Procedures

procedure, public :: allocate_bnslorene_memory

Allocates memory for the bnslorene member arrays

interface

public module subroutine allocate_bnslorene_memory(this, d)

Allocates allocatable arrays member of a bnslorene object

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)			::	d	Dimension of the arrays

procedure, public, NON_OVERRIDABLE :: check_i_matter

Checks that the given index is between 1 and n_matter, included. If not, it stops the execution of the program.

interface

public module subroutine check_i_matter(this, i_matter)

Checks that the given index i_matter is between 1 and n_matter, included. If not, it stops the execution of the program.

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this
integer,	intent(in)			::	i_matter	Value to be checked

procedure, public :: construct_binary

Constructs the $\texttt{LORENE}$ $\texttt{Bin_NS}$ object

interface

public module subroutine construct_binary(this, id_file, eos_filenames)

Interface of the subroutine that constructs the $\texttt{LORENE}$ $\texttt{Bin_NS}$ object

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of
character(kind=C_CHAR, len=*),	intent(in),	optional		::	id_file	$\texttt{LORENE}$ binary file containing the spectral $\mathrm{BNS}$ $\mathrm{ID}$
character(kind=C_CHAR, len=*),	intent(in),	optional,	DIMENSION(2)	::	eos_filenames	Array of strings containing the names of the files containing the $\mathrm{EOS}$ to be used for each matter object. If not PRESENT, information from the file `filename` is used

procedure, public, NOPASS :: correct_adm_linear_momentum

Corrects the $\mathrm{SPH}$ $\mathrm{ID}$ so that the linear $\mathrm{ADM}$ momentum is zero

interface

public module subroutine correct_adm_linear_momentum(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu, g_xx, g_xy, g_xz, g_yy, g_yz, g_zz, lapse, shift_x, shift_y, shift_z, adm_mom_error, adm_mass)

Post-process the $\mathrm{SPH}$ $\mathrm{ID}$; for example, correct for the residual ADM linear momentum.

Arguments

Type	Intent	Attributes		Name
integer,	intent(in)		::	npart	Particle number
double precision,	intent(inout),	DIMENSION(3,npart)	::	pos	Particle positions
double precision,	intent(inout),	DIMENSION(npart)	::	nlrf	Baryon density in the local rest frame on the particles
double precision,	intent(inout),	DIMENSION(npart)	::	u	Specific internal energy on the particles
double precision,	intent(inout),	DIMENSION(npart)	::	pr	Pressure on the particles
double precision,	intent(inout),	DIMENSION(3,npart)	::	vel_u	Spatial velocity in the computing frame on the particles
double precision,	intent(inout),	DIMENSION(npart)	::	theta	Generalized Lorentz factor on the particles
double precision,	intent(inout),	DIMENSION(npart)	::	nstar	Proper baryon density in the local rest frame on the particles
double precision,	intent(inout),	DIMENSION(npart)	::	nu	Baryon number per particle
double precision,	intent(in),	DIMENSION(npart)	::	g_xx
double precision,	intent(in),	DIMENSION(npart)	::	g_xy
double precision,	intent(in),	DIMENSION(npart)	::	g_xz
double precision,	intent(in),	DIMENSION(npart)	::	g_yy
double precision,	intent(in),	DIMENSION(npart)	::	g_yz
double precision,	intent(in),	DIMENSION(npart)	::	g_zz
double precision,	intent(in),	DIMENSION(npart)	::	lapse	Lapse function on the particles
double precision,	intent(in),	DIMENSION(npart)	::	shift_x
double precision,	intent(in),	DIMENSION(npart)	::	shift_y
double precision,	intent(in),	DIMENSION(npart)	::	shift_z
double precision,	intent(in),	DIMENSION(3)	::	adm_mom_error
double precision,	intent(in)		::	adm_mass

procedure, public :: deallocate_bnslorene_memory

Deallocates memory for the bnslorene member arrays

interface

public module subroutine deallocate_bnslorene_memory(this)

Deallocates allocatable arrays member of a bnslorene object

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of

procedure, public :: derived_type_constructor => construct_bnslorene

interface

public module subroutine construct_bnslorene(derived_type, filename, eos_filenames)

Prints a summary of the physical properties the system to the standard output and, optionally, to a formatted file whose name is given as the optional argument filename

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(out)			::	derived_type	Constructed bnslorene object
character(len=*),	intent(in),	optional		::	filename	$\texttt{LORENE}$ binary file containing the spectral $\mathrm{BNS}$ $\mathrm{ID}$
character(len=*),	intent(in),	optional,	DIMENSION(:)	::	eos_filenames	Array of strings containing the names of the files containing the $\mathrm{EOS}$ to be used for each matter object. If not PRESENT, information from the file `filename` is used

procedure, public :: destruct_binary

Destructs the $\texttt{LORENE}$ $\texttt{Bin_NS}$ object

interface

public module subroutine destruct_binary(this)

Destructs a $\texttt{LORENE}$ $\texttt{Bin_NS}$ object

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of

procedure, public :: estimate_lengthscale_field

Estimate typical length scales, one per each matter object, by computing $\dfrac{f}{\partial f}$ , where $f$ is a field given as input, and $\partial$ represent a derivative of it. Presently, the derivatives are computed separately along each spatial dimension, as 1D derivatives.

interface

public module function estimate_lengthscale_field(this, get_field, n_mat) result(scales)

Arguments

Type

Intent

Optional

Attributes

Name

class(idbase),

intent(inout)

this

function get_field(x, y, z) result(val)

Returns the value of a field at the desired point

Arguments

Type	Intent		Name
double precision,	intent(in)	::	x	$x$ coordinate of the desired point
double precision,	intent(in)	::	y	$y$ coordinate of the desired point
double precision,	intent(in)	::	z	$z$ coordinate of the desired point

Return Value double precision

Value of the field at $(x,y,z)$

integer,

intent(in)

n_mat

Return Value double precision, DIMENSION(n_mat)

Array of the minimum $\dfrac{f}{\partial f}$ over the lattices that surround each matter object

procedure, public, NON_OVERRIDABLE :: find_center

Finds the center of a matter object, as the point where the density is maximal.

interface

public module function find_center(this, separation, x_sign, get_density) result(center)

Finds the center of a star, as the point where the density is maximal.

Arguments

Type	Intent	Optional		Name
class(bnsbase),	intent(in)		::	this	bnsbase object owning this PROCEDURE
double precision,	intent(in)		::	separation	Separation between the stars
double precision,	intent(in)		::	x_sign	Sign of the x coordinates of the point inside the star
procedure(get_density_at_pos),		optional	::	get_density

Return Value double precision

Center of a star, as the point where the density is maximal.

procedure, public, NON_OVERRIDABLE :: find_print_surfaces

Finds the surfaces of the stars, and prints them to a formatted file.

interface

public module subroutine find_print_surfaces(this)

Finds the surfaces of the stars, and prints them to a formatted file.

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(inout)			::	this	bnsbase object owning this PROCEDURE

procedure, public, NON_OVERRIDABLE :: find_radius

Finds the radius of a star, relative to a center and along a direction. The radius is determined as the first point where the density is zero.

interface

public module function find_radius(this, center, vector, get_density) result(radius)

Finds the radius of a matter object, relative to a center and along a direction. The radius is determined as the first point where the density is zero.

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
double precision,	intent(in),		DIMENSION(3)	::	center	Center point relative to which the radius is measured
double precision,	intent(in),		DIMENSION(3)	::	vector	Vector that defines the direction along which to measure the radius. If not normalized, it will be normalized.
procedure(get_density_at_pos),		optional		::	get_density

Return Value double precision

Radius of the star relative to center, along the direction specified by vector

procedure, public, NON_OVERRIDABLE :: find_surface

Finds the surface of a star, using [[bnsbase::find_radius]] along many directions.

interface

public module subroutine find_surface(this, center, n_theta, n_phi, surface)

Finds the surface of a star, using [[bnsbase::find_radius]] along many directions.

Arguments

Type	Intent	Attributes		Name
class(bnsbase),	intent(in)		::	this	bnsbase object owning this PROCEDURE
double precision,	intent(in),	DIMENSION(3)	::	center	Center point relative to which the radius is measured
integer,	intent(in)		::	n_theta	Number of points in $[0,\pi]$ for the colatitude $\theta$
integer,	intent(in)		::	n_phi	Number of points in $[0,2\pi]$ for the azimuth $\varphi$
double precision,	intent(out),	DIMENSION(:,:,:), ALLOCATABLE	::	surface	Array storing the coordinates of the points on the surface

procedure, public :: get_adm_mass

Returns adm_mass

interface

public pure module function get_adm_mass(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_angular_momentum

Returns the angular momentum vector $($ angular_momentum_x, angular_momentum_y, angular_momentum_z $)$

interface

public pure module function get_angular_momentum(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision, (3)

Result

procedure, public :: get_angular_vel

Returns angular_vel

interface

public pure module function get_angular_vel(this)

Returns angular_vel

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_barycenter1_x

Returns barycenter1_x

interface

public pure module function get_barycenter1_x(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_barycenter2_x

Returns barycenter2_x

interface

public pure module function get_barycenter2_x(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_bns_identifier

Returns bns_identifier

interface

public module function get_bns_identifier(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of

Return Value double precision

procedure, public :: get_center1_x

Returns center1_x

interface

public pure module function get_center1_x(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_center2_x

Returns center2_x

interface

public pure module function get_center2_x(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public, NON_OVERRIDABLE :: get_cold_system

Returns cold_system, the LOGICAL variable that specifies if the system is cold (no thermal component)

interface

public pure module function get_cold_system(this)

Returns cold_system, the LOGICAL variable at specifies if the system is cold (no thermal component)

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this

Return Value logical

cold_system

procedure, public :: get_distance

Returns distance

interface

public pure module function get_distance(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_distance_com

Returns distance_com

interface

public pure module function get_distance_com(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_energy_density_center1

Returns energy_density_center1

interface

public pure module function get_energy_density_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_energy_density_center2

Returns energy_density_center2

interface

public pure module function get_energy_density_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_ent_center1

Returns ent_center1

interface

public pure module function get_ent_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_ent_center2

Returns ent_center2

interface

public pure module function get_ent_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_eos1

Returns eos1

interface

public pure module function get_eos1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value character(len=:), ALLOCATABLE

Result

procedure, public :: get_eos1_id => get_eos1_loreneid

Returns the $\texttt{LORENE}$ identifier for the EOS of star 1

interface

public module function get_eos1_loreneid(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of

Return Value integer

procedure, public :: get_eos1_loreneid

Returns eos1_loreneid

interface

public module function get_eos1_loreneid(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of

Return Value integer

procedure, public :: get_eos2

Returns eos2

interface

public pure module function get_eos2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value character(len=:), ALLOCATABLE

Result

procedure, public :: get_eos2_id => get_eos2_loreneid

Returns the $\texttt{LORENE}$ identifier for the EOS of star 2

interface

public module function get_eos2_loreneid(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of

Return Value integer

procedure, public :: get_eos2_loreneid

Returns eos2_loreneid

interface

public module function get_eos2_loreneid(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of

Return Value integer

procedure, public :: get_eos_id

Returns eos1_id or eos2_id

interface

public module function get_eos_id(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index of the matter object whose string is to return

Return Value integer

Result

procedure, public, NON_OVERRIDABLE :: get_estimate_length_scale

Returns estimate_length_scale, the LOGICAL variable that specifies if a typical length scale, equal to the ratio of a field over its gradient, should be computed

interface

public pure module function get_estimate_length_scale(this)

Returns estimate_length_scale, the LOGICAL variable that specifies if a typical length scale, equal to the ratio of a field over its gradient, should be computed

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this

Return Value logical

estimate_length_scale

procedure, public :: get_fa => get_field_array

Access the bnslorene-member arrays

interface

public module function get_field_array(this, field) result(field_array)

Returns the bnslorene member arrays named field

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this	bnslorene object which this PROCEDURE is a member of
character(len=:),	intent(in),		ALLOCATABLE	::	field	Name of the desired bnslorene member array

Return Value double precision, DIMENSION(:), ALLOCATABLE

Desired bnslorene member array

generic, public :: get_field => get_fa, get_fv

GENERIC PROCEDURE, overloded to access the bnslorene-member variables as arrays and as values

public interface get_field_array()

Arguments
None
public interface get_field_value()

Arguments
None

procedure, public :: get_fv => get_field_value

Access the components of the bnslorene-member arrays

interface

public module function get_field_value(this, field, n) result(field_value)

Returns the component n of the bnslorene member arrays named field

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
character(len=:),	intent(in),	ALLOCATABLE	::	field	Name of the desired bnslorene member array
integer,	intent(in)		::	n	Component of the desired bnslorene member array

Return Value double precision

Component n of the desired bnslorene member array

procedure, public :: get_gamma0_1

Returns gamma0_1

interface

public pure module function get_gamma0_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma0_2

Returns gamma0_2

interface

public pure module function get_gamma0_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma1_1

Returns gamma1_1

interface

public pure module function get_gamma1_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma1_2

Returns gamma1_2

interface

public pure module function get_gamma1_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma2_1

Returns gamma2_1

interface

public pure module function get_gamma2_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma2_2

Returns gamma2_2

interface

public pure module function get_gamma2_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma3_1

Returns gamma3_1

interface

public pure module function get_gamma3_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma3_2

Returns gamma3_2

interface

public pure module function get_gamma3_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma_1

Returns gamma_1

interface

public pure module function get_gamma_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_gamma_2

Returns gamma_2

interface

public pure module function get_gamma_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_grav_mass1

Returns mass_grav1

interface

public pure module function get_grav_mass1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_grav_mass2

Returns mass_grav2

interface

public pure module function get_grav_mass2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa0_1

Returns kappa0_1

interface

public pure module function get_kappa0_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa0_2

Returns kappa0_2

interface

public pure module function get_kappa0_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa1_1

Returns kappa1_1

interface

public pure module function get_kappa1_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa1_2

Returns kappa1_2

interface

public pure module function get_kappa1_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa2_1

Returns kappa2_1

interface

public pure module function get_kappa2_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa2_2

Returns kappa2_2

interface

public pure module function get_kappa2_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa3_1

Returns kappa3_1

interface

public pure module function get_kappa3_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa3_2

Returns kappa3_2

interface

public pure module function get_kappa3_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa_1

Returns kappa_1

interface

public pure module function get_kappa_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_kappa_2

Returns kappa_2

interface

public pure module function get_kappa_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_linear_momentum

Returns the linear momentum vector $($ linear_momentum_x, linear_momentum_y, linear_momentum_z $)$

interface

public pure module function get_linear_momentum(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision, (3)

Result

procedure, public :: get_logP1_1

Returns logP1_1

interface

public pure module function get_logP1_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logP1_2

Returns logP1_2

interface

public pure module function get_logP1_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho0_1

Returns logRho0_1

interface

public pure module function get_logRho0_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho0_2

Returns logRho0_2

interface

public pure module function get_logRho0_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho1_1

Returns logRho1_1

interface

public pure module function get_logRho1_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho1_2

Returns logRho1_2

interface

public pure module function get_logRho1_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho2_1

Returns logRho2_1

interface

public pure module function get_logRho2_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_logRho2_2

Returns logRho2_2

interface

public pure module function get_logRho2_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_mass1

Returns mass1

interface

public pure module function get_mass1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_mass2

Returns mass2

interface

public pure module function get_mass2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public, NON_OVERRIDABLE :: get_n_matter

Returns n_matter, the number of matter objects in the physical system

interface

public pure module function get_n_matter(this)

Returns n_matter, the number of matter objects in the physical system

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this

Return Value integer

n_matter, the number of matter objects in the

procedure, public :: get_nbar_center1

Returns nbar_center1

interface

public pure module function get_nbar_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_nbar_center2

Returns nbar_center2

interface

public pure module function get_nbar_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_npeos_1

Returns npeos_1

interface

public pure module function get_npeos_1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value integer

Result

procedure, public :: get_npeos_2

Returns npeos_2

interface

public pure module function get_npeos_2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value integer

Result

procedure, public, NON_OVERRIDABLE :: get_one_lapse

Returns one_lapse, the LOGICAL variable that determines if the lapse function $\alpha=1$ , i.e., if the geodesic gauge is to be used

interface

public pure module function get_one_lapse(this)

Returns n_matter, the number of matter objects in the physical system

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this

Return Value logical

n_matter, the number of matter objects in the

procedure, public :: get_pressure_center1

Returns pressure_center1

interface

public pure module function get_pressure_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_pressure_center2

Returns pressure_center2

interface

public pure module function get_pressure_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius1_x_comp

Returns radius1_x_comp

interface

public pure module function get_radius1_x_comp(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius1_x_opp

Returns radius1_x_opp

interface

public pure module function get_radius1_x_opp(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius1_y

Returns radius1_y

interface

public pure module function get_radius1_y(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius1_z

Returns radius1_z

interface

public pure module function get_radius1_z(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius2_x_comp

Returns radius2_x_comp

interface

public pure module function get_radius2_x_comp(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius2_x_opp

Returns radius2_x_opp

interface

public pure module function get_radius2_x_opp(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius2_y

Returns radius2_y

interface

public pure module function get_radius2_y(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_radius2_z

Returns radius2_y

interface

public pure module function get_radius2_z(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_rho_center1

Returns rho_center1

interface

public pure module function get_rho_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_rho_center2

Returns rho_center2

interface

public pure module function get_rho_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_specific_energy_center1

Returns specific_energy_center1

interface

public pure module function get_specific_energy_center1(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: get_specific_energy_center2

Returns specific_energy_center2

interface

public pure module function get_specific_energy_center2(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public, NON_OVERRIDABLE :: get_total_spatial_extent

Returns the spatial extent of the physical system considered, as the array of 6 numbers $x_{\rm min},x_{\rm max},y_{\rm min},y_{\rm max},z_{\rm min},z_{\rm max}$

interface

public module function get_total_spatial_extent(this) result(box)

INTERFACE to the SUBROUTINE that detects the spatial extent of the physical system considered, and returns a 6-dimensional array containing the coordinates $x_{\rm min},x_{\rm max},y_{\rm min},y_{\rm max},z_{\rm min},z_{\rm max}$ of a box centered at the center of the object and containing the system.

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this	Object of class idbase which this PROCEDURE is a member of

Return Value double precision, DIMENSION(6)

6-dimensional array containing the coordinates $x_{\rm min},x_{\rm max},y_{\rm min},y_{\rm max}, z_{\rm min},z_{\rm max}$ of a box containing the physical system.

procedure, public, NON_OVERRIDABLE :: get_zero_shift

Returns zero_shift, the LOGICAL variable that determines if the shift $\beta^i=0$

interface

public pure module function get_zero_shift(this)

Returns n_matter, the number of matter objects in the physical system

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	this

Return Value logical

n_matter, the number of matter objects in the

procedure, public, NON_OVERRIDABLE :: initialize

This PROCEDURE calls the constructor of the idbase-extended type and the SUBROUTINE sanity_check afterwards. It is recommended to use this SUBROUTINE to construct objects of idbase-extended type since the sanity check is performed automatically.

interface

public module subroutine initialize(derived_type, filename, eos_filenames)

Initialize the DERIVED TYPE that extends idbase

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(out)			::	derived_type	Object of DERIVED TYPE that extends [[idbase], to be constructed
character(len=*),	intent(in),	optional		::	filename	Name of the file containing the $\mathrm{ID}$
character(len=*),	intent(in),	optional,	DIMENSION(:)	::	eos_filenames	Array of strings containing the names of the files containing the $\mathrm{EOS}$ to be used for each matter object. If not PRESENT, information from the file `filename` is used

procedure, public :: initialize_id => nothing

interface

public module subroutine nothing(this, flag, switch)

Procedure that does nothing. It is used to instantiate a deferred idbase procedure which is not needed in TYPE bnslorene. It also serves as a placeholder in case the idbase procedure will be needed in the future.

Arguments

Type	Intent	Optional		Name
class(bnslorene),	intent(inout)		::	this
integer,	intent(in)		::	flag	Identifies what kind of initialization has to be done
logical,	intent(in),	optional	::	switch	If `.TRUE.`, switch to a different initialization

procedure, public :: integrate_baryon_mass_density

Integrates the baryon mass density over a matter object, using spherical coordinates, and computes its radial profile inside the star

interface

public module subroutine integrate_baryon_mass_density(this, center, radius, central_density, dr, dth, dphi, mass, mass_profile, mass_profile_idx, radii, surf)

INTERFACE to the SUBROUTINE integrating the baryon mass density to compute the radial mass profile of a single star.

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this	Object of class idbase which this PROCEDURE is a member of
double precision,	intent(in),		DIMENSION(3)	::	center	Center of the star
double precision,	intent(in)			::	radius	Central density of the star
double precision,	intent(in)			::	central_density	Integration steps
double precision,	intent(in)			::	dr	Radius of the star
double precision,	intent(in)			::	dth	Radius of the star
double precision,	intent(in)			::	dphi	Radius of the star
double precision,	intent(inout)			::	mass	Integrated mass of the star
double precision,	intent(out),		DIMENSION(3,0:NINT(radius/dr))	::	mass_profile	Array storing the radial mass profile of the star
integer,	intent(out),		DIMENSION(0:NINT(radius/dr))	::	mass_profile_idx	Array to store the indices for array mass_profile, sorted so that `mass_profile[mass_profile_idx]` is in increasing order
double precision,	intent(in),	optional,	DIMENSION(2)	::	radii
type(surface),	intent(in),	optional		::	surf	Surface of the matter object

procedure, public :: nothing

interface

public module subroutine nothing(this, flag, switch)

Arguments

Type	Intent	Optional		Name
class(bnslorene),	intent(inout)		::	this
integer,	intent(in)		::	flag	Identifies what kind of initialization has to be done
logical,	intent(in),	optional	::	switch	If `.TRUE.`, switch to a different initialization

procedure, public :: print_bns_properties

Prints the parameters of the $\mathrm{BNS}$ to the standard output

interface

public module subroutine print_bns_properties(this)

Prints the $\mathrm{BNS}$ parameters to the standard output

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of

procedure, public :: print_summary => print_summary_bnsbase

interface

public module subroutine print_summary_bnsbase(this, filename)

Prints a summary of the physical properties the $\mathrm{BNS}$ system to the standard output and, optionally, to a formatted file whose name is given as the optional argument filename

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
character(len=*),	intent(inout),	optional		::	filename	Name of the formatted file to print the summary to

procedure, public :: print_summary_derived => print_summary_bnslorene

interface

public module subroutine print_summary_bnslorene(this, filename)

Prints a summary of the physical properties of the $\mathrm{BNS}$ produced by $\texttt{LORENE}$ to the standard output and, optionally, to a formatted file whose name is given as the optional argument filename

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(in)			::	this
character(len=*),	intent(inout),	optional		::	filename	Name of the formatted file to print the summary to

procedure, public :: read_bns_properties

Imports the parameters of the $\mathrm{BNS}$ from $\texttt{LORENE}$

Integrates the $\texttt{LORENE}$ baryon mass density and computes the radial mass profile

interface

public module subroutine read_bns_properties(this)

Imports the $\mathrm{BNS}$ properties from $\texttt{LORENE}$

Arguments

Type	Intent	Optional	Attributes		Name
class(bnslorene),	intent(inout)			::	this	bnslorene object which this PROCEDURE is a member of

procedure, public :: read_id_full

interface

public module subroutine read_id_full(this, n, x, y, z, lapse, shift_x, shift_y, shift_z, g_xx, g_xy, g_xz, g_yy, g_yz, g_zz, k_xx, k_xy, k_xz, k_yy, k_yz, k_zz, baryon_density, energy_density, specific_energy, pressure, u_euler_x, u_euler_y, u_euler_z)

Stores the $\mathrm{ID}$ in non bnslorene-member arrays with the same shape as the bnslorene member arrays

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	n
double precision,	intent(in),	DIMENSION(:)	::	x
double precision,	intent(in),	DIMENSION(:)	::	y
double precision,	intent(in),	DIMENSION(:)	::	z
double precision,	intent(inout),	DIMENSION(:)	::	lapse
double precision,	intent(inout),	DIMENSION(:)	::	shift_x
double precision,	intent(inout),	DIMENSION(:)	::	shift_y
double precision,	intent(inout),	DIMENSION(:)	::	shift_z
double precision,	intent(inout),	DIMENSION(:)	::	g_xx
double precision,	intent(inout),	DIMENSION(:)	::	g_xy
double precision,	intent(inout),	DIMENSION(:)	::	g_xz
double precision,	intent(inout),	DIMENSION(:)	::	g_yy
double precision,	intent(inout),	DIMENSION(:)	::	g_yz
double precision,	intent(inout),	DIMENSION(:)	::	g_zz
double precision,	intent(inout),	DIMENSION(:)	::	k_xx
double precision,	intent(inout),	DIMENSION(:)	::	k_xy
double precision,	intent(inout),	DIMENSION(:)	::	k_xz
double precision,	intent(inout),	DIMENSION(:)	::	k_yy
double precision,	intent(inout),	DIMENSION(:)	::	k_yz
double precision,	intent(inout),	DIMENSION(:)	::	k_zz
double precision,	intent(inout),	DIMENSION(:)	::	baryon_density
double precision,	intent(inout),	DIMENSION(:)	::	energy_density
double precision,	intent(inout),	DIMENSION(:)	::	specific_energy
double precision,	intent(inout),	DIMENSION(:)	::	pressure
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_x
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_y
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_z

procedure, public :: read_id_hydro

interface

public module subroutine read_id_hydro(this, nx, ny, nz, pos, baryon_density, energy_density, specific_energy, pressure, u_euler)

Stores the hydro $\mathrm{ID}$ in the arrays needed to compute the constraints on the refined mesh

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	nx
integer,	intent(in)		::	ny
integer,	intent(in)		::	nz
double precision,	intent(in),	DIMENSION(:,:,:,:)	::	pos
double precision,	intent(inout),	DIMENSION(:,:,:)	::	baryon_density
double precision,	intent(inout),	DIMENSION(:,:,:)	::	energy_density
double precision,	intent(inout),	DIMENSION(:,:,:)	::	specific_energy
double precision,	intent(inout),	DIMENSION(:,:,:)	::	pressure
double precision,	intent(inout),	DIMENSION(:,:,:,:)	::	u_euler

procedure, public :: read_id_int

Stores the $\mathrm{ID}$ in the bnslorene member arrays

interface

public module subroutine read_id_int(this, n, x, y, z)

Stores the $\mathrm{ID}$ in the bnslorene member arrays

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	n
double precision,	intent(in),	DIMENSION(:)	::	x
double precision,	intent(in),	DIMENSION(:)	::	y
double precision,	intent(in),	DIMENSION(:)	::	z

procedure, public :: read_id_k

interface

public module subroutine read_id_k(this, n, x, y, z, k_xx, k_xy, k_xz, k_yy, k_yz, k_zz)

Stores the components of the extrinsic curvature in arrays

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	n
double precision,	intent(in),	DIMENSION(:)	::	x
double precision,	intent(in),	DIMENSION(:)	::	y
double precision,	intent(in),	DIMENSION(:)	::	z
double precision,	intent(inout),	DIMENSION(:)	::	k_xx
double precision,	intent(inout),	DIMENSION(:)	::	k_xy
double precision,	intent(inout),	DIMENSION(:)	::	k_xz
double precision,	intent(inout),	DIMENSION(:)	::	k_yy
double precision,	intent(inout),	DIMENSION(:)	::	k_yz
double precision,	intent(inout),	DIMENSION(:)	::	k_zz

procedure, public :: read_id_mass_b

interface

public module subroutine read_id_mass_b(this, x, y, z, g, baryon_density, gamma_euler)

Stores the hydro $\mathrm{ID}$ in the arrays needed to compute the baryon mass

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
double precision,	intent(in)		::	x
double precision,	intent(in)		::	y
double precision,	intent(in)		::	z
double precision,	intent(out),	DIMENSION(6)	::	g
double precision,	intent(out)		::	baryon_density
double precision,	intent(out)		::	gamma_euler

procedure, public :: read_id_particles

interface

public module subroutine read_id_particles(this, n, x, y, z, lapse, shift_x, shift_y, shift_z, g_xx, g_xy, g_xz, g_yy, g_yz, g_zz, baryon_density, energy_density, specific_energy, pressure, u_euler_x, u_euler_y, u_euler_z)

Stores the hydro $\mathrm{ID}$ in the arrays needed to compute the $\mathrm{SPH}$ $\mathrm{ID}$

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	n
real(kind=C_DOUBLE),	intent(in),	DIMENSION(:)	::	x
real(kind=C_DOUBLE),	intent(in),	DIMENSION(:)	::	y
real(kind=C_DOUBLE),	intent(in),	DIMENSION(:)	::	z
double precision,	intent(inout),	DIMENSION(:)	::	lapse
double precision,	intent(inout),	DIMENSION(:)	::	shift_x
double precision,	intent(inout),	DIMENSION(:)	::	shift_y
double precision,	intent(inout),	DIMENSION(:)	::	shift_z
double precision,	intent(inout),	DIMENSION(:)	::	g_xx
double precision,	intent(inout),	DIMENSION(:)	::	g_xy
double precision,	intent(inout),	DIMENSION(:)	::	g_xz
double precision,	intent(inout),	DIMENSION(:)	::	g_yy
double precision,	intent(inout),	DIMENSION(:)	::	g_yz
double precision,	intent(inout),	DIMENSION(:)	::	g_zz
double precision,	intent(inout),	DIMENSION(:)	::	baryon_density
double precision,	intent(inout),	DIMENSION(:)	::	energy_density
double precision,	intent(inout),	DIMENSION(:)	::	specific_energy
double precision,	intent(inout),	DIMENSION(:)	::	pressure
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_x
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_y
double precision,	intent(inout),	DIMENSION(:)	::	u_euler_z

procedure, public :: read_id_spacetime

interface

public module subroutine read_id_spacetime(this, nx, ny, nz, pos, lapse, shift, g, ek)

Stores the spacetime $\mathrm{ID}$ in multi-dimensional arrays needed to compute the BSSN variables and constraints

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(inout)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	nx
integer,	intent(in)		::	ny
integer,	intent(in)		::	nz
double precision,	intent(in),	DIMENSION(:,:,:,:)	::	pos
double precision,	intent(inout),	DIMENSION(:,:,:)	::	lapse
double precision,	intent(inout),	DIMENSION(:,:,:,:)	::	shift
double precision,	intent(inout),	DIMENSION(:,:,:,:)	::	g
double precision,	intent(inout),	DIMENSION(:,:,:,:)	::	ek

procedure, public :: read_mass_density => read_bnslorene_mass_density

Returns the $\texttt{LORENE}$'s mass density at the desired point

interface

public module function read_bnslorene_mass_density(this, x, y, z) result(res)

Returns the $\texttt{LORENE}$ baryon mass density at a point $(x,y,z)$

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
double precision,	intent(in),	VALUE	::	x	$x$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	y	$y$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	z	$z$ coordinate of the desired point

Return Value double precision

Baryon mass density at $(x,y,z)$

procedure, public :: read_pressure => read_bnslorene_pressure

Returns the $\texttt{LORENE}$'s pressure at the desired point

interface

public module function read_bnslorene_pressure(this, x, y, z) result(res)

Returns the $\texttt{LORENE}$ pressure at a point $(x,y,z)$

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
double precision,	intent(in),	VALUE	::	x	$x$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	y	$y$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	z	$z$ coordinate of the desired point

Return Value double precision

Pressure at $(x,y,z)$

procedure, public :: read_spatial_metric

Returns the $\texttt{LORENE}$'s conformally flat spatial ADM metric

interface

public module function read_spatial_metric(this, x, y, z) result(res)

Returns the $\texttt{LORENE}$ conformally flat spatial metric component $g_{xx}=g_{yy}=g_{zz}$ at a point $(x,y,z)$

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
real(kind=C_DOUBLE),	intent(in),	VALUE	::	x	$x$ coordinate of the desired point
real(kind=C_DOUBLE),	intent(in),	VALUE	::	y	$y$ coordinate of the desired point
real(kind=C_DOUBLE),	intent(in),	VALUE	::	z	$z$ coordinate of the desired point

Return Value real(kind=C_DOUBLE)

$g_{xx}=g_{yy}=g_{zz}$ at $(x,y,z)$

procedure, public :: return_adm_mass => get_adm_mass

interface

public pure module function get_adm_mass(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object which this PROCEDURE is a member of

Return Value double precision

Result

procedure, public :: return_barycenter => get_barycenter

interface

public module function get_barycenter(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index of the matter object whose parameter is to return

Return Value double precision, DIMENSION(3)

Result

procedure, public :: return_center => get_center

interface

public module function get_center(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index of the matter object whose parameter is to return

Return Value double precision, DIMENSION(3)

Result

procedure, public :: return_eos_name => get_eos

interface

public module function get_eos(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index of the matter object whose string is to return

Return Value character(len=:), ALLOCATABLE

Result

procedure, public :: return_eos_parameters => get_eos_parameters

interface

public module subroutine get_eos_parameters(this, i_matter, eos_params)

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
integer,	intent(in)		::	i_matter	Index of the matter object whose parameter is to return
double precision,	intent(out),	DIMENSION(:), ALLOCATABLE	::	eos_params	Array containing the parameters of the $\mathrm{EOS}$ for the `i_matter`-th matter object

procedure, public :: return_mass => get_mass

interface

public module function get_mass(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index identifying the matter object

Return Value double precision

Result

procedure, public :: return_spatial_extent => get_radii

interface

public module function get_radii(this, i_matter)

Arguments

Type	Intent	Optional	Attributes		Name
class(bnsbase),	intent(in)			::	this	bnsbase object owning this PROCEDURE
integer,	intent(in)			::	i_matter	Index of the matter object whose string is to return

Return Value double precision, DIMENSION(6)

Result

procedure, public, NON_OVERRIDABLE :: sanity_check

Checks that n_matter and the sizes returned by return_spatial_extent and get_total_spatial_extent are acceptable. It is called by initialize, after the constructor of the derived type.

interface

public module subroutine sanity_check(derived_type)

Check that the DERIVED TYPE that extends idbase is constructed consistently

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(in)			::	derived_type	Object of DERIVED TYPE that extends idbase

procedure, public, NON_OVERRIDABLE :: set_cold_system

Sets cold_system, the LOGICAL variable that specifies if the system is cold (no thermal component)

interface

public module subroutine set_cold_system(this, value)

Sets cold_system, the LOGICAL variable at specifies if the system is cold (no thermal component)

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this
logical,	intent(in)			::	value	Value to set cold_system to

procedure, public, NON_OVERRIDABLE :: set_estimate_length_scale

Sets estimate_length_scale, the LOGICAL variable that specifies if a typical length scale, equal to the ratio of a field over its gradient, should be computed

interface

public module subroutine set_estimate_length_scale(this, value)

Sets estimate_length_scale, the LOGICAL variable that specifies if a typical length scale, equal to the ratio of a field over its gradient, should be computed

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this
logical,	intent(in)			::	value	Value to set cold_system to

procedure, public, NON_OVERRIDABLE :: set_n_matter

Sets n_matter, the number of matter objects in the physical system, to a value

interface

public pure module subroutine set_n_matter(this, value)

Sets n_matter, the number of matter objects in the physical system, to the given value

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this
integer,	intent(in)			::	value	Value to set n_matter to

procedure, public, NON_OVERRIDABLE :: set_one_lapse

Sets one_lapse, the LOGICAL variable that determines if the lapse $\alpha=1$ , i.e., if the geodesic gauge is to be used

interface

public pure module subroutine set_one_lapse(this, logic)

Sets n_matter, the number of matter objects in the physical system, to the given value

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this
logical,	intent(in)			::	logic	Value to set n_matter to

procedure, public, NON_OVERRIDABLE :: set_zero_shift

Sets zero_shift, the LOGICAL variable that determines if the shift $\beta^i=0$

interface

public pure module subroutine set_zero_shift(this, logic)

Sets n_matter, the number of matter objects in the physical system, to the given value

Arguments

Type	Intent	Optional	Attributes		Name
class(idbase),	intent(inout)			::	this
logical,	intent(in)			::	logic	Value to set n_matter to

procedure, public :: test_position => is_hydro_positive

Returns 1 if the energy density or the specific energy or the pressure are negative

interface

public module function is_hydro_positive(this, x, y, z) result(res)

Returns 1 if the energy density or the specific energy or the pressure are negative, 0 otherwise

Arguments

Type	Intent	Attributes		Name
class(bnslorene),	intent(in)		::	this	bnslorene object which this PROCEDURE is a member of
double precision,	intent(in),	VALUE	::	x	$x$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	y	$y$ coordinate of the desired point
double precision,	intent(in),	VALUE	::	z	$z$ coordinate of the desired point

Return Value logical

.TRUE. if the energy density or the specific energy or the pressure are negative, .FALSE. otherwise

Source Code

  TYPE, EXTENDS(bnsbase):: bnslorene
  !# TYPE representing a binary system of neutron stars (|bns|) produced with
  !  |lorene|


    PRIVATE


    INTEGER:: bns_identifier= 0
    !! Identifier of the bnslorene object
    INTEGER:: eos1_loreneid
    !! |lorene| identifier for the |eos| of star 1
    INTEGER:: eos2_loreneid
    !! |lorene| identifier for the |eos| of star 2

    !
    !-- Hydro fields
    !

    !> 1-D array storing the baryon mass density in the fluid frame [kg m^{-3}]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: baryon_density
    !> 1-D array storing the energy density [kg c^2 m^{-3}]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: energy_density
    !> 1-D array storing the specific internal energy [c^2]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: specific_energy
    !> 1-D array storing the pressure
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: pressure
    !> 1-D array storing the x component of the fluid 3-velocity with respect to
    !  the Eulerian observer [c]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: v_euler_x
    !> 1-D array storing the y component of the fluid 3-velocity with respect to
    !  the Eulerian observer [c]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: v_euler_y
    !> 1-D array storing the z component of the fluid 3-velocity with respect to
    !  the Eulerian observer [c]
    DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE:: v_euler_z

    !& C pointer to the |lorene|'s |binns| object
    ! N.B. This variable is global. The pointer to the second |lorene| |binns|
    !      object will overwrite the first one, and so on.
    !      This variable stores the pointer to the last defined |lorene| |binns|
    !      object. That's why it is not freed in the destructor of a bns object.
    !      Presently, it has to be freed by the user at the end of the PROGRAM.
    !      See the last part of the PROGRAM in setup_lorene_id.f90, for example.
    TYPE(C_PTR):: bns_ptr


    CONTAINS


    !-------------------!
    !--  SUBROUTINES  --!
    !-------------------!

    PROCEDURE:: derived_type_constructor => construct_bnslorene

    PROCEDURE:: construct_binary
    !! Constructs the |lorene| |binns| object

    PROCEDURE:: destruct_binary
    !! Destructs the |lorene| |binns| object

    PROCEDURE:: allocate_bnslorene_memory
    !! Allocates memory for the [[bnslorene]] member arrays

    PROCEDURE:: deallocate_bnslorene_memory
    !! Deallocates memory for the [[bnslorene]] member arrays

    PROCEDURE:: read_bns_properties
    !! Imports the parameters of the |bns| from |lorene|

    !PROCEDURE:: integrate_field_on_star => integrate_baryon_mass_density
    !# Integrates the |lorene| baryon mass density and computes the
    !  radial mass profile

    PROCEDURE, PUBLIC:: print_bns_properties
    !! Prints the parameters of the |bns| to the standard output

    PROCEDURE:: read_id_int
    !! Stores the |id| in the [[bnslorene]] member arrays

    PROCEDURE:: read_id_full      => read_id_full
    PROCEDURE:: read_id_spacetime => read_id_spacetime
    PROCEDURE:: read_id_particles => read_id_particles
    PROCEDURE:: read_id_hydro     => read_id_hydro
    PROCEDURE:: read_id_mass_b    => read_id_mass_b
    PROCEDURE:: read_id_k         => read_id_k

    PROCEDURE:: print_summary_derived => print_summary_bnslorene

    PROCEDURE:: nothing
    !# Procedure that does nothing. It is used to instantiate a deferred
    !  idbase procedure which is not needed in TYPE [[bnslorene]].
    !  It also serves as a placeholder in case the idbase procedure
    !  will be needed in the future.

    PROCEDURE:: initialize_id => nothing

    PROCEDURE, NOPASS:: correct_adm_linear_momentum
    !# Corrects the |sph| |id| so that the linear \(\mathrm{ADM}\) momentum
    !  is zero

    !-----------------!
    !--  FUNCTIONS  --!
    !-----------------!

    !> Returns the |lorene|'s mass density at the desired point
    PROCEDURE:: read_mass_density => read_bnslorene_mass_density

    !> Returns the |lorene|'s pressure at the desired point
    PROCEDURE:: read_pressure => read_bnslorene_pressure

    !> Returns the |lorene|'s conformally flat spatial ADM metric
    PROCEDURE:: read_spatial_metric

    !& Returns 1 if the energy density or the specific energy or the pressure
    !  are negative
    PROCEDURE:: test_position => is_hydro_positive

    !
    !-- Overloaded FUNCTION to access the fields as arrays and as values
    !

    GENERIC, PUBLIC:: get_field => get_fa, get_fv
    !# GENERIC PROCEDURE, overloded to access the [[bnslorene]]-member variables
    !  as arrays and as values
    PROCEDURE::       get_fa    => get_field_array
    !! Access the [[bnslorene]]-member arrays
    PROCEDURE::       get_fv    => get_field_value
    !! Access the components of the [[bnslorene]]-member arrays

    !
    !-- FUNCTIONS that access member variables
    !
    PROCEDURE:: get_eos1_id => get_eos1_loreneid
    !! Returns the |lorene| identifier for the EOS of star 1
    PROCEDURE:: get_eos2_id => get_eos2_loreneid
    !! Returns the |lorene| identifier for the EOS of star 2

    PROCEDURE:: return_eos_parameters => get_eos_parameters

    PROCEDURE, PUBLIC:: get_eos1_loreneid
    !! Returns [[bnslorene:eos1_loreneid]]
    PROCEDURE, PUBLIC:: get_eos2_loreneid
    !! Returns [[bnslorene:eos2_loreneid]]

    PROCEDURE, PUBLIC:: get_bns_identifier
    !! Returns [[bnslorene:bns_identifier]]

    !PROCEDURE, PUBLIC:: get_bns_ptr

    FINAL:: destruct_bnslorene
    !! Finalizer (Destructor) of a [[bnslorene]] object

  END TYPE bnslorene

bnslorene Derived Type

Contents

Variables

Finalization Procedures

Type-Bound Procedures

Source Code

type, public, extends(bnsbase) :: bnslorene

Inherits

Contents

Variables

Finalization Procedures

Type-Bound Procedures

Source Code

Components

Todo

Todo

Todo

Todo

Todo

Todo

Finalization Procedures

final :: destruct_bnslorene

public interface destruct_bnslorene()

Arguments

Type-Bound Procedures

procedure, public :: allocate_bnslorene_memory

interface

public module subroutine allocate_bnslorene_memory(this, d) Implementation →

Arguments

procedure, public, NON_OVERRIDABLE :: check_i_matter

interface

public module subroutine check_i_matter(this, i_matter) Implementation →

Arguments

procedure, public :: construct_binary

interface

public module subroutine construct_binary(this, id_file, eos_filenames) Implementation →

Arguments

procedure, public, NOPASS :: correct_adm_linear_momentum

interface

public module subroutine correct_adm_linear_momentum(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu, g_xx, g_xy, g_xz, g_yy, g_yz, g_zz, lapse, shift_x, shift_y, shift_z, adm_mom_error, adm_mass) Implementation →

Arguments

procedure, public :: deallocate_bnslorene_memory

interface

public module subroutine deallocate_bnslorene_memory(this) Implementation →

Arguments

procedure, public :: derived_type_constructor => construct_bnslorene

interface

public module subroutine construct_bnslorene(derived_type, filename, eos_filenames) Implementation →

Arguments

procedure, public :: destruct_binary

interface

public module subroutine destruct_binary(this) Implementation →

Arguments

procedure, public :: estimate_lengthscale_field

interface

public module function estimate_lengthscale_field(this, get_field, n_mat) result(scales) Implementation →

Arguments

function get_field(x, y, z) result(val)

Arguments

Return Value double precision

Return Value double precision, DIMENSION(n_mat)

procedure, public, NON_OVERRIDABLE :: find_center

interface

public module function find_center(this, separation, x_sign, get_density) result(center) Implementation →

Arguments

Return Value double precision

procedure, public, NON_OVERRIDABLE :: find_print_surfaces

interface

public module subroutine find_print_surfaces(this) Implementation →

Arguments

procedure, public, NON_OVERRIDABLE :: find_radius

interface

public module function find_radius(this, center, vector, get_density) result(radius) Implementation →

Arguments

Return Value double precision

procedure, public, NON_OVERRIDABLE :: find_surface

interface

public module subroutine find_surface(this, center, n_theta, n_phi, surface) Implementation →

Arguments

procedure, public :: get_adm_mass

public module subroutine allocate_bnslorene_memory(this, d)

public module subroutine check_i_matter(this, i_matter)

public module subroutine construct_binary(this, id_file, eos_filenames)

public module subroutine correct_adm_linear_momentum(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu, g_xx, g_xy, g_xz, g_yy, g_yz, g_zz, lapse, shift_x, shift_y, shift_z, adm_mom_error, adm_mass)

public module subroutine deallocate_bnslorene_memory(this)

public module subroutine construct_bnslorene(derived_type, filename, eos_filenames)

public module subroutine destruct_binary(this)

public module function estimate_lengthscale_field(this, get_field, n_mat) result(scales)

public module function find_center(this, separation, x_sign, get_density) result(center)

public module subroutine find_print_surfaces(this)

public module function find_radius(this, center, vector, get_density) result(radius)

public module subroutine find_surface(this, center, n_theta, n_phi, surface)

public pure module function get_adm_mass(this)

public pure module function get_angular_momentum(this)

public pure module function get_angular_vel(this)

public pure module function get_barycenter1_x(this)

public pure module function get_barycenter2_x(this)

public module function get_bns_identifier(this)

public pure module function get_center1_x(this)

public pure module function get_center2_x(this)

public pure module function get_cold_system(this)

public pure module function get_distance(this)

public pure module function get_distance_com(this)

public pure module function get_energy_density_center1(this)

public pure module function get_energy_density_center2(this)

public pure module function get_ent_center1(this)