access – SPHINCS

Implementation of the methods of TYPE idbase to access PRIVATE data

FT 28.10.2021

Uses

- Ancestors:
- id_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

check_i_matter get_cold_system get_estimate_length_scale get_n_matter get_one_lapse get_total_spatial_extent get_zero_shift set_cold_system set_estimate_length_scale set_n_matter set_one_lapse set_zero_shift

Module Procedures

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

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

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

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

module procedure get_one_lapse pure module function get_one_lapse(this)

Returns one_lapse

Arguments

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

Return Value logical

n_matter, the number of matter objects in the

module procedure get_total_spatial_extent module function get_total_spatial_extent(this) result(box)

Return 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 entire physical 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.

module procedure get_zero_shift pure module function get_zero_shift(this)

Returns zero_shift

Arguments

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

Return Value logical

n_matter, the number of matter objects in the

module procedure set_cold_system module subroutine set_cold_system(this, value)

Sets cold_system to the given value

Arguments

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

module procedure set_estimate_length_scale module subroutine set_estimate_length_scale(this, value)

Sets estimate_length_scale to the given value

Arguments

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

module procedure set_n_matter pure module subroutine set_n_matter(this, value)

Sets n_matter 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

module procedure set_one_lapse pure module subroutine set_one_lapse(this, logic)

Sets one_lapse 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

module procedure set_zero_shift pure module subroutine set_zero_shift(this, logic)

Sets zero_shift 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

access Submodule

Contents

Module Procedures

Uses

Ancestors:

Contents

Module Procedures

Module Procedures

module procedure check_i_matter module subroutine check_i_matter(this, i_matter)

Arguments

module procedure get_cold_system pure module function get_cold_system(this)

Arguments

Return Value logical

module procedure get_estimate_length_scale pure module function get_estimate_length_scale(this)

Arguments

Return Value logical

module procedure get_n_matter pure module function get_n_matter(this)

Arguments

Return Value integer

module procedure get_one_lapse pure module function get_one_lapse(this)

Arguments

Return Value logical

module procedure get_total_spatial_extent module function get_total_spatial_extent(this) result(box)

Arguments

Return Value double precision, DIMENSION(6)

module procedure get_zero_shift pure module function get_zero_shift(this)

Arguments

Return Value logical

module procedure set_cold_system module subroutine set_cold_system(this, value)

Arguments

module procedure set_estimate_length_scale module subroutine set_estimate_length_scale(this, value)

Arguments

module procedure set_n_matter pure module subroutine set_n_matter(this, value)

Arguments

module procedure set_one_lapse pure module subroutine set_one_lapse(this, logic)

Arguments

module procedure set_zero_shift pure module subroutine set_zero_shift(this, logic)

Arguments

access Submodule

Contents

Module Procedures

Uses

Ancestors:

Contents

Module Procedures

Module Procedures

module procedure check_i_matter module subroutine check_i_matter(this, i_matter) Interface →

Arguments

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

Arguments

Return Value logical

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

Arguments

Return Value logical

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

Arguments

Return Value integer

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

Arguments

Return Value logical

module procedure get_total_spatial_extent module function get_total_spatial_extent(this) result(box) Interface →

Arguments

Return Value double precision, DIMENSION(6)

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

Arguments

Return Value logical

module procedure set_cold_system module subroutine set_cold_system(this, value) Interface →

Arguments

module procedure set_estimate_length_scale module subroutine set_estimate_length_scale(this, value) Interface →

Arguments

module procedure set_n_matter pure module subroutine set_n_matter(this, value) Interface →

Arguments

module procedure set_one_lapse pure module subroutine set_one_lapse(this, logic) Interface →

Arguments

module procedure set_zero_shift pure module subroutine set_zero_shift(this, logic) Interface →

Arguments

module procedure check_i_matter module subroutine check_i_matter(this, i_matter)

module procedure get_cold_system pure module function get_cold_system(this)

module procedure get_estimate_length_scale pure module function get_estimate_length_scale(this)

module procedure get_n_matter pure module function get_n_matter(this)

module procedure get_one_lapse pure module function get_one_lapse(this)

module procedure get_total_spatial_extent module function get_total_spatial_extent(this) result(box)

module procedure get_zero_shift pure module function get_zero_shift(this)

module procedure set_cold_system module subroutine set_cold_system(this, value)

module procedure set_estimate_length_scale module subroutine set_estimate_length_scale(this, value)

module procedure set_n_matter pure module subroutine set_n_matter(this, value)

module procedure set_one_lapse pure module subroutine set_one_lapse(this, logic)

module procedure set_zero_shift pure module subroutine set_zero_shift(this, logic)