diffstarlorene – SPHINCS

type, public, extends(diffstarbase) :: diffstarlorene

TYPE representing a differentially rotating star (DRS)

Inherits

Variables

adm_mass angular_momentum area_radius barycenter baryon_density center construction_timer diffstar_identifier diffstar_ptr energy_density energy_density_center ent_center eos eos_filename eos_id eos_loreneid eos_table f_isco finalize_sph_id_ptr g_xx g_xy g_xz g_yy g_yz g_zz gamma gamma0 gamma1 gamma2 gamma3 grv2 grv3 k_xx k_xy k_xz k_yy k_yz k_zz kappa kappa0 kappa1 kappa2 kappa3 lapse logP1 logRho0 logRho1 logRho2 mass mass_grav nbar_center npeos omega_c pressure pressure_center r_circ r_eq r_eq_3pi2 r_eq_pi r_eq_pi2 r_isco r_mean r_pole r_ratio radii redshift_eqb redshift_eqf redshift_pole rho_center shift_x shift_y shift_z specific_angular_momentum_isco specific_energy specific_energy_center specific_energy_isco surface_area surfaces tab_eos tsw v_euler_x v_euler_y v_euler_z

Type-Bound Procedures

allocate_diffstar_memory check_i_matter construct_drs deallocate_diffstar_memory derived_type_constructor destruct_drs estimate_lengthscale_field finalize get_angular_momentum get_area_radius get_cold_system get_diffstar_identifier get_energy_density_center get_ent_center get_eos_id get_eos_loreneid get_estimate_length_scale get_f_isco get_fa get_field get_fv get_gamma get_gamma0 get_gamma1 get_gamma2 get_gamma3 get_grv2 get_grv3 get_kappa get_kappa0 get_kappa1 get_kappa2 get_kappa3 get_logP1 get_logRho0 get_logRho1 get_logRho2 get_mass_grav get_n_matter get_nbar_center get_npeos get_omega_c get_one_lapse get_pressure_center get_r_circ get_r_eq get_r_eq_3pi2 get_r_eq_pi get_r_eq_pi2 get_r_isco get_r_mean get_r_pole get_r_ratio get_rho_center get_specific_angular_momentum_isco get_specific_energy_center get_specific_energy_isco get_surface_area get_total_spatial_extent get_tsw get_zero_shift initialize initialize_id integrate_baryon_mass_density nothing print_diffstar_properties print_summary read_diffstar_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

diffstarlorene

Components

