point_zone_registry Module Reference

Data Types
type	point_zone_registry_t

Functions/Subroutines
subroutine	point_zone_registry_init (this, json, msh, expansion_size)
	Constructor, reading from json point zones. More...
subroutine	point_zone_registry_free (this)
	Destructor. More...
subroutine	expand (this)
	Expand the point_zones array so as to accomodate more point_zones. More...
subroutine	add_point_zone_from_json (this, json, dof)
	Adds a point zone object to the registry from a json object. More...
pure integer function	n_point_zones (this)
	Returns the number of point zones in the registry. More...
pure integer function	get_size (this)
	Returns the total size of the point_zones array (not the number of point zones in the registry!). More...
pure integer function	get_expansion_size (this)
	Returns the expansion size with which the point_zone_registry_t was initialized. More...
class(point_zone_t) function, pointer	get_point_zone_by_index (this, i)
	Retrieves a point zone in the registry by its index in the point_zones array. More...
class(point_zone_t) function, pointer	get_point_zone_by_name (this, name)
	Retrieves a point zone in the registry by its name. More...
logical function	point_zone_exists (this, name)
	Checks if a point zone exists in the registry. More...

Variables
type(point_zone_registry_t), target, public	neko_point_zone_registry
	Global point_zone registry. More...

Function/Subroutine Documentation

add_point_zone_from_json()

subroutine point_zone_registry::add_point_zone_from_json ( class(point_zone_registry_t), intent(inout)  this, type(json_file), intent(inout)  json, type(dofmap_t), intent(inout), target  dof  )

private

Adds a point zone object to the registry from a json object.

Parameters

json	Json object from which to initialize the point zone.
dof	Dofmap from which to map the point zone.

Definition at line 197 of file point_zone_registry.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

expand()

subroutine point_zone_registry::expand ( class(point_zone_registry_t), intent(inout)  this )

private

Expand the point_zones array so as to accomodate more point_zones.

Definition at line 183 of file point_zone_registry.f90.

get_expansion_size()

pure integer function point_zone_registry::get_expansion_size ( class(point_zone_registry_t), intent(in)  this )

private

Returns the expansion size with which the point_zone_registry_t was initialized.

Definition at line 262 of file point_zone_registry.f90.

get_point_zone_by_index()

class(point_zone_t) function, pointer point_zone_registry::get_point_zone_by_index ( class(point_zone_registry_t), intent(in), target  this, integer, intent(in)  i  )

private

Retrieves a point zone in the registry by its index in the point_zones array.

Parameters

i	Index in the point_zones array.

Definition at line 272 of file point_zone_registry.f90.

Here is the caller graph for this function:

get_point_zone_by_name()

class(point_zone_t) function, pointer point_zone_registry::get_point_zone_by_name ( class(point_zone_registry_t), intent(in), target  this, character(len=*), intent(in)  name  )

private

Retrieves a point zone in the registry by its name.

Parameters

name	Name of the point zone.

Definition at line 288 of file point_zone_registry.f90.

Here is the caller graph for this function:

get_size()

pure integer function point_zone_registry::get_size ( class(point_zone_registry_t), intent(in)  this )

private

Returns the total size of the point_zones array (not the number of point zones in the registry!).

Note

Use n_point_zones() to retrieve the actual number of point zones in the registry.

Definition at line 253 of file point_zone_registry.f90.

n_point_zones()

pure integer function point_zone_registry::n_point_zones ( class(point_zone_registry_t), intent(in)  this )

private

Returns the number of point zones in the registry.

Definition at line 242 of file point_zone_registry.f90.

point_zone_exists()

logical function point_zone_registry::point_zone_exists ( class(point_zone_registry_t), intent(in), target  this, character(len=*), intent(in)  name  )

private

Checks if a point zone exists in the registry.

Parameters

name	Name of the point zone.

Definition at line 312 of file point_zone_registry.f90.

point_zone_registry_free()

subroutine point_zone_registry::point_zone_registry_free ( class(point_zone_registry_t), intent(inout)  this )

private

Destructor.

Definition at line 164 of file point_zone_registry.f90.

point_zone_registry_init()

subroutine point_zone_registry::point_zone_registry_init ( class(point_zone_registry_t), intent(inout)  this, type(json_file), intent(inout)  json, type(mesh_t), intent(inout), target  msh, integer, intent(in), optional  expansion_size  )

private

Constructor, reading from json point zones.

Parameters

json	Json file object.
msh	Mesh associated with the point zone.
size	Size of the point zone registry.
expansion_size	Expansion size for the point zone registry.

Note

At this stage, the point_zone registry is only allocated if we find anything in the case.point_zones json path. Any point_zones that are not defined in that way will need to be added using the add_point_zone subroutine.

Definition at line 94 of file point_zone_registry.f90.

Here is the call graph for this function:

Variable Documentation

neko_point_zone_registry

type(point_zone_registry_t), target, public point_zone_registry::neko_point_zone_registry

Global point_zone registry.

Definition at line 82 of file point_zone_registry.f90.