Neko  0.9.99
A portable framework for high-order spectral element flow simulations
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 build_combine_point_zone (object, json, dof)
 Constructs a combine_point_zone_t object. 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
Parameters
jsonJson object from which to initialize the point zone.
dofDofmap from which to map the point zone.

Definition at line 261 of file point_zone_registry.f90.

Here is the caller graph for this function:

◆ build_combine_point_zone()

subroutine point_zone_registry::build_combine_point_zone ( class(point_zone_t), intent(inout), allocatable, target  object,
type(json_file), intent(inout)  json,
type(dofmap_t), intent(inout)  dof 
)
private
Parameters
objectObject to allocate.
jsonJson object initializing the point zone.
dofDofmap from which to map to point zone.
n_allocated_zonesNumber of previously found and allocated zones in the registry.

Definition at line 196 of file point_zone_registry.f90.

Here is the caller graph for this function:

◆ expand()

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

Definition at line 247 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

Definition at line 326 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
Parameters
iIndex in the point_zones array.

Definition at line 336 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
Parameters
nameName of the point zone.

Definition at line 352 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
Note
Use n_point_zones() to retrieve the actual number of point zones in the registry.

Definition at line 317 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

Definition at line 306 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
Parameters
nameName of the point zone.

Definition at line 376 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

Definition at line 228 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
Parameters
jsonJson file object.
mshMesh associated with the point zone.
sizeSize of the point zone registry.
expansion_sizeExpansion 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 96 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

Definition at line 84 of file point_zone_registry.f90.