access – SPHINCS

The module contains the implementation of the methods of TYPE diffstarbase that allow to access PRIVATE members.

FT 22.10.2021

Uses

- Ancestors:
- diffstar_base
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Module Procedures

get_adm_mass get_angular_momentum get_area_radius get_barycenter get_center get_energy_density_center get_ent_center get_eos get_eos_id get_f_isco 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_logRho0 get_logRho1 get_logRho2 get_logp1 get_mass get_mass_grav get_nbar_center get_npeos get_omega_c 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_radii get_rho_center get_specific_angular_momentum_isco get_specific_energy_center get_specific_energy_isco get_surface_area get_tsw

Module Procedures

module procedure get_adm_mass 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

module procedure get_angular_momentum pure module function get_angular_momentum(this)

Returns the angular momentum of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_area_radius pure module function get_area_radius(this)

Returns area_radius, the areal radius of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_barycenter module function get_barycenter(this, i_matter)

Returns the barycenter of the $\mathrm{DRS}$ [ $L_\odot$ ]

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)

module procedure get_center module function get_center(this, i_matter)

Returns the center of the $\mathrm{DRS}$ [ $L_\odot$ ]

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)

module procedure get_energy_density_center pure module function get_energy_density_center(this)

Returns the central energy density of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_ent_center pure module function get_ent_center(this)

Returns the central enthalpy of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_eos module function get_eos(this, i_matter)

Returns the $\mathrm{EOS}$ name of the $\mathrm{DRS}$

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

module procedure get_eos_id module function get_eos_id(this, i_matter)

Returns the $\mathrm{EOS}$ identifier of the i_matter-th star

Arguments

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

Return Value integer

Result

module procedure get_f_isco pure module function get_f_isco(this)

Returns f_isco, the orbital frequency of the Innermost Stable Circular Orbit (ISCO)

Arguments

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

Return Value double precision

module procedure get_gamma pure module function get_gamma(this)

Returns the value of gamma, the polytropic index for polytropic $\mathrm{EOS}$, not piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_gamma0 pure module function get_gamma0(this)

Returns the value of gamma0, the crust's polytropic index for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_gamma1 pure module function get_gamma1(this)

Returns the value of gamma1, the first polytropic index for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_gamma2 pure module function get_gamma2(this)

Returns the value of gamma2, the second polytropic index for NS 2 with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_gamma3 pure module function get_gamma3(this)

Returns the value of gamma3, the third polytropic index for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$ (innermost index)

Arguments

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

Return Value double precision

module procedure get_grv2 pure module function get_grv2(this)

Returns grv2, the error on the virial identity ${\rm GRV2}$ .

Arguments

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

Return Value double precision

module procedure get_grv3 pure module function get_grv3(this)

Returns grv3, the error on the virial identity ${\rm GRV3}$ .

Arguments

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

Return Value double precision

module procedure get_kappa pure module function get_kappa(this)

Returns the value of kappa, the polytropic constant for polytropic $\mathrm{EOS}$, not piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_kappa0 pure module function get_kappa0(this)

Returns the value of kappa0, the crust's polytropic constant for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_kappa1 pure module function get_kappa1(this)

Returns the value of kappa1, the first polytropic constant for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_kappa2 pure module function get_kappa2(this)

Returns the value of kappa2, the second polytropic constant for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_kappa3 pure module function get_kappa3(this)

Returns the value of kappa3, the third polytropic constant for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_logRho0 pure module function get_logRho0(this)

Returns the value of logRho0, the base 10 logarithm of the mass density where the gamma1 polytrope starts, for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_logRho1 pure module function get_logRho1(this)

Returns the value of logRho1, the base 10 logarithm of the mass density where the gamma2 polytrope starts, for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_logRho2 pure module function get_logRho2(this)

Returns the value of logRho2, the base 10 logarithm of the mass density where the gamma3 polytrope starts, for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_logp1 pure module function get_logp1(this) result(get_logP1)

Returns the value of logP1, the base 10 logarithm of the pressure where the gamma1 polytrope starts, for the $\mathrm{DRS}$ with piecewise polytropic $\mathrm{EOS}$

Arguments

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

Return Value double precision

module procedure get_mass module function get_mass(this, i_matter)

Returns the baryon mass of the $\mathrm{DRS}$ [ $M_\odot$ ]

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

module procedure get_mass_grav pure module function get_mass_grav(this)

Returns the gravitational mass of the $\mathrm{DRS}$ [ $M_\odot$ ]

Arguments

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

Return Value double precision

