adam_tree_object

ADAM, tree class definition. The tree data structure is organized as a hash table and can be arranged as octree or quadtree simply adopting the proper refinement ratio, namely 8 or 4 ratio respectively.

The tree exploits the Morton order for the linearization of the tree. A prototype of quadtree is represented below.

        j^
L=0      |
  L=1    |
    L=2  |
      L=3|
         |------------------------------------------------
      7  |  10   11  |  14   15  |  58   59  |  62   63  |
    3----|    10     |    11     |    14     |    15     |
      6  |  8    9   |  12   13  |  56   57  |  60   61  |
  1------|---------- 2 ----------|---------- 3 ----------|
      5  |  34   45  |  38   39  |  50   51  |  54   55  |
    2----|     8     |     9     |    12     |    13     |
      4  |  32   33  |  36   37  |  48   49  |  52   53  |
0--------|-----------|--------- -1 ----------|-----------|
      3  |  10   11  |  14   15  |  26   27  |  30   31  |
    1----|     2     |     3     |     6     |     7     |
      2  |  8    9   |  12   13  |  24   25  |  28   29  |
  0------|---------- 0 ----------|---------- 1 ----------|
      1  |  2    3   |  6    7   |  18   19  |  22   23  |
    0----|     0     |     1     |     4     |     5     |
      0  |  0    1   |  4    5   |  16   17  |  20   21  |
         O------------------------------------------------------>
            0 |  1   |  2 |  3   |  4 |  5   |  6 |  7     L=3  i
              0      |    1      |    2      |    3        L=2
                     0           |           1             L=1
                                 0                         L=0

In the above representation each refinement level is represented alone, namely without taking into account the existence of previous levels. However, the real hierarchy can be taken into account by simply adding the offset derived from the previous levels, thus the numbering becomes as below.

        j^
L=0      |
  L=1    |
    L=2  |
      L=3|
         |------------------------------------------------
      7  |  62   63  |  66   67  |  78   79  |  82   63  |
    3----|    14     |    15     |    18     |    19     |
      6  |  60   61  |  64   65  |  76   77  |  80   81  |
  1------|---------- 2 ----------|---------- 3 ----------|
      5  |  54   55  |  58   59  |  70   71  |  74   75  |
    2----|    12     |    13     |    16     |    17     |
      4  |  52   53  |  56   57  |  68   69  |  72   73  |
0--------|-----------|--------- -1 ----------|-----------|
      3  |  30   31  |  34   35  |  46   47  |  50   51  |
    1----|     6     |     7     |    10     |    11     |
      2  |  28   29  |  32   33  |  44   45  |  48   49  |
  0------|---------- 0 ----------|---------- 1 ----------|
      1  |  22   23  |  26   27  |  38   39  |  42   43  |
    0----|     4     |     5     |     8     |     9     |
      0  |  20   21  |  24   25  |  36   37  |  40   41  |
         O------------------------------------------------------>
            0 |  1   |  2 |  3   |  4 |  5   |  6 |  7     L=3  i
              0      |    1      |    2      |    3        L=2
                     0           |           1             L=1
                                 0                         L=0

This last numbering is the complete Morton order where the Morton code ideintifing a node entails all the spatial information, the refinement level L and the spatial coordinatates IJ. Sometimes it is convenient to use the representation where level L is not encoded into the Morton order, but the conversion is as as adding the offset of previous level, namely using the funcion first_at_level. Note that the ancestor node has Morton code -1, it is the ancestor of all nodes, it is Adam. For the octree case (3D case) the ordering is equivalent, simply the local children fall in [0,7] instead of [0,3], namely the local numbering is always [0, ratio-1], as represented below.

