field_registry::field_registry_t Type Reference

Collaboration diagram for field_registry::field_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, fld_name, ignore_existing)
	Add a field to the registry.
procedure, pass(this)	add_alias (this, alias, fld_name)
	Add an alias to a field in the registry.
procedure, pass(this)	n_fields (this)
	Get the number of fields in the registry.
procedure, pass(this)	n_aliases (this)
	Get the number of aliases in the registry.
procedure, pass(this)	get_field_by_index (this, i)
	Get pointer to a stored field by index.
procedure, pass(this)	get_field_by_name (this, name)
	Get pointer to a stored field by name.
procedure, pass(this)	get_expansion_size (this)
	Get the expansion_size
procedure, pass(this)	get_size (this)
	Get total allocated size of fields.
procedure, pass(this)	field_exists (this, name)
	Check if a field with a given name is already in the registry.
generic	get_field (this, i)
	Get pointer to a stored field by index.
generic	get_field (this, name)
	Get pointer to a stored field by name.

Private Member Functions
procedure, pass(this), private	expand (this)
	Expand the fields array so as to accomodate more fields.
procedure, pass(this), private	expand_aliases (this)
	Expand the aliases array so as to accomodate more aliases.

Private Attributes
type(field_t), dimension(:), allocatable, private	fields
	List of fields stored.
type(json_file), dimension(:), allocatable, private	aliases
	List of aliases to fields stored.
integer, private	n_fields_
	Number of registered fields.
integer, private	n_aliases_
	Number of aliases.
integer, private	expansion_size
	The size the fields array is increased by upon reallocation.

Detailed Description

Definition at line 48 of file field_registry.f90.

Member Function/Subroutine Documentation

add_alias()

procedure, pass(this) field_registry::field_registry_t::add_alias	(	class(field_registry_t), intent(inout)	this,
		character(len=*), intent(in), target	alias,
		character(len=*), intent(in), target	fld_name
	)

Parameters

alias	The alias.
fld_name	The name of the field.

Definition at line 72 of file field_registry.f90.

add_field()

procedure, pass(this) field_registry::field_registry_t::add_field	(	class(field_registry_t), intent(inout)	this,
		type(dofmap_t), intent(in), target	dof,
		character(len=*), intent(in), target	fld_name,
		logical, intent(in), optional	ignore_existing
	)

Parameters

dof	The map of degrees of freedom.
fld_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 70 of file field_registry.f90.

expand()

procedure, pass(this), private field_registry::field_registry_t::expand ( class(field_registry_t), intent(inout)  this )

private

Definition at line 61 of file field_registry.f90.

expand_aliases()

procedure, pass(this), private field_registry::field_registry_t::expand_aliases ( class(field_registry_t), intent(inout)  this )

private

Definition at line 63 of file field_registry.f90.

field_exists()

procedure, pass(this) field_registry::field_registry_t::field_exists	(	class(field_registry_t), intent(in), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 89 of file field_registry.f90.

free()

procedure, pass(this) field_registry::field_registry_t::free

(

class(field_registry_t), intent(inout)

this

)

Definition at line 68 of file field_registry.f90.

get_expansion_size()

procedure, pass(this) field_registry::field_registry_t::get_expansion_size

(

class(field_registry_t), intent(in)

this

)

Definition at line 84 of file field_registry.f90.

get_field() [1/2]

generic field_registry::field_registry_t::get_field	(	class(field_registry_t), intent(in), target	this,
		integer, intent(in)	i
	)

Definition at line 90 of file field_registry.f90.

get_field() [2/2]

generic field_registry::field_registry_t::get_field	(	class(field_registry_t), intent(in), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 90 of file field_registry.f90.

get_field_by_index()

procedure, pass(this) field_registry::field_registry_t::get_field_by_index	(	class(field_registry_t), intent(in), target	this,
		integer, intent(in)	i
	)

Definition at line 78 of file field_registry.f90.

get_field_by_name()

procedure, pass(this) field_registry::field_registry_t::get_field_by_name	(	class(field_registry_t), intent(in), target	this,
		character(len=*), intent(in)	name
	)

Definition at line 81 of file field_registry.f90.

get_size()

procedure, pass(this) field_registry::field_registry_t::get_size

(

class(field_registry_t), intent(in)

this

)

Definition at line 87 of file field_registry.f90.

init()

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

Parameters

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

Definition at line 66 of file field_registry.f90.

n_aliases()

procedure, pass(this) field_registry::field_registry_t::n_aliases

(

class(field_registry_t), intent(in)

this

)

Definition at line 76 of file field_registry.f90.

n_fields()

procedure, pass(this) field_registry::field_registry_t::n_fields

(

class(field_registry_t), intent(in)

this

)

Definition at line 74 of file field_registry.f90.

Member Data Documentation

aliases

type(json_file), dimension(:), allocatable, private field_registry::field_registry_t::aliases

private

Definition at line 52 of file field_registry.f90.

expansion_size

integer, private field_registry::field_registry_t::expansion_size

private

Definition at line 58 of file field_registry.f90.

fields

type(field_t), dimension(:), allocatable, private field_registry::field_registry_t::fields

private

Definition at line 50 of file field_registry.f90.

n_aliases_

integer, private field_registry::field_registry_t::n_aliases_

private

Definition at line 56 of file field_registry.f90.

n_fields_

integer, private field_registry::field_registry_t::n_fields_

private

Definition at line 54 of file field_registry.f90.

---

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

• /home/runner/work/neko/neko/src/field/field_registry.f90