module procedure get_nbar_center pure module function get_nbar_center(this)

Returns the central baryon number density of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_npeos pure module function get_npeos(this)

Returns the identifier of the $\mathrm{EOS}$ for the $\mathrm{DRS}$

Arguments

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

Return Value integer

module procedure get_omega_c pure module function get_omega_c(this)

Returns omega_c, the central angular velocity of the system

Arguments

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

Return Value double precision

module procedure get_pressure_center pure module function get_pressure_center(this)

Returns the central pressure of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_r_circ pure module function get_r_circ(this)

Returns r_circ, the circumferential radius of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_r_eq pure module function get_r_eq(this)

Returns r_eq, the equatorial radius of the $\mathrm{DRS}$ at $\phi=0$

Arguments

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

Return Value double precision

module procedure get_r_eq_3pi2 pure module function get_r_eq_3pi2(this)

Returns r_eq_3pi2, the equatorial radius of the $\mathrm{DRS}$ at $\phi=\dfrac{3\pi}{2}$

Arguments

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

Return Value double precision

module procedure get_r_eq_pi pure module function get_r_eq_pi(this)

Returns r_eq_pi, the equatorial radius of the $\mathrm{DRS}$ at $\phi=\pi$

Arguments

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

Return Value double precision

module procedure get_r_eq_pi2 pure module function get_r_eq_pi2(this)

Returns r_eq_pi2, the equatorial radius of the $\mathrm{DRS}$ at $\phi=\dfrac{\pi}{2}$

Arguments

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

Return Value double precision

module procedure get_r_isco pure module function get_r_isco(this)

Returns r_isco, the radius of the Innermost Stable Circular Orbit (ISCO)

Arguments

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

Return Value double precision

module procedure get_r_mean pure module function get_r_mean(this)

Returns r_mean, the circumferential radius of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_r_pole pure module function get_r_pole(this)

Returns r_pole, the polar radius of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_r_ratio pure module function get_r_ratio(this)

Returns r_ratio, the Ratio r_pole/r_eq

Arguments

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

Return Value double precision

module procedure get_radii module function get_radii(this, i_matter)

Returns the radii of the $\mathrm{DRS}$ [ $L_\odot$ ]

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)

module procedure get_rho_center pure module function get_rho_center(this)

Returns the central baryon mass density of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_specific_angular_momentum_isco pure module function get_specific_angular_momentum_isco(this)

Returns specific_angular_momentum_isco, the specific angular momentum of a test particle at the Innermost Stable Circular Orbit (ISCO)

Arguments

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

Return Value double precision

module procedure get_specific_energy_center pure module function get_specific_energy_center(this)

Returns the central specific energy of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_specific_energy_isco pure module function get_specific_energy_isco(this)

Returns specific_energy_isco, the specific energy of a test particle at the Innermost Stable Circular Orbit (ISCO)

Arguments

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

Return Value double precision

module procedure get_surface_area pure module function get_surface_area(this)

Returns surface_area, the surface area of the $\mathrm{DRS}$

Arguments

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

Return Value double precision

module procedure get_tsw pure module function get_tsw(this)

Returns tsw, the ratio $T/W$ between the kinetic and gravitational potential energy of the $\mathrm{DRS}$ FT 22.10.2021

Arguments

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

access Submodule

Contents

Module Procedures

Uses

Ancestors:

Contents

Module Procedures

Module Procedures

module procedure get_adm_mass module function get_adm_mass(this) Interface →

Arguments

Return Value double precision

module procedure get_angular_momentum pure module function get_angular_momentum(this) Interface →

Arguments

Return Value double precision

module procedure get_area_radius pure module function get_area_radius(this) Interface →

Arguments

Return Value double precision

module procedure get_barycenter module function get_barycenter(this, i_matter) Interface →

Arguments

Return Value double precision, DIMENSION(3)

module procedure get_center module function get_center(this, i_matter) Interface →

Arguments

Return Value double precision, DIMENSION(3)

module procedure get_energy_density_center pure module function get_energy_density_center(this) Interface →

Arguments

Return Value double precision

module procedure get_ent_center pure module function get_ent_center(this) Interface →

Arguments

Return Value double precision

module procedure get_eos module function get_eos(this, i_matter) Interface →

Arguments

Return Value character(len=:), ALLOCATABLE

module procedure get_eos_id module function get_eos_id(this, i_matter) Interface →

Arguments

Return Value integer

module procedure get_f_isco pure module function get_f_isco(this) Interface →

Arguments

