point_zone_registry::point_zone_registry_t Type Reference

Collaboration diagram for point_zone_registry::point_zone_registry_t:

Public Member Functions
procedure, pass(this)	init (this, json, msh, expansion_size)
	Constructor, reading from json point zones.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	add_point_zone_from_json (this, json, dof)
	Adds a point zone object to the registry from a json object.
procedure, pass(this)	n_point_zones (this)
	Returns the number of point zones in the registry.
procedure, pass(this)	get_point_zone_by_index (this, i)
	Retrieves a point zone in the registry by its index in the point_zones array.
procedure, pass(this)	get_point_zone_by_name (this, name)
	Retrieves a point zone in the registry by its name.
procedure, pass(this)	get_expansion_size (this)
	Returns the expansion size with which the point_zone_registry_t was initialized.
procedure, pass(this)	get_size (this)
	Returns the total size of the point_zones array (not the number of point zones in the registry!).
procedure, pass(this)	point_zone_exists (this, name)
	Checks if a point zone exists in the registry.
generic	get_point_zone (this, i)
	Retrieves a point zone in the registry by its index in the point_zones array.
generic	get_point_zone (this, name)
	Retrieves a point zone in the registry by its name.
generic	add_point_zone (this, json, dof)
	Adds a point zone object to the registry from a json object.

Public Attributes
type(point_zone_wrapper_t), dimension(:), allocatable	point_zones
	List of point_zones stored.

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

Private Attributes
integer, private	n = 0
	Number of registered point_zones.
integer, private	expansion_size
	The size the point_zones array is increased by upon reallocation.

Detailed Description

Definition at line 47 of file point_zone_registry.f90.

Member Function/Subroutine Documentation

add_point_zone()

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

Parameters

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

Definition at line 80 of file point_zone_registry.f90.

Here is the call graph for this function:

add_point_zone_from_json()

procedure, pass(this) point_zone_registry::point_zone_registry_t::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
	)

Parameters

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

Definition at line 62 of file point_zone_registry.f90.

expand()

procedure, pass(this), private point_zone_registry::point_zone_registry_t::expand ( class(point_zone_registry_t), intent(inout)  this )

private

Definition at line 56 of file point_zone_registry.f90.

free()

procedure, pass(this) point_zone_registry::point_zone_registry_t::free

(

class(point_zone_registry_t), intent(inout)

this

)

Definition at line 60 of file point_zone_registry.f90.

get_expansion_size()

procedure, pass(this) point_zone_registry::point_zone_registry_t::get_expansion_size

(

class(point_zone_registry_t), intent(in)

this

)

Definition at line 72 of file point_zone_registry.f90.

get_point_zone() [1/2]

generic point_zone_registry::point_zone_registry_t::get_point_zone	(	class(point_zone_registry_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	Index in the point_zones array.

Definition at line 78 of file point_zone_registry.f90.

Here is the call graph for this function:

get_point_zone() [2/2]

generic point_zone_registry::point_zone_registry_t::get_point_zone	(	class(point_zone_registry_t), intent(in), target	this,
		character(len=*), intent(in)	name
	)

Parameters

name	Name of the point zone.

Definition at line 78 of file point_zone_registry.f90.

get_point_zone_by_index()

procedure, pass(this) point_zone_registry::point_zone_registry_t::get_point_zone_by_index	(	class(point_zone_registry_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	Index in the point_zones array.

Definition at line 67 of file point_zone_registry.f90.

get_point_zone_by_name()

procedure, pass(this) point_zone_registry::point_zone_registry_t::get_point_zone_by_name	(	class(point_zone_registry_t), intent(in), target	this,
		character(len=*), intent(in)	name
	)

Parameters

name	Name of the point zone.

Definition at line 69 of file point_zone_registry.f90.

get_size()

procedure, pass(this) point_zone_registry::point_zone_registry_t::get_size

(

class(point_zone_registry_t), intent(in)

this

)

Note

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

Definition at line 75 of file point_zone_registry.f90.

init()

procedure, pass(this) point_zone_registry::point_zone_registry_t::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
	)

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 58 of file point_zone_registry.f90.

n_point_zones()

procedure, pass(this) point_zone_registry::point_zone_registry_t::n_point_zones

(

class(point_zone_registry_t), intent(in)

this

)

Definition at line 64 of file point_zone_registry.f90.

point_zone_exists()

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

Parameters

name	Name of the point zone.

Definition at line 77 of file point_zone_registry.f90.

Member Data Documentation

expansion_size

integer, private point_zone_registry::point_zone_registry_t::expansion_size

private

Definition at line 53 of file point_zone_registry.f90.

n

integer, private point_zone_registry::point_zone_registry_t::n = 0

private

Definition at line 51 of file point_zone_registry.f90.

point_zones

type(point_zone_wrapper_t), dimension(:), allocatable point_zone_registry::point_zone_registry_t::point_zones

Definition at line 49 of file point_zone_registry.f90.

---

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

• /home/runner/work/neko/neko/src/mesh/point_zone_registry.f90