registry::registry_t Type Reference

Collaboration diagram for registry::registry_t:

Public Member Functions
procedure, pass(this)	init (this, size, expansion_size)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	add_field (this, dof, name, ignore_existing)
	Add a field to the registry.
procedure, pass(this)	add_vector (this, n, name, ignore_existing)
	Add a vector to the registry.
procedure, pass(this)	add_matrix (this, nrows, ncols, name, ignore_existing)
	Add a matrix to the registry.
procedure, pass(this)	add_real_scalar (this, value, name, ignore_existing)
	Add a real scalar to the registry.
procedure, pass(this)	add_integer_scalar (this, value, name, ignore_existing)
	Add an integer scalar to the registry.
procedure, pass(this)	add_alias (this, alias, name)
	Add an alias to a field in the registry.
procedure, pass(this)	get_field_by_name (this, name)
	Get pointer to a stored field by name.
procedure, pass(this)	get_vector_by_name (this, name)
	Get pointer to a stored vector by name.
procedure, pass(this)	get_matrix_by_name (this, name)
	Get pointer to a stored matrix by name.
procedure, pass(this)	get_real_scalar_by_name (this, name)
	Get pointer to a stored real scalar by name.
procedure, pass(this)	get_integer_scalar_by_name (this, name)
	Get pointer to a stored integer scalar by name.
generic	get_field (this, name)
	Generic field getter.
generic	get_vector (this, name)
	Generic vector getter.
generic	get_matrix (this, name)
	Generic matrix getter.
generic	get_real_scalar (this, name)
	Generic real scalar getter.
generic	get_integer_scalar (this, name)
	Generic integer scalar getter.
procedure, pass(this)	entry_exists (this, name)
	Check if an entry with a given name is already in the registry.
procedure, pass(this)	field_exists (this, name)
	Check if a field with a given name is already in the registry.
procedure, pass(this)	vector_exists (this, name)
	Check if a vector with a given name is already in the registry.
procedure, pass(this)	matrix_exists (this, name)
	Check if a matrix with a given name is already in the registry.
procedure, pass(this)	real_scalar_exists (this, name)
	Check if a real scalar with a given name is already in the registry.
procedure, pass(this)	integer_scalar_exists (this, name)
	Check if an integer scalar with a given name is already in the registry.
procedure, pass(this)	scalar_exists (this, name)
	Backwards compatible scalar existence check (real).
procedure, pass(this)	get_size (this)
	Get total allocated size of fields.
procedure, pass(this)	n_entries (this)
	Get number of registered entries.
procedure, pass(this)	n_fields (this)
	Get the number of fields in the registry.
procedure, pass(this)	n_vectors (this)
	Get the number of vectors in the registry.
procedure, pass(this)	n_matrices (this)
	Get the number of matrices in the registry.
procedure, pass(this)	n_real_scalars (this)
	Get the number of real scalars in the registry.
procedure, pass(this)	n_integer_scalars (this)
	Get the number of integer scalars in the registry.
procedure, pass(this)	n_scalars (this)
	Backwards compatible scalar count (real).
procedure, pass(this)	n_aliases (this)
	Get the number of aliases in the registry.
procedure, pass(this)	get_expansion_size (this)
	Get the expansion_size
procedure, pass(this)	print_contents (this, type)
	Print registry contents optionally filtered by type.

Private Member Functions
procedure, pass(this), private	expand (this)
	Expand the array of entries so as to accommodate more entries.

Private Attributes
type(registry_entry_t), dimension(:), allocatable, private	entries
	List of entries stored.
type(json_file), private	aliases
	List of aliases to entries stored.
integer, private	n_entries_ = 0
	Number of registered entries.
integer, private	n_aliases_ = 0
	Number of aliases.
integer, private	expansion_size_ = 5
	The size the entries array is increased by upon reallocation.

Detailed Description

Definition at line 47 of file registry.f90.

Member Function/Subroutine Documentation

add_alias()

procedure, pass(this) registry::registry_t::add_alias	(	class(registry_t), intent(inout)	this,
		character(len=*), intent(in)	alias,
		character(len=*), intent(in)	name
	)

Parameters

alias	The alias.
name	The name of the entry.

Definition at line 77 of file registry.f90.

add_field()