Return Value double precision

module procedure get_gamma pure module function get_gamma(this) Interface →

Arguments

Return Value double precision

module procedure get_gamma0 pure module function get_gamma0(this) Interface →

Arguments

Return Value double precision

module procedure get_gamma1 pure module function get_gamma1(this) Interface →

Arguments

Return Value double precision

module procedure get_gamma2 pure module function get_gamma2(this) Interface →

Arguments

Return Value double precision

module procedure get_gamma3 pure module function get_gamma3(this) Interface →

Arguments

Return Value double precision

module procedure get_grv2 pure module function get_grv2(this) Interface →

Arguments

Return Value double precision

module procedure get_grv3 pure module function get_grv3(this) Interface →

Arguments

Return Value double precision

module procedure get_kappa pure module function get_kappa(this) Interface →

Arguments

Return Value double precision

module procedure get_kappa0 pure module function get_kappa0(this) Interface →

Arguments

Return Value double precision

module procedure get_kappa1 pure module function get_kappa1(this) Interface →

Arguments

Return Value double precision

module procedure get_kappa2 pure module function get_kappa2(this) Interface →

Arguments

Return Value double precision

module procedure get_kappa3 pure module function get_kappa3(this) Interface →

Arguments

Return Value double precision

module procedure get_logRho0 pure module function get_logRho0(this) Interface →

Arguments

Return Value double precision

module procedure get_logRho1 pure module function get_logRho1(this) Interface →

Arguments

Return Value double precision

module procedure get_adm_mass module function get_adm_mass(this)

module procedure get_angular_momentum pure module function get_angular_momentum(this)

module procedure get_area_radius pure module function get_area_radius(this)

module procedure get_barycenter module function get_barycenter(this, i_matter)

module procedure get_center module function get_center(this, i_matter)

module procedure get_energy_density_center pure module function get_energy_density_center(this)

module procedure get_ent_center pure module function get_ent_center(this)

module procedure get_eos module function get_eos(this, i_matter)

module procedure get_eos_id module function get_eos_id(this, i_matter)

module procedure get_f_isco pure module function get_f_isco(this)

module procedure get_gamma pure module function get_gamma(this)

module procedure get_gamma0 pure module function get_gamma0(this)

module procedure get_gamma1 pure module function get_gamma1(this)

module procedure get_gamma2 pure module function get_gamma2(this)

module procedure get_gamma3 pure module function get_gamma3(this)

module procedure get_grv2 pure module function get_grv2(this)

module procedure get_grv3 pure module function get_grv3(this)

module procedure get_kappa pure module function get_kappa(this)

module procedure get_kappa0 pure module function get_kappa0(this)

module procedure get_kappa1 pure module function get_kappa1(this)

module procedure get_kappa2 pure module function get_kappa2(this)

module procedure get_kappa3 pure module function get_kappa3(this)

module procedure get_logRho0 pure module function get_logRho0(this)

module procedure get_logRho1 pure module function get_logRho1(this)

module procedure get_logRho2 pure module function get_logRho2(this)

module procedure get_logp1 pure module function get_logp1(this) result(get_logP1)

module procedure get_mass module function get_mass(this, i_matter)

module procedure get_mass_grav pure module function get_mass_grav(this)

module procedure get_nbar_center pure module function get_nbar_center(this)

module procedure get_npeos pure module function get_npeos(this)

module procedure get_omega_c pure module function get_omega_c(this)

module procedure get_pressure_center pure module function get_pressure_center(this)

module procedure get_r_circ pure module function get_r_circ(this)

module procedure get_r_eq pure module function get_r_eq(this)

module procedure get_r_eq_3pi2 pure module function get_r_eq_3pi2(this)

module procedure get_r_eq_pi pure module function get_r_eq_pi(this)

module procedure get_r_eq_pi2 pure module function get_r_eq_pi2(this)

module procedure get_r_isco pure module function get_r_isco(this)

module procedure get_r_mean pure module function get_r_mean(this)

module procedure get_r_pole pure module function get_r_pole(this)

module procedure get_r_ratio pure module function get_r_ratio(this)

module procedure get_radii module function get_radii(this, i_matter)

module procedure get_rho_center pure module function get_rho_center(this)

module procedure get_specific_angular_momentum_isco pure module function get_specific_angular_momentum_isco(this)

module procedure get_specific_energy_center pure module function get_specific_energy_center(this)

module procedure get_specific_energy_isco pure module function get_specific_energy_isco(this)

module procedure get_surface_area pure module function get_surface_area(this)