Type	Visibility	Attributes		Name		Initial
double precision,	public		::	adm_mass			ADM mass of the $\mathrm{DRS}$ $[M_\odot]$
double precision,	public		::	angular_momentum	=	0.0D0	Angular momentum of the $\mathrm{DRS}$ $[G M_\odot^2/c]$
double precision,	public		::	area_radius			Areal (or circumferential) radius of $\mathrm{DRS}$ [Msun_geo] 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(3)	::	barycenter			Array containing the barycenters of the stars Todo add details
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	baryon_density			1-D array storing the baryon mass density in the fluid frame [kg m^{-3}]
double precision,	public,	DIMENSION(3)	::	center			Array containing the centers of the stars Todo add details
type(timer),	public		::	construction_timer			Timer that times the construction of the appropriate object
integer,	private		::	diffstar_identifier	=	0	Identifier of the diffstarlorene object
type(C_PTR),	private		::	diffstar_ptr			C pointer to the $\texttt{LORENE}$'s Etdiffrot object N.B. This variable is global. The pointer to the second $\texttt{LORENE}$ Etdiffrot object will overwrite the first one, and so on. This variable stores the pointer to the last defined $\texttt{LORENE}$ Etdiffrot 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_diffstar.f90, for example.
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	energy_density			1-D array storing the energy density [kg c^2 m^{-3}]
double precision,	public		::	energy_density_center			Central energy density $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public		::	ent_center			Central enthalpy $[c^2]$
character(len=:),	public,	ALLOCATABLE	::	eos			Name of the equation of state (EoS) of star 1
character(len=max_length),	public,	DIMENSION(1)	::	eos_filename			Array of string containing the names of the files containing the $\mathrm{EOS}$ to be used for each matter object.
integer,	public		::	eos_id			$\texttt{SPHINCS_ID}$ identifier for the $\mathrm{EOS}$ of star 1
integer,	private		::	eos_loreneid			$\texttt{LORENE}$ identifier for the EoS
character(len=:),	public,	ALLOCATABLE	::	eos_table			String containing the path to the files containing the table of the $\mathrm{EOS}$
double precision,	public		::	f_isco			Orbital frequency of the Innermost Stable Circular Orbit (ISCO)
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		::	gamma			Single polytrope: polytropic index
double precision,	public		::	gamma0			Piecewise polytrope: polytropic index $\gamma_0$
double precision,	public		::	gamma1			Piecewise polytrope: polytropic index $\gamma_1$
double precision,	public		::	gamma2			Piecewise polytrope: polytropic index $\gamma_2$
double precision,	public		::	gamma3			Piecewise polytrope: polytropic index $\gamma_3$
double precision,	public		::	grv2			Error on the virial identity ${\rm GRV2}$ . See Section 3.5 in Gourgoulhon et al, Astron.Astrophys.349:851,1999.
double precision,	public		::	grv3			Error on the virial identity ${\rm GRV3}$ . See Section 3.5 in Gourgoulhon et al, Astron.Astrophys.349:851,1999 . The error is computed as the integral defined by Eq. (43) of Gourgoulhon and Bonazzola, Class. Quantum Grav. 11, 443 (1994) divided by the integral of the matter terms.
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		::	kappa			Single polytrope: polytropic constant [pure number]
double precision,	public		::	kappa0			Piecewise polytrope: polytropic constant $\kappa_0$ [pure number]
double precision,	public		::	kappa1			Piecewise polytrope: polytropic constant $\kappa_1$ [pure number]
double precision,	public		::	kappa2			Piecewise polytrope: polytropic constant $\kappa_2$ [pure number]
double precision,	public		::	kappa3			Piecewise polytrope: polytropic constant $\kappa_3$ [pure number]
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	lapse			1-D array storing the lapse function
double precision,	public		::	logP1			Piecewise polytrope: Base 10 exponent of the pressure at the first fiducial density (between $\gamma_0$ and $\gamma_1$ ) $[{\rm dyne/cm^2}]$
double precision,	public		::	logRho0			Piecewise polytrope: Base 10 exponent of the first fiducial density (between $\gamma_0$ and $\gamma_1$ ) $[{\rm g/cm^3}]$
double precision,	public		::	logRho1			Piecewise polytrope: Base 10 exponent of the second fiducial density (between $\gamma_1$ and $\gamma_2$ ) $[{\rm g/cm^3}]$
double precision,	public		::	logRho2			Piecewise polytrope: Base 10 exponent of the third fiducial density (between $\gamma_2$ and $\gamma_3$ ) $[{\rm g/cm^3}]$
double precision,	public		::	mass			Baryonic mass of $\mathrm{DRS}$ $[M_\odot]$
double precision,	public		::	mass_grav			Gravitational mass of $\mathrm{DRS}$ $[M_\odot]$
double precision,	public		::	nbar_center			Central baryon number density $[L_\odot^{-3}]$
integer,	public		::	npeos			Piecewise polytrope: Number of polytropic pieces
double precision,	public		::	omega_c			Central angular velocity $[{\rm rad/s}]$
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	pressure			1-D array storing the pressure
double precision,	public		::	pressure_center			Central pressure $[M_\odot c^2 L_\odot^{-3}]$
double precision,	public		::	r_circ			Circumferential radius
double precision,	public		::	r_eq			Equatorial radius at $\phi=0$
double precision,	public		::	r_eq_3pi2			Equatorial radius at $\phi=\dfrac{3\pi}{2}$
double precision,	public		::	r_eq_pi			Equatorial radius at $\phi=\pi$
double precision,	public		::	r_eq_pi2			Equatorial radius at $\phi=\dfrac{\pi}{2}$
double precision,	public		::	r_isco			Radius of the Innermost Stable Circular Orbit (ISCO)
double precision,	public		::	r_mean			Mean radius
double precision,	public		::	r_pole			Polar radius
double precision,	public		::	r_ratio			Ratio r_pole/r_eq
double precision,	public,	DIMENSION(6)	::	radii
double precision,	public		::	redshift_eqb			Backward redshift factor at equator
double precision,	public		::	redshift_eqf			Forward redshift factor at equator
double precision,	public		::	redshift_pole			Redshift factor at North pole
double precision,	public		::	rho_center			Central baryon mass density $[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,	public		::	specific_angular_momentum_isco			Specific angular momentum of a test particle at the Innermost Stable Circular Orbit (ISCO)
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	specific_energy			1-D array storing the specific internal energy [c^2]
double precision,	public		::	specific_energy_center			Central specific energy $[c^2]$
double precision,	public		::	specific_energy_isco			Specific energy of a test particle at the Innermost Stable Circular Orbit (ISCO)
double precision,	public		::	surface_area			Surface area
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
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,	public		::	tsw			Ratio between the rotational kinetic and gravitatial potential energy $T/\|W\|$ . See Section 6 in Gourgoulhon et al, Astron.Astrophys.349:851,1999 For axisymmetric configurations as those considered here, the threshold for dynamical bar-mode instability is $T/\|W\|\sim 0.25$ [Masaru Shibata et al 2000 ApJ 542 453]. See also Manca et al., Classical and Quantum Gravity, 24, 171, Sec.3.3 in Galeazzi et al., Astron Astrophys 541:A156, and Sec.5.1.3 in Paschalidis, V., Stergioulas, N., Rotating stars in relativity. Living Rev Relativ 20, 7 (2017).
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	v_euler_x			1-D array storing the x component of the fluid 3-velocity with respect to
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	v_euler_y			1-D array storing the y component of the fluid 3-velocity with respect to
double precision,	public,	DIMENSION(:), ALLOCATABLE	::	v_euler_z			1-D array storing the z component of the fluid 3-velocity with respect to

Finalization Procedures

final :: destruct_diffstarlorene

Finalizer (Destructor) of a diffstarlorene object

public interface destruct_diffstarlorene()

Arguments
None

Type-Bound Procedures

procedure, public :: allocate_diffstar_memory

Allocates memory for the diffstarlorene member arrays

interface

public module subroutine allocate_diffstar_memory(this, d)

Allocates allocatable arrays member of a diffstarlorene object

Arguments

Type	Intent	Optional	Attributes		Name
class(diffstarlorene),	intent(inout)			::	this	diffstarlorene 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_drs

Constructs the $\texttt{LORENE}$ Etdiffrot object

interface

public module subroutine construct_drs(this, id_file, eos_filename)

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

Arguments

Type	Intent	Optional		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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{DRS}$ $\mathrm{ID}$
character(kind=C_CHAR, len=*),	intent(in),	optional	::	eos_filename	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 :: deallocate_diffstar_memory

Deallocates memory for the diffstarlorene member arrays

interface

public module subroutine deallocate_diffstar_memory(this)

Deallocates allocatable arrays member of a diffstarlorene object

Arguments

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

procedure, public :: derived_type_constructor => construct_diffstarlorene

interface

public module subroutine construct_diffstarlorene(derived_type, filename, eos_filenames)

Constructs a diffstarlorene object 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(diffstarlorene),	intent(out)			::	derived_type	Constructed diffstarlorene object
character(len=*),	intent(in),	optional		::	filename	$\texttt{LORENE}$ binary file containing the spectral $\mathrm{DRS}$ $\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_drs

Destructs the $\texttt{LORENE}$ Etdiffrot object

interface

public module subroutine destruct_drs(this)

Destructs a $\texttt{LORENE}$ Etdiffrot object

Arguments

Type	Intent	Optional	Attributes		Name
class(diffstarlorene),	intent(inout)			::	this	diffstarlorene 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, NOPASS :: finalize

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

interface

public module subroutine finalize(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu)

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

procedure, public :: get_angular_momentum

Returns angular_momentum

interface

public pure module function get_angular_momentum(this)

Arguments

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

Return Value double precision

procedure, public :: get_area_radius

Returns area_radius

interface

public pure module function get_area_radius(this)

Arguments

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

Return Value double precision

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_diffstar_identifier

Returns diffstar_identifier]