^ /|\Z | | G--------------------H | /| /| /| | / | / | / | | / | / | / | | / | / | / | | / -----/---------/---- | 6 <-------/--+ /| / /| / +---------> 7 | --------------------* / | | /| / | /| / | /| / | | / | / | / | / | / | / | | / | / E/--|-/----/--|-/----F | 2 <-----/---|/--+ // |/ // |/ +---------> 3 | / -----/---------/---- / | 4 <--------/--+ /| // /| // +------------> 5 | C--------------------D / | / | | / | / | / | / | / | / | | / |/ | / |/ | / |/ | | / ---|-/-------|-/---- | 0 <-----|/--+ / |/ / |/ +------------> 1 | --------------------* / | | / | / | / | | / | / | / | _ Y | / | / | / | /| |/ |/ |/ | / A----------*----------B | / |/ X o------------------------------------------------------------------->

Edges numeration: AC = fec-7 BD = fec-8 EG = fec-9 FH = fec-10 AE = fec-11 BF = fec-12 CG = fec-13 DH = fec-14 AB = fec-15 EF = fec-16 CD = fec-17 GH = fec-18 Corners numeration: A = fec-19 B = fec-20 E = fec-21 F = fec-22 C = fec-23 D = fec-24 G = fec-25 H = fec-26

Source: src/lib/common/adam_tree_object.F90

Dependencies

Contents

• tree_object
• adapt
• get_closest_cells
• initialize
• load_nodes
• load_from_ini_file
• make_neighborhood
• mark_all_nodes
• mark_sphere
• prune
• resize
• save_nodes
• traverse
• update_blocks_coordinates
• import_refinements_needed
• mpi_redistribute
• get_neighbor_all
• is_greater_by_level
• is_greater_by_pos
• is_lower_by_level
• is_lower_by_pos
• morton_to_coordinates1D
• morton_to_coordinates2D
• morton_to_coordinates3D
• print_code_topology
• add_node
• derefine
• empty
• refine
• remove_node
• sanitize
• codes
• description
• get_closest_block
• has_code
• hash
• loop
• max_cell_delta
• node
• prime_buckets_number
• level
• all_siblings
• child
• child_local
• children
• coordinates1D_to_morton
• coordinates2D_to_morton
• coordinates3D_to_morton
• finest_at_level
• first_at_level
• first_common_parent
• greater
• last_at_level
• lower
• parent
• parent_at_level
• path
• siblings

Variables

Name	Type	Attributes	Description
NODE_LESS_REFINED	integer(kind=I4P)	parameter	Less refined node type.
NODE_STANDARD	integer(kind=I4P)	parameter	Standard node type.
NODE_MORE_REFINED	integer(kind=I4P)	parameter	More refined node type.
NODE_BOUNDARY_CONDITION	integer(kind=I4P)	parameter	Boundary condition node type.
TREE_BUCKETS_NUMBER_DEF	integer(kind=I8P)	parameter	Default number of buckets of hash table.
TREE_MAX_LOAD	real(kind=R8P)	parameter	Maximum load of hash table buckets.
TREE_MAX_SANITIZE_ITERATIONS	integer(kind=I4P)	parameter	Default number of tree sanitize iterations.

Derived Types

tree_object

Tree class definition.

Components

Name	Type	Attributes	Description
mpih	type(mpih_object)		MPI handler.
grid	type(grid_object)	pointer	Grid data.
bucket	type(tree_bucket_object)	allocatable	Tree buckets.
buckets_number	integer(kind=I8P)		Number of buckets used.
nodes_number	integer(kind=I4P)		Number of nodes actually stored, namely the tree length.
max_load	real(kind=R8P)		Maximum load of tree buckets.
ratio	integer(kind=I4P)		Refinement ratio.
max_level	integer(kind=I4P)		Maximum refinement level.
is_initialized_	logical		Initialization status.
ijkl_prune	integer(kind=I4P)		IJKL prune indexes for simple-initial-forest.
iu_ref_levels	integer(kind=I4P)		Initial uniform refinement levels.
my_nodes_number	integer(kind=I4P)		Number of my nodes, keep_nodes_number + recv_nodes_number.
n_my_derefine	integer(kind=I8P)		Number of my nodes to be derefined.
n_my_refine	integer(kind=I8P)		Number of my nodes to be refined.
last_block_index	integer(kind=I8P)		Last block index in the field array.
node_to_refine	integer(kind=I8P)	allocatable	List of nodes to be refined.
node_to_derefine	integer(kind=I8P)	allocatable	List of nodes to be derefined.
block_to_refine	integer(kind=I8P)	allocatable	List of field blocks to be refined.
block_refined	integer(kind=I8P)	allocatable	List of field refined blocks with Morton code.
block_to_derefine	integer(kind=I8P)	allocatable	List of field blocks to be derefined.
block_derefined	integer(kind=I8P)	allocatable	List of field derefined blocks with Morton code.
block_coordinates	integer(kind=I4P)	allocatable	Block coordinates of redistributed blocks [4,blocks_number].
block_code	integer(kind=I8P)	allocatable	Block Morton code of redistributed blocks [blocks_number].