procedure, pass(this) registry::registry_t::add_field	(	class(registry_t), intent(inout)	this,
		type(dofmap_t), intent(in), target	dof,
		character(len=*), intent(in), target	name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

dof	The map of degrees of freedom.
name	The name of the field.
ignore_existing	If true, will do nothing if the field is already in the registry. If false, will throw an error. Optional, defaults to false.

Definition at line 67 of file registry.f90.

add_integer_scalar()

procedure, pass(this) registry::registry_t::add_integer_scalar	(	class(registry_t), intent(inout)	this,
		integer, intent(in)	value,
		character(len=*), intent(in), target	name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

value	The scalar value.
name	The name of the scalar.
ignore_existing	If true, skip if scalar already registered.

Definition at line 75 of file registry.f90.

add_matrix()

procedure, pass(this) registry::registry_t::add_matrix	(	class(registry_t), intent(inout)	this,
		integer, intent(in)	nrows,
		integer, intent(in)	ncols,
		character(len=*), intent(in), target	name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

n	The size of the matrix.
name	The name of the matrix.
ignore_existing	If true, will do nothing if the matrix is already in the registry. If false, will throw an error. Optional, defaults to false.

Definition at line 71 of file registry.f90.

add_real_scalar()

procedure, pass(this) registry::registry_t::add_real_scalar	(	class(registry_t), intent(inout)	this,
		real(kind=rp), intent(in)	value,
		character(len=*), intent(in), target	name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

value	The scalar value.
name	The name of the scalar.
ignore_existing	If true, skip if scalar already registered.

Definition at line 73 of file registry.f90.

add_vector()

procedure, pass(this) registry::registry_t::add_vector	(	class(registry_t), intent(inout)	this,
		integer, intent(in)	n,
		character(len=*), intent(in), target	name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

n	The size of the vector.
name	The name of the vector.
ignore_existing	If true, will do nothing if the vector is already in the registry. If false, will throw an error. Optional, defaults to false.

Definition at line 69 of file registry.f90.

entry_exists()

procedure, pass(this) registry::registry_t::entry_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 104 of file registry.f90.

expand()

procedure, pass(this), private registry::registry_t::expand ( class(registry_t), intent(inout)  this )

private

Definition at line 64 of file registry.f90.

field_exists()

procedure, pass(this) registry::registry_t::field_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 106 of file registry.f90.

free()

procedure, pass(this) registry::registry_t::free

(

class(registry_t), intent(inout)

this

)

Definition at line 62 of file registry.f90.

get_expansion_size()

procedure, pass(this) registry::registry_t::get_expansion_size

(

class(registry_t), intent(in)

this

)

Definition at line 138 of file registry.f90.

get_field()

generic registry::registry_t::get_field	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 93 of file registry.f90.

Here is the call graph for this function:

get_field_by_name()

procedure, pass(this) registry::registry_t::get_field_by_name	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 80 of file registry.f90.

get_integer_scalar()

generic registry::registry_t::get_integer_scalar	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 101 of file registry.f90.

Here is the call graph for this function:

get_integer_scalar_by_name()

procedure, pass(this) registry::registry_t::get_integer_scalar_by_name	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 89 of file registry.f90.

get_matrix()

generic registry::registry_t::get_matrix	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 97 of file registry.f90.

Here is the call graph for this function:

get_matrix_by_name()

procedure, pass(this) registry::registry_t::get_matrix_by_name	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 84 of file registry.f90.

get_real_scalar()

generic registry::registry_t::get_real_scalar	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 99 of file registry.f90.

Here is the call graph for this function:

get_real_scalar_by_name()

procedure, pass(this) registry::registry_t::get_real_scalar_by_name	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 86 of file registry.f90.

get_size()

procedure, pass(this) registry::registry_t::get_size

(

class(registry_t), intent(in)

this

)

Definition at line 120 of file registry.f90.

get_vector()

generic registry::registry_t::get_vector	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 95 of file registry.f90.

Here is the call graph for this function:

get_vector_by_name()

procedure, pass(this) registry::registry_t::get_vector_by_name	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 82 of file registry.f90.

init()

procedure, pass(this) registry::registry_t::init	(	class(registry_t), intent(inout)	this,
		integer, intent(in), optional	size,
		integer, intent(in), optional	expansion_size
	)

Parameters

size	The allocation size of entries on init.
expansion_size	The number of entries added to entries on expansion.

Definition at line 60 of file registry.f90.

integer_scalar_exists()

procedure, pass(this) registry::registry_t::integer_scalar_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 114 of file registry.f90.

matrix_exists()

procedure, pass(this) registry::registry_t::matrix_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 110 of file registry.f90.

n_aliases()

procedure, pass(this) registry::registry_t::n_aliases

(

class(registry_t), intent(in)

this

)

Definition at line 136 of file registry.f90.

n_entries()

procedure, pass(this) registry::registry_t::n_entries

(

class(registry_t), intent(in)

this

)

Definition at line 122 of file registry.f90.

n_fields()

procedure, pass(this) registry::registry_t::n_fields

(

class(registry_t), intent(in)

this

)

Definition at line 124 of file registry.f90.

n_integer_scalars()

procedure, pass(this) registry::registry_t::n_integer_scalars

(

class(registry_t), intent(in)

this

)

Definition at line 132 of file registry.f90.

n_matrices()

procedure, pass(this) registry::registry_t::n_matrices

(

class(registry_t), intent(in)

this

)

Definition at line 128 of file registry.f90.

n_real_scalars()

procedure, pass(this) registry::registry_t::n_real_scalars

(

class(registry_t), intent(in)

this

)

Definition at line 130 of file registry.f90.

n_scalars()

procedure, pass(this) registry::registry_t::n_scalars

(

class(registry_t), intent(in)

this

)

Definition at line 134 of file registry.f90.

n_vectors()

procedure, pass(this) registry::registry_t::n_vectors

(

class(registry_t), intent(in)

this

)

Definition at line 126 of file registry.f90.

print_contents()

procedure, pass(this) registry::registry_t::print_contents	(	class(registry_t), intent(in)	this,
		character(len=*), intent(in), optional	type
	)

Definition at line 140 of file registry.f90.

real_scalar_exists()

procedure, pass(this) registry::registry_t::real_scalar_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 112 of file registry.f90.

scalar_exists()

procedure, pass(this) registry::registry_t::scalar_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 117 of file registry.f90.

vector_exists()

procedure, pass(this) registry::registry_t::vector_exists	(	class(registry_t), intent(inout), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 108 of file registry.f90.

Member Data Documentation

aliases

type(json_file), private registry::registry_t::aliases

private

Definition at line 51 of file registry.f90.

entries

type(registry_entry_t), dimension(:), allocatable, private registry::registry_t::entries

private

Definition at line 49 of file registry.f90.

expansion_size_

integer, private registry::registry_t::expansion_size_ = 5

private

Definition at line 57 of file registry.f90.

n_aliases_

integer, private registry::registry_t::n_aliases_ = 0

private

Definition at line 55 of file registry.f90.

n_entries_

integer, private registry::registry_t::n_entries_ = 0

private

Definition at line 53 of file registry.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/neko/neko/src/registries/registry.f90