interface

public module function get_diffstar_identifier(this)

Arguments

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

Return Value double precision

procedure, public :: get_energy_density_center

Returns energy_density_center

interface

public pure module function get_energy_density_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_ent_center

Returns ent_center

interface

public pure module function get_ent_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_eos_id => get_eos_loreneid

Returns the $\texttt{LORENE}$ identifier for the EOS

interface

public module function get_eos_loreneid(this)

Arguments

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

Return Value integer

procedure, public :: get_eos_loreneid

Returns eos_loreneid

interface

public module function get_eos_loreneid(this)

Arguments

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

Return Value integer

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_f_isco

Returns f_isco

interface

public pure module function get_f_isco(this)

Arguments

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

Return Value double precision

procedure, public :: get_fa => get_field_array

Access the diffstarlorene-member arrays

interface

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

Returns the diffstarlorene member arrays named field

Arguments

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

Return Value double precision, DIMENSION(:), ALLOCATABLE

Desired diffstarlorene member array

generic, public :: get_field => get_fa, get_fv

GENERIC PROCEDURE, overloded to access the diffstarlorene-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 diffstarlorene-member arrays

interface

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

Returns the component n of the diffstarlorene member arrays named field

Arguments

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

Return Value double precision

Component n of the desired diffstarlorene member array