Type-Bound Procedures

Name	Attributes	Description
adapt	pass(self)	Adapt tree accordingly to refine/derefine necessity.
codes	pass(self)	Return the list of (sorted) codes actually stored in the tree.
description	pass(self)	Return pretty-printed object description.
get_closest_block	pass(self)	Get the closest block to a given point.
get_closest_cells	pass(self)	Get the closest cells to a given point.
hash	pass(self)	Hash the key.
has_code	pass(self)	Check if the code is present in the tree.
initialize	pass(self)	Initialize the tree.
load_nodes	pass(self)	Load nodes data, used for restart.
load_from_ini_file	pass(self)	Load object data from INI file.
loop	pass(self)	Sentinel while-loop on nodes returning the code.
mark_all_nodes	pass(self)	Mark all nodes to be refined, derefined, ecc.
mark_sphere	pass(self)	Mark nodes to be refined/derefined by sphere distance.
max_cell_delta	nopass	Return the maximum cell delta given a comparison distance.
node	pass(self)	Return a pointer to a node.
prime_buckets_number	pass(self)	Return the buckets number as nearest prime number given nodes number.
prune	pass(self)	Prune nodes.
resize	pass(self)	Resize the tree.
save_nodes	pass(self)	Save nodes data, used for restart.
traverse	pass(self)	Traverse tree calling the iterator procedure.
update_blocks_coordinates	pass(self)	Update blocks coordinates of redistributed nodes.
import_refinements_needed	pass(self)	Import refinements needed status changed externally.
mpi_redistribute	pass(self)	Redistribute nodes to MPI processes, load balancing.
coordinates_to_morton		Return the Morton code given space-level coordinates.
level	pass(self)	Return the refinement level given the code.
morton_to_coordinates		Return the space-level coordinates given Morton code.
all_siblings	pass(self)	Return all siblings Morton code given Morton code.
child	pass(self)	Return the i-th child given Morton code.
child_local	pass(self)	Return the child index in the local numbering.
children	pass(self)	Return the children list given Morton code.
coordinates3D_to_morton	pass(self)	Return the Morton code given ijkl coordinates.
coordinates2D_to_morton	pass(self)	Return the Morton code given ijl coordinates.
coordinates1D_to_morton	pass(self)	Return the Morton code given il coordinates.
finest_at_level	pass(self)	Return the finest node code at given level.
first_at_level	pass(self)	Return the first node code at given level.
first_common_parent	pass(self)	Return the first common parent given two codes.
get_neighbor_all	pass(self)	Return the neighbor given face/edge/corner of given Morton code.
greater	pass(self)	Return true if code is greater than other.
is_greater_by_level	pass(self)	Return true if code is greater than other, comparing level.
is_greater_by_pos	pass(self)	Return true if code is greater than other, comparing position
is_lower_by_level	pass(self)	Return true if code is lower than other, comparing level.
is_lower_by_pos	pass(self)	Return true if code is lower than other, comparing position.
last_at_level	pass(self)	Return the last node code at given level.
lower	pass(self)	Return true if code is lower than other.
make_neighborhood	pass(self)	Make neighborhood all whole tree and store it in nodes.
morton_to_coordinates3D	pass(self)	Return the ijkl coordinates given Morton code.
morton_to_coordinates2D	pass(self)	Return the ijl coordinates given Morton code.
morton_to_coordinates1D	pass(self)	Return the il coordinates given Morton code.
parent	pass(self)	Return the parent given Morton code.
parent_at_level	pass(self)	Return the parent given Morton code at given level.
path	pass(self)	Return the path codes, the list of codes from given node to root.
print_code_topology	pass(self)	Print all code topology data.
siblings	pass(self)	Return the siblings Morton code given Morton code.
add_node	pass(self)	Add a node pointer to the tree.
derefine	pass(self)	Derefine nodes.
empty	pass(self)	Empty tree, i.e. remove all nodes, without destroy the tree.
refine	pass(self)	Refine nodes.
remove_node	pass(self)	Remove a node from the tree, given the key.
sanitize	pass(self)	Sanitize the tree.

