field_registry Module Reference

Defines a registry for storing solution fields.

Data Types
type	field_registry_t

Functions/Subroutines
subroutine	field_registry_init (this, size, expansion_size)
	Constructor.
subroutine	field_registry_free (this)
	Destructor.
subroutine	field_registry_expand (this)
	Expand the fields array so as to accomodate more fields.
subroutine	field_registry_expand_aliases (this)
	Expand the aliases array so as to accomodate more aliases.
subroutine	field_registry_add_field (this, dof, fld_name, ignore_existing)
	Add a field to the registry.
subroutine	field_registry_add_alias (this, alias, fld_name)
	Add an alias for an existing field in the registry.
pure integer function	field_registry_n_fields (this)
	Get the number of fields stored in the registry.
pure integer function	field_registry_n_aliases (this)
	Get the number of aliases stored in the registry.
pure integer function	field_registry_get_size (this)
	Get the size of the fields array.
pure integer function	field_registry_get_expansion_size (this)
	Get the expansion size.
type(field_t) function, pointer	field_registry_get_field_by_index (this, i)
	Get pointer to a stored field by index.
recursive type(field_t) function, pointer	field_registry_get_field_by_name (this, name)
	Get pointer to a stored field by field name.
logical function	field_registry_field_exists (this, name)
	Check if a field with a given name is already in the registry.

Variables
type(field_registry_t), target, public	neko_field_registry
	Global field registry.

Function/Subroutine Documentation

field_registry_add_alias()

subroutine field_registry::field_registry_add_alias ( class(field_registry_t), intent(inout)  this, character(len=*), intent(in), target  alias, character(len=*), intent(in), target  fld_name  )

private

Parameters

alias	The alias.
fld_name	The name of the field.

Definition at line 199 of file field_registry.f90.

field_registry_add_field()

subroutine field_registry::field_registry_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  )

private

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 170 of file field_registry.f90.

field_registry_expand()

subroutine field_registry::field_registry_expand ( class(field_registry_t), intent(inout)  this )

private

Definition at line 146 of file field_registry.f90.

field_registry_expand_aliases()

subroutine field_registry::field_registry_expand_aliases ( class(field_registry_t), intent(inout)  this )

private

Definition at line 156 of file field_registry.f90.

field_registry_field_exists()

logical function field_registry::field_registry_field_exists ( class(field_registry_t), intent(in), target  this, character(len=*), intent(in)  name  )

private

Definition at line 318 of file field_registry.f90.

field_registry_free()

subroutine field_registry::field_registry_free ( class(field_registry_t), intent(inout)  this )

private

Definition at line 126 of file field_registry.f90.

field_registry_get_expansion_size()

pure integer function field_registry::field_registry_get_expansion_size ( class(field_registry_t), intent(in)  this )

private

Definition at line 250 of file field_registry.f90.

field_registry_get_field_by_index()

type(field_t) function, pointer field_registry::field_registry_get_field_by_index ( class(field_registry_t), intent(in), target  this, integer, intent(in)  i  )

private

Definition at line 258 of file field_registry.f90.

field_registry_get_field_by_name()

recursive type(field_t) function, pointer field_registry::field_registry_get_field_by_name ( class(field_registry_t), intent(in), target  this, character(len=*), intent(in)  name  )

private

Definition at line 273 of file field_registry.f90.

field_registry_get_size()

pure integer function field_registry::field_registry_get_size ( class(field_registry_t), intent(in)  this )

private

Definition at line 242 of file field_registry.f90.

field_registry_init()

subroutine field_registry::field_registry_init ( class(field_registry_t), intent(inout)  this, integer, intent(in), optional  size, integer, intent(in), optional  expansion_size  )

private

Parameters

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

Definition at line 100 of file field_registry.f90.

field_registry_n_aliases()

pure integer function field_registry::field_registry_n_aliases ( class(field_registry_t), intent(in)  this )

private

Definition at line 234 of file field_registry.f90.

field_registry_n_fields()

pure integer function field_registry::field_registry_n_fields ( class(field_registry_t), intent(in)  this )

private

Definition at line 226 of file field_registry.f90.

Variable Documentation

neko_field_registry

type(field_registry_t), target, public field_registry::neko_field_registry

Definition at line 94 of file field_registry.f90.