procedure, public :: get_gamma

Returns gamma

interface

public pure module function get_gamma(this)

Arguments

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

Return Value double precision

procedure, public :: get_gamma0

Returns gamma0

interface

public pure module function get_gamma0(this)

Arguments

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

Return Value double precision

procedure, public :: get_gamma1

Returns gamma1

interface

public pure module function get_gamma1(this)

Arguments

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

Return Value double precision

procedure, public :: get_gamma2

Returns gamma2

interface

public pure module function get_gamma2(this)

Arguments

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

Return Value double precision

procedure, public :: get_gamma3

Returns gamma3

interface

public pure module function get_gamma3(this)

Arguments

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

Return Value double precision

procedure, public :: get_grv2

Returns grv2

interface

public pure module function get_grv2(this)

Arguments

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

Return Value double precision

procedure, public :: get_grv3

Returns grv3

interface

public pure module function get_grv3(this)

Arguments

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

Return Value double precision

procedure, public :: get_kappa

Returns kappa

interface

public pure module function get_kappa(this)

Arguments

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

Return Value double precision

procedure, public :: get_kappa0

Returns kappa0

interface

public pure module function get_kappa0(this)

Arguments

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

Return Value double precision

procedure, public :: get_kappa1

Returns kappa1

interface

public pure module function get_kappa1(this)

Arguments

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

Return Value double precision

procedure, public :: get_kappa2

Returns kappa2

interface

public pure module function get_kappa2(this)

Arguments

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

Return Value double precision

procedure, public :: get_kappa3

Returns kappa3

interface

public pure module function get_kappa3(this)

Arguments

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

Return Value double precision

procedure, public :: get_logP1

Returns logP1

interface

public pure module function get_logP1(this)