Subroutines

adapt

Adapt tree accordingly to refine/derefine necessity.

subroutine adapt(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

get_closest_cells

Get the closest cells to a given point.

subroutine get_closest_cells(self, point, code, ijk, v, xyz)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
point	real(kind=R8P)	in		Point xyz coordinates.
code	integer(kind=I8P)	in		The Morton code of the closest block.
ijk	integer(kind=I4P)	out		Closest cells indexes.
v	integer(kind=I4P)	out	optional	Closest vertex index.
xyz	real(kind=R8P)	out	optional	Closest cells center-coordinates.

Call graph

initialize

Initialize the tree.

subroutine initialize(self, grid, file_parameters, max_load, nodes_number, buckets_number, ratio, max_level, add_adam, iu_ref_levels, i_prune, j_prune, k_prune, l_prune)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
grid	type(grid_object)	in	target	Grid data.
file_parameters	type(file_ini)	inout	optional	INI file handler.
max_load	real(kind=R8P)	in	optional	Maximum load of tree buckets.
nodes_number	integer(kind=I8P)	in	optional	Nodes number to be stored in the tree.
buckets_number	integer(kind=I8P)	in	optional	Number of buckets for initialize the tree.
ratio	integer(kind=I4P)	in	optional	Refinement ratio.
max_level	integer(kind=I4P)	in	optional	Maximum refinement level.
add_adam	logical	in	optional	Add ADAM node, the ancestor of all nodes.
iu_ref_levels	integer(kind=I4P)	in	optional	Uniform initial refinement.
i_prune	integer(kind=I4P)	in	optional	Pruning along x.
j_prune	integer(kind=I4P)	in	optional	Pruning along y.
k_prune	integer(kind=I4P)	in	optional	Pruning along z.
l_prune	integer(kind=I4P)	in	optional	Pruning level.

Call graph

load_nodes

Load nodes data, used for restart.

Note: the tree is made empty before lading nodes data.

subroutine load_nodes(self, file_name)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
file_name	character(len=*)	in		Output file name.

Call graph

load_from_ini_file

Load object data from INI file.

subroutine load_from_ini_file(self, file_parameters)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
file_parameters	type(file_ini)	inout		INI file handler.

Call graph

make_neighborhood

Make neighborhood all whole tree and store it in nodes.

subroutine make_neighborhood(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

mark_all_nodes

Mark all nodes to be refined, derefined, ecc.

subroutine mark_all_nodes(self, mark)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
mark	integer(kind=I4P)	in		Mark to be imposed [TO_BE_REFINED,...].

Call graph

mark_sphere

Mark all nodes inside a sphere to be refined.

subroutine mark_sphere(self, center, radius, threshold)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
center	real(kind=R8P)	in		Sphere center coordinates [x,y,z].
radius	real(kind=R8P)	in		Sphere radius.
threshold	real(kind=R8P)	in	optional	Threshold for sphere proximity.

Call graph

prune

Prune nodes.

subroutine prune(self, ijkl_prune)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
ijkl_prune	integer(kind=I4P)	inout		Maximum coordinates after which the prune operates.

Call graph

resize

Resize the tree.

subroutine resize(self, nodes_number, max_load)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
nodes_number	integer(kind=I8P)	in		Nodes number to be stored in the tree.
max_load	real(kind=R8P)	in	optional	Maximum load of tree buckets.

Call graph

save_nodes

Save nodes data, used for restart.

subroutine save_nodes(self, file_name)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
file_name	character(len=*)	in		Output file name.

Call graph

traverse

Traverse tree calling the iterator procedure.

subroutine traverse(self, iterator)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
iterator	procedure(iterator_interface)			The (key) iterator procedure to call for each node.

Call graph

update_blocks_coordinates

Update blocks coordinates of redistributed nodes.

subroutine update_blocks_coordinates(self, my_nodes_number)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
my_nodes_number	integer(kind=I4P)	in		Number of my nodes, keep_nodes_number + recv_nodes_number.

Call graph

import_refinements_needed

Import refinements needed status changed externally.

subroutine import_refinements_needed(self, refinements_needed_all, disp_count)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
refinements_needed_all	integer(kind=I4P)	in	allocatable	Refinements needed of all blocks.
disp_count	integer(kind=I4P)	in	allocatable	Displacement of blocks that are received from process.

Call graph

mpi_redistribute

Redistribute nodes to processes, load balancing.

The nodes are distributed among all process exploiting the Morton ordering spatiality. Simply, the sorted list of codes are splitted in chunk of nodes_number/procs_number balancing the workload. However, the algorithm checks if the splits fall among siblings that cannot be splitted: if this scenario happens the siblings are placed in the same process for preserving the spatiality. The algorithm is sophisticated enough to place the siblings alternatively to the left or right process accordingly to where the split falls, namely to the right if the split falls in the first half of siblings or to the left if it falls in the second half.

subroutine mpi_redistribute(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

get_neighbor_all

Return the neighbor in a given face/edge/corner of given Morton code.

The direction fec is organized as: faces=[1,6], edges=[7,18], corners=[19,26].

We define direct neighbor the neighbor of given code in the given face at the same level of the given code either if it exists or not.

subroutine get_neighbor_all(self, code, face, neighbor, neighbor_type, neighbor_portion, neighbor_bc_fec)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
face	integer(kind=I4P)	in		Face queried.
neighbor	integer(kind=I8P)	out	allocatable	Neighbors codes list, [1] or [ratio/2].
neighbor_type	integer(kind=I4P)	out		Type of neighbor.
neighbor_portion	integer(kind=I4P)	out	optional	Neighbors portion.
neighbor_bc_fec	integer(kind=I4P)	out	optional	Neighbors fec for BC.

Call graph

is_greater_by_level

Return true if code is greater than other, comparing level.

subroutine is_greater_by_level(self, lhs, rhs, res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.
res	logical	out		Comparison result.

Call graph

is_greater_by_pos

Return true if code is greater than other, comparing position.

subroutine is_greater_by_pos(self, lhs, rhs, res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.
res	logical	out		Comparison result.

Call graph

is_lower_by_level

Return true if code is lower than other, comparing level.

subroutine is_lower_by_level(self, lhs, rhs, res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.
res	logical	out		Comparison result.

Call graph

is_lower_by_pos

Return true if code is lower than other, comparing position.

subroutine is_lower_by_pos(self, lhs, rhs, res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.
res	logical	out		Comparison result.

Call graph

morton_to_coordinates1D

Return the il coordinates given Morton code.

subroutine morton_to_coordinates1D(self, code, i, l)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
i	integer(kind=I4P)	out		I coordinate.
l	integer(kind=I4P)	out		L coordinate.

Call graph

morton_to_coordinates2D

Return the ijl coordinates given Morton code.

subroutine morton_to_coordinates2D(self, code, i, j, l)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
i	integer(kind=I4P)	out		I coordinate.
j	integer(kind=I4P)	out		J coordinate.
l	integer(kind=I4P)	out		L coordinate.

Call graph

morton_to_coordinates3D

Return the ijkl coordinates given Morton code.

subroutine morton_to_coordinates3D(self, code, i, j, k, l)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
i	integer(kind=I4P)	out		I coordinate.
j	integer(kind=I4P)	out		J coordinate.
k	integer(kind=I4P)	out		K coordinate.
l	integer(kind=I4P)	out		L coordinate.

Call graph

print_code_topology

Print all code topology data.

subroutine print_code_topology(self, code, coordinates, level, parent, parents, path, child, child_local_code, finest, siblings, neighbor, block_index, whole)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
coordinates	logical	in	optional	Coordinates.
level	logical	in	optional	Level of node.
parent	logical	in	optional	Parent of code.
parents	logical	in	optional	Parents list.
path	logical	in	optional	Path from node to parent of first level.
child	logical	in	optional	(First) Child of code.
child_local_code	logical	in	optional	Local child-numbering of code.
finest	logical	in	optional	Finest Morton code.
siblings	logical	in	optional	Siblings of code.
neighbor	logical	in	optional	Neighbor of code.
block_index	logical	in	optional	Block index in the field array.
whole	logical	in	optional	Whole topology data.

Call graph

add_node

Add a node pointer to the tree.

@note If a node with the same key is already in the tree, it is removed and the new one will replace it.

subroutine add_node(self, code, refinement_needed, rank, block_index, update_last_block_index)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
code	integer(kind=I8P)	in		The Morton code.
refinement_needed	integer(kind=I4P)	in	optional	Flag for refinement/derefinement algorithm.
rank	integer(kind=I4P)	in	optional	MPI rank process.
block_index	integer(kind=I8P)	in	optional	Block index in the field array.
update_last_block_index	logical	in	optional	Update or not last block index.

Call graph

derefine

Derefine nodes.

subroutine derefine(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

empty

Empty tree, i.e. remove all nodes, without destroy the tree.

subroutine empty(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

refine

Refine nodes.

subroutine refine(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.

Call graph

remove_node

Remove a node from the tree, given the code.

subroutine remove_node(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
code	integer(kind=I8P)	in		The Morton code.

Call graph

sanitize

Sanitize the tree.

subroutine sanitize(self, iterations_number)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
iterations_number	integer(kind=I4P)	in	optional	Sanitazie iterations number.

Call graph

Functions

codes

Return the list of (sorted) codes actually stored in the tree.

Returns: integer(kind=I8P)

function codes(self, only_mine, sort_by_level)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
only_mine	logical	in	optional	If true return only the nodes of myrank process.
sort_by_level	logical	in	optional	If true sort codes be level instead of position.

Call graph

description

Return a pretty-formatted object description.

Attributes: pure

Returns: character(len=:)

function description(self) result(desc)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.

Call graph

get_closest_block

Get the closest block to a given point.

Returns: integer(kind=I8P)

function get_closest_block(self, point) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	inout		The tree.
point	real(kind=R8P)	in		Point xyz coordinates.

Call graph

has_code

Check if the key is present in the tree.

Returns: logical

function has_code(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		The Morton code.

Call graph

hash

Hash the key.

Attributes: elemental

Returns: integer(kind=I4P)

function hash(self, code) result(bucket)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		The Morton code.

Call graph

loop

Sentinel while-loop on nodes returning the code (for tree looping).

Returns: logical

function loop(self, code, node_ptr) result(again)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree bucket.
code	integer(kind=I8P)	out	optional	The Morton code.
node_ptr	type(tree_node_object)	out	pointer, optional	Pointer to current node.

Call graph

max_cell_delta

Return the maximum cell delta given a comparison distance.

Returns: real(kind=R8P)

function max_cell_delta(distance) result(delta)

Arguments

Name	Type	Intent	Attributes	Description
distance	real(kind=R8P)	in		Comparison distance.

Call graph

node

Return a pointer to a node in the tree.

Returns: type(tree_node_object)

function node(self, code) result(p)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		The Morton code.

Call graph

prime_buckets_number

Return the buckets number as the nearest prime number given nodes number.

@note The balanced buckets number is computing considering the tree load defined in self and using the Sieve of Eratoshenes for findining the nearest prime number.

Attributes: elemental

Returns: integer(kind=I8P)

function prime_buckets_number(self, nodes_number) result(buckets_number)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
nodes_number	integer(kind=I8P)	in		Nodes number to be stored in the tree.

Call graph

level

Return the refinement level given the code.

Attributes: elemental

Returns: integer(kind=I4P)

function level(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

all_siblings

Return all siblings Morton code given Morton code (included into the list).

Attributes: pure

Returns: integer(kind=I8P)

function all_siblings(self, code) result(siblings)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

child

Return the i-th child given Morton code.

Attributes: elemental

Returns: integer(kind=I8P)

function child(self, code, i)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
i	integer(kind=I4P)	in		Child index [0, ratio-1].

Call graph

child_local

Return the child index in the local numbering.

Attributes: elemental

Returns: integer(kind=I8P)

function child_local(self, code) result(child)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

children

Return the children given Morton code.

Attributes: pure

Returns: integer(kind=I8P)

function children(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

coordinates1D_to_morton

Return the Morton code given ijl coordinates.

Returns: integer(kind=I8P)

function coordinates1D_to_morton(self, i, l) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
i	integer(kind=I4P)	in		I coordinate.
l	integer(kind=I4P)	in		L coordinate.

Call graph

coordinates2D_to_morton

Return the Morton code given ijl coordinates.

Returns: integer(kind=I8P)

function coordinates2D_to_morton(self, i, j, l) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
i	integer(kind=I4P)	in		I coordinate.
j	integer(kind=I4P)	in		J coordinate.
l	integer(kind=I4P)	in		L coordinate.

Call graph

coordinates3D_to_morton

Return the Morton code given ijkl coordinates.

Returns: integer(kind=I8P)

function coordinates3D_to_morton(self, i, j, k, l) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
i	integer(kind=I4P)	in		I coordinate.
j	integer(kind=I4P)	in		J coordinate.
k	integer(kind=I4P)	in		K coordinate.
l	integer(kind=I4P)	in		L coordinate.

Call graph

finest_at_level

Return the inest node code at given level, namely the last child at a given level.

Attributes: elemental

Returns: integer(kind=I8P)

function finest_at_level(self, code, level) result(finest)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
level	integer(kind=I4P)	in		Refinement level.

Call graph

first_at_level

Return the first node code at given level.

Attributes: elemental

Returns: integer(kind=I8P)

function first_at_level(self, level) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
level	integer(kind=I4P)	in		Refinement level.

Call graph

first_common_parent

Return the first common parent given two codes.

Attributes: elemental

Returns: integer(kind=I8P)

function first_common_parent(self, code1, code2) result(fc_parent)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code1	integer(kind=I8P)	in		Morton codes.
code2	integer(kind=I8P)	in		Morton codes.

greater

Return true if code is greater than other.

Attributes: elemental

Returns: logical

function greater(self, lhs, rhs) result(res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.

Call graph

last_at_level

Return the last node code at given level.

Attributes: elemental

Returns: integer(kind=I8P)

function last_at_level(self, level) result(code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
level	integer(kind=I4P)	in		Refinement level.

Call graph

lower

Return true if code is lower than other.

Attributes: elemental

Returns: logical

function lower(self, lhs, rhs) result(res)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
lhs	integer(kind=I8P)	in		Left hand side of code comparison.
rhs	integer(kind=I8P)	in		Right hand side of code comparison.

Call graph

parent

Return the parent given Morton code.

Attributes: elemental

Returns: integer(kind=I8P)

function parent(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

parent_at_level

Return the parent given Morton code at a given level.

Attributes: elemental

Returns: integer(kind=I8P)

function parent_at_level(self, code, level) result(parent)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.
level	integer(kind=I4P)	in		Refinement level.

Call graph

path

Return the path codes, the list of codes from given node to root.

Attributes: pure

Returns: integer(kind=I8P)

function path(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph

siblings

Return the siblings Morton code given Morton code.

Attributes: pure

Returns: integer(kind=I8P)

function siblings(self, code)

Arguments

Name	Type	Intent	Attributes	Description
self	class(tree_object)	in		The tree.
code	integer(kind=I8P)	in		Morton code.

Call graph