centroids_oct_m Module Reference

Data Types
type	centroids_t
	Encapsulate centroid points and their indexing across a domain-decomposed mesh. More...

Functions/Subroutines
subroutine	centroids_init (this, mesh, positions, check_duplicates)
	Initialise a centroids_t instance. More...
pure integer function	centroids_get_n_centroids (this)
	Number of centroids in local domain. More...
pure integer function	centroids_get_n_centroids_global (this)
	Total number of centroids in system. More...
pure integer(int64) function	centroids_global_centroid_to_global_mesh_index (this, ic)
	Given centroid index ic, return the global mesh index ipg. More...
pure integer(int64) function, dimension(:), allocatable	centroids_global_centroid_to_global_mesh_indices (this)
	Return global mesh indices for all centroids in this domain. More...
pure integer function	centroids_get_local_mesh_index (this, ic)
	Get the mesh index ip of centroid ic in this domain. More...
pure integer function, dimension(:), allocatable	centroids_get_local_mesh_indices (this)
	Return mesh indices ip for all centroids in this domain. More...
pure integer function	centroids_local_index_to_global_index (this, ic)
	Get the global centroid index, given centroid ic this domain. More...
pure integer function, dimension(:), allocatable	centroids_local_index_to_global_indices (this)
	Return global centroid indices for all centroids in this domain. More...
pure real(real64) function, dimension(this%ndim)	centroids_get_local_position (this, mesh, ic)
	Get the position of the centroid ic. More...
pure real(real64) function, dimension(:, :), allocatable	centroids_get_all_positions (this)
	Return a copy of all centroid positions. More...
subroutine	centroids_output_all_indices (this, fname)
	Output all centroid indices, across all domains. More...
subroutine	centroids_finalize (this)
	Finalize a centroids instance. More...
subroutine	exact_centroids_init_index_maps (this, mesh, check_duplicates)
	Initialise index maps with centroid points that are commensurate with the grid. More...
subroutine	remove_duplicates_int64 (indices)
	Remove duplicates from an array of integers. More...

Function/Subroutine Documentation

centroids_init()

subroutine centroids_oct_m::centroids_init ( class(centroids_t), intent(out)  this, class(mesh_t), intent(in)  mesh, real(real64), dimension(:, :), intent(in)  positions, logical, intent(in), optional  check_duplicates  )

private

Initialise a centroids_t instance.

Centroid positions must correspond to grid points.

Parameters

[out]	this	Centroid instance
[in]	mesh	Mesh or grid instance
[in]	positions	All centroid cartesian positions
[in]	check_duplicates	Check for duplicate grid indices,

Definition at line 191 of file centroids.F90.

centroids_get_n_centroids()

pure integer function centroids_oct_m::centroids_get_n_centroids ( class(centroids_t), intent(in)  this )

private

Number of centroids in local domain.

Definition at line 211 of file centroids.F90.

centroids_get_n_centroids_global()

pure integer function centroids_oct_m::centroids_get_n_centroids_global ( class(centroids_t), intent(in)  this )

private

Total number of centroids in system.

Definition at line 221 of file centroids.F90.

centroids_global_centroid_to_global_mesh_index()

pure integer(int64) function centroids_oct_m::centroids_global_centroid_to_global_mesh_index ( class(centroids_t), intent(in)  this, integer, intent(in)  ic  )

private

Given centroid index ic, return the global mesh index ipg.

Note

One could alternatively implement this with:

ip = this%ic_to_ip(ic)
ipg = mesh_local2global(mesh, ip)

which would remove the need to store icg_to_ipg, but this would require mesh to be an argument of the function.

Definition at line 240 of file centroids.F90.

centroids_global_centroid_to_global_mesh_indices()

pure integer(int64) function, dimension(:), allocatable centroids_oct_m::centroids_global_centroid_to_global_mesh_indices ( class(centroids_t), intent(in)  this )

private

Return global mesh indices for all centroids in this domain.

Definition at line 253 of file centroids.F90.

centroids_get_local_mesh_index()

pure integer function centroids_oct_m::centroids_get_local_mesh_index ( class(centroids_t), intent(in)  this, integer, intent(in)  ic  )

private

Get the mesh index ip of centroid ic in this domain.

Definition at line 269 of file centroids.F90.

centroids_get_local_mesh_indices()

pure integer function, dimension(:), allocatable centroids_oct_m::centroids_get_local_mesh_indices ( class(centroids_t), intent(in)  this )

private

Return mesh indices ip for all centroids in this domain.

Definition at line 280 of file centroids.F90.

centroids_local_index_to_global_index()

pure integer function centroids_oct_m::centroids_local_index_to_global_index ( class(centroids_t), intent(in)  this, integer, intent(in)  ic  )

private

Get the global centroid index, given centroid ic this domain.

Definition at line 290 of file centroids.F90.

centroids_local_index_to_global_indices()

pure integer function, dimension(:), allocatable centroids_oct_m::centroids_local_index_to_global_indices ( class(centroids_t), intent(in)  this )

private

Return global centroid indices for all centroids in this domain.

Definition at line 301 of file centroids.F90.

centroids_get_local_position()

pure real(real64) function, dimension(this%ndim) centroids_oct_m::centroids_get_local_position ( class(centroids_t), intent(in)  this, class(mesh_t), intent(in)  mesh, integer, intent(in)  ic  )

private

Get the position of the centroid ic.

Definition at line 311 of file centroids.F90.

centroids_get_all_positions()

pure real(real64) function, dimension(:, :), allocatable centroids_oct_m::centroids_get_all_positions ( class(centroids_t), intent(in)  this )

private

Return a copy of all centroid positions.

Definition at line 324 of file centroids.F90.

centroids_output_all_indices()

subroutine centroids_oct_m::centroids_output_all_indices ( class(centroids_t), intent(in)  this, character(len=*), intent(in)  fname  )

private

Output all centroid indices, across all domains.

Parameters

[in]	this	Centroid instance
[in]	fname	File name

Definition at line 335 of file centroids.F90.

centroids_finalize()

subroutine centroids_oct_m::centroids_finalize ( type(centroids_t), intent(inout)  this )

private

Finalize a centroids instance.

Parameters

[in,out]

this

Centroid instance

Definition at line 358 of file centroids.F90.

exact_centroids_init_index_maps()

subroutine centroids_oct_m::exact_centroids_init_index_maps ( type(centroids_t), intent(inout)  this, class(mesh_t), intent(in)  mesh, logical, intent(in)  check_duplicates  )

private

Initialise index maps with centroid points that are commensurate with the grid.

This routine breaks single responsibility, but it makes sense to reuse the the various indices as they are computed. This routine computes:

• Convert centroid positions to global mesh index, ipg
• Set number of centroids in the domain of process
• Map global centroid index icg to centroid index in domain process
• Map centroid index ic in domain process, to mesh index ip in the same domain

  Parameters

  [in]	mesh	Mesh or grid instance
  [in]	check_duplicates	Check for duplicate grid indices,

Definition at line 379 of file centroids.F90.

remove_duplicates_int64()

subroutine centroids_oct_m::remove_duplicates_int64 ( integer(int64), dimension(:), intent(inout), allocatable  indices )

private

Remove duplicates from an array of integers.

Parameters

[in,out]

indices

In: Set of indices

Definition at line 453 of file centroids.F90.