Arguments

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

Return Value double precision

procedure, public :: get_logRho0

Returns logRho0

interface

public pure module function get_logRho0(this)

Arguments

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

Return Value double precision

procedure, public :: get_logRho1

Returns logRho1

interface

public pure module function get_logRho1(this)

Arguments

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

Return Value double precision

procedure, public :: get_logRho2

Returns logRho2

interface

public pure module function get_logRho2(this)

Arguments

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

Return Value double precision

procedure, public :: get_mass_grav

Returns mass_grav

interface

public pure module function get_mass_grav(this)

Arguments

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

Return Value double precision

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_center

Returns nbar_center

interface

public pure module function get_nbar_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_npeos

Returns npeos

interface

public pure module function get_npeos(this)

Arguments

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

Return Value integer

procedure, public :: get_omega_c

Returns omega_c

Returns mass

interface

public pure module function get_omega_c(this)

Returns omega_c

Arguments

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

Return Value double precision

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_center

Returns pressure_center

Returns eos

interface

public pure module function get_pressure_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_circ

Returns r_circ

interface

public pure module function get_r_circ(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_eq

Returns r_eq

interface

public pure module function get_r_eq(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_eq_3pi2

Returns r_eq_3pi2

interface

public pure module function get_r_eq_3pi2(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_eq_pi

Returns r_eq_pi

interface

public pure module function get_r_eq_pi(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_eq_pi2

Returns r_eq_pi2

interface

public pure module function get_r_eq_pi2(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_isco

Returns r_isco

interface

public pure module function get_r_isco(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_mean

Returns r_mean

interface

public pure module function get_r_mean(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_pole

Returns r_pole

interface

public pure module function get_r_pole(this)

Arguments

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

Return Value double precision

procedure, public :: get_r_ratio

Returns r_ratio

interface

public pure module function get_r_ratio(this)

Arguments

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

Return Value double precision

procedure, public :: get_rho_center

Returns rho_center

interface

public pure module function get_rho_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_specific_angular_momentum_isco

Returns specific_angular_momentum_isco

interface

public pure module function get_specific_angular_momentum_isco(this)

Arguments

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

Return Value double precision

procedure, public :: get_specific_energy_center

Returns specific_energy_center

interface

public pure module function get_specific_energy_center(this)

Arguments

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

Return Value double precision

procedure, public :: get_specific_energy_isco

Returns specific_energy_isco

interface

public pure module function get_specific_energy_isco(this)

Arguments

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

Return Value double precision

procedure, public :: get_surface_area

Returns surface_area

interface

public pure module function get_surface_area(this)

Arguments

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

Return Value double precision

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 :: get_tsw

Returns tsw

interface

public pure module function get_tsw(this)

Arguments

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

Return Value double precision

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 diffstarlorene. It also serves as a placeholder in case the idbase procedure will be needed in the future.

Arguments

Type	Intent	Optional		Name
class(diffstarlorene),	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(diffstarlorene),	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_diffstar_properties

Prints the parameters of the DRS to the standard output

interface

public module subroutine print_diffstar_properties(this)

Prints the DRS parameters to the standard output

Arguments

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

procedure, public :: print_summary => print_summary_drs

interface

public module subroutine print_summary_drs(this, filename)

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(diffstarbase),	intent(in)			::	this
character(len=*),	intent(inout),	optional		::	filename	Name of the formatted file to print the summary to

procedure, public :: read_diffstar_properties

Imports the parameters of the DRS from $\texttt{LORENE}$

interface

public module subroutine read_diffstar_properties(this)

Imports the DRS parameters from $\texttt{LORENE}$

Arguments

Type	Intent	Optional	Attributes		Name
class(diffstarlorene),	intent(inout)			::	this	diffstarlorene 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 ID in non diffstarlorene-member arrays with the same shape as the diffstarlorene member arrays

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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 ID in the arrays needed to compute the constraints on the refined mesh

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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 ID in the diffstarlorene member arrays

interface

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

Stores the ID in the diffstarlorene member arrays

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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 ID in the arrays needed to compute the baryon mass

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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 ID in the arrays needed to compute the SPH ID

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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 ID in multi-dimensional arrays needed to compute the BSSN variables and constraints

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(inout)		::	this	diffstarlorene 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_drslorene_mass_density

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

interface

public module function read_drslorene_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(diffstarlorene),	intent(in)		::	this	diffstarlorene 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_drslorene_pressure

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

interface

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

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

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	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(diffstarlorene),	intent(in)		::	this	diffstarlorene 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 module function get_adm_mass(this)

Returns 0 (the ADM mass is not necessarily known for this TYPE)

Arguments

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

Return Value double precision

procedure, public :: return_barycenter => get_barycenter

interface

public module function get_barycenter(this, i_matter)

Arguments

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

Return Value double precision, DIMENSION(3)

procedure, public :: return_center => get_center

interface

public module function get_center(this, i_matter)

Arguments

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

Return Value double precision, DIMENSION(3)

procedure, public :: return_eos_name => get_eos

interface

public module function get_eos(this, i_matter)

Arguments

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

Return Value character(len=:), ALLOCATABLE

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(diffstarlorene),	intent(in)		::	this	diffstarlorene 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 DRS

procedure, public :: return_mass => get_mass

interface

public module function get_mass(this, i_matter)

Returns mass

Arguments

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

Return Value double precision

procedure, public :: return_spatial_extent => get_radii

interface

public module function get_radii(this, i_matter)

Arguments

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

Return Value double precision, DIMENSION(6)

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 .TRUE. if the energy density or the specific energy or the pressure are positive

interface

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

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

Arguments

Type	Intent	Attributes		Name
class(diffstarlorene),	intent(in)		::	this	diffstarlorene 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

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

Source Code

  TYPE, EXTENDS(diffstarbase):: diffstarlorene
  !! TYPE representing a differentially rotating star (DRS)


    PRIVATE


    INTEGER:: diffstar_identifier= 0
    !! Identifier of the diffstarlorene object
    INTEGER:: eos_loreneid
    !! |lorene| identifier for the EoS

    !& C pointer to the |lorene|'s Etdiffrot object
    ! N.B. This variable is global. The pointer to the second |lorene| Etdiffrot
    !      object will overwrite the first one, and so on.
    !    This variable stores the pointer to the last defined |lorene| Etdiffrot
    !      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_diffstar.f90, for example.
    TYPE(C_PTR):: diffstar_ptr


    CONTAINS


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

    PROCEDURE:: derived_type_constructor => construct_diffstarlorene

    PROCEDURE:: construct_drs
    !! Constructs the |lorene| Etdiffrot object

    PROCEDURE:: destruct_drs
    !! Destructs the |lorene| Etdiffrot object

    PROCEDURE:: allocate_diffstar_memory
    !! Allocates memory for the [[diffstarlorene]] member arrays

    PROCEDURE:: deallocate_diffstar_memory
    !! Deallocates memory for the [[diffstarlorene]] member arrays

    PROCEDURE:: read_diffstar_properties
    !! Imports the parameters of the DRS from |lorene|

    PROCEDURE, PUBLIC:: print_diffstar_properties
    !! Prints the parameters of the DRS to the standard output

    PROCEDURE:: read_id_int
    !! Stores the ID in the [[diffstarlorene]] 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:: nothing
    !# Procedure that does nothing. It is used to instantiate a deferred
    !  idbase procedure which is not needed in TYPE [[diffstarlorene]].
    !  It also serves as a placeholder in case the idbase procedure
    !  will be needed in the future.

    PROCEDURE:: initialize_id => nothing

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

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

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

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

    PROCEDURE:: test_position => is_hydro_positive
    !# Returns `.TRUE.` if the energy density or the specific energy or the
    !  pressure are 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 [[diffstarlorene]]-member
    !  variables as arrays and as values
    PROCEDURE::       get_fa    => get_field_array
    !! Access the [[diffstarlorene]]-member arrays
    PROCEDURE::       get_fv    => get_field_value
    !! Access the components of the [[diffstarlorene]]-member arrays

    !
    !-- FUNCTIONS that access member variables
    !

    PROCEDURE:: get_eos_id => get_eos_loreneid
    !! Returns the |lorene| identifier for the EOS

    PROCEDURE:: return_eos_parameters => get_eos_parameters

    PROCEDURE, PUBLIC:: get_eos_loreneid
    !! Returns [[diffstarlorene:eos_loreneid]]

    PROCEDURE, PUBLIC:: get_diffstar_identifier
    !! Returns [[diffstarlorene:diffstar_identifier]]]

    !PROCEDURE, PUBLIC:: get_diffstar_ptr

    !PROCEDURE:: derived_type_destructor => destruct_diffstarlorene

    FINAL:: destruct_diffstarlorene
    !! Finalizer (Destructor) of a [[diffstarlorene]] object

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

  END TYPE diffstarlorene

diffstarlorene Derived Type

Contents

Variables

Finalization Procedures

Type-Bound Procedures

Source Code

type, public, extends(diffstarbase) :: diffstarlorene

Inherits

Contents

Variables

Finalization Procedures

Type-Bound Procedures

Source Code

Components

Todo

Todo

Todo

Todo

Finalization Procedures

final :: destruct_diffstarlorene

public interface destruct_diffstarlorene()

Arguments

Type-Bound Procedures

procedure, public :: allocate_diffstar_memory

interface

public module subroutine allocate_diffstar_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_drs

interface

public module subroutine construct_drs(this, id_file, eos_filename) Implementation →

Arguments

procedure, public :: deallocate_diffstar_memory

interface

public module subroutine deallocate_diffstar_memory(this) Implementation →

Arguments

procedure, public :: derived_type_constructor => construct_diffstarlorene

interface

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

Arguments

procedure, public :: destruct_drs

interface

public module subroutine destruct_drs(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, NOPASS :: finalize

interface

public module subroutine finalize(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu) Implementation →

Arguments

procedure, public :: get_angular_momentum

interface

public pure module function get_angular_momentum(this) Implementation →

Arguments

Return Value double precision

procedure, public :: get_area_radius

interface

public pure module function get_area_radius(this) Implementation →

Arguments

Return Value double precision

procedure, public, NON_OVERRIDABLE :: get_cold_system

interface

public pure module function get_cold_system(this) Implementation →

Arguments

Return Value logical

procedure, public :: get_diffstar_identifier

interface

public module function get_diffstar_identifier(this) Implementation →

Arguments

Return Value double precision

procedure, public :: get_energy_density_center

public module subroutine allocate_diffstar_memory(this, d)

public module subroutine check_i_matter(this, i_matter)

public module subroutine construct_drs(this, id_file, eos_filename)

public module subroutine deallocate_diffstar_memory(this)

public module subroutine construct_diffstarlorene(derived_type, filename, eos_filenames)

public module subroutine destruct_drs(this)

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

public module subroutine finalize(npart, pos, nlrf, u, pr, vel_u, theta, nstar, nu)

public pure module function get_angular_momentum(this)

public pure module function get_area_radius(this)

public pure module function get_cold_system(this)

public module function get_diffstar_identifier(this)

public pure module function get_energy_density_center(this)

public pure module function get_ent_center(this)

public module function get_eos_loreneid(this)

public module function get_eos_loreneid(this)

public pure module function get_estimate_length_scale(this)

public pure module function get_f_isco(this)

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

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

public pure module function get_gamma(this)

public pure module function get_gamma0(this)

public pure module function get_gamma1(this)

public pure module function get_gamma2(this)

public pure module function get_gamma3(this)