fossil_aabb_node_object

FOSSIL, Axis-Aligned Bounding Box (AABB) tree-node class definition.

This is just a container for AABB tree's nodes.

Source: src/lib/fossil_aabb_node_object.f90

Dependencies

Contents

• aabb_node_object
• add_facets
• compute_octants
• compute_vertices_nearby
• destroy
• get_aabb_facets
• initialize
• save_geometry_tecplot_ascii
• save_facets_into_file_stl
• translate
• union
• update_extents
• aabb_node_assign_aabb_node
• bmin
• bmax
• closest_point
• distance
• distance_from_facets
• do_ray_intersect
• facet_id
• has_facets
• is_allocated
• ray_intersections_number

Derived Types

aabb_node_object

FOSSIL Axis-Aligned Bounding Box (AABB) tree-node class.

Components

Name	Type	Attributes	Description
aabb	type(aabb_object)	allocatable	AABB data.

Type-Bound Procedures

Name	Attributes	Description
add_facets	pass(self)	Add facets to AABB.
bmin	pass(self)	Return AABB bmin.
bmax	pass(self)	Return AABB bmax.
closest_point	pass(self)	Return closest point on AABB from point reference.
compute_octants	pass(self)	Compute AABB octants.
compute_vertices_nearby	pass(self)	Compute vertices nearby.
destroy	pass(self)	Destroy AABB.
distance	pass(self)	Return the (square) distance from point to AABB.
distance_from_facets	pass(self)	Return the (square) distance from point to AABB's facets.
do_ray_intersect	pass(self)	Return true if AABB is intersected by ray.
facet_id	pass(self)	Return the facets IDs list.
get_aabb_facets	pass(self)	Get AABB facets list.
has_facets	pass(self)	Return true if AABB has facets.
initialize	pass(self)	Initialize AABB.
is_allocated	pass(self)	Return true is node is allocated.
ray_intersections_number	pass(self)	Return ray intersections number.
save_geometry_tecplot_ascii	pass(self)	Save AABB geometry into Tecplot ascii file.
save_facets_into_file_stl	pass(self)	Save facets into file STL.
translate	pass(self)	Translate AABB by delta.
union	pass(self)	Make AABB the union of other AABBs.
update_extents	pass(self)	Update AABB bounding box extents.
assignment(=)		Overload =.
aabb_node_assign_aabb_node	pass(lhs)	Operator =.

Subroutines

add_facets

Add facets to AABB.

@note Facets added to AABB are removed to facets list that is also returned.

Attributes: pure

subroutine add_facets(self, facet_id, facet, is_exclusive)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.
facet_id	type(list_id_object)	inout		List of facets IDs.
facet	type(facet_object)	in		Facets list.
is_exclusive	logical	in	optional	Sentinel to enable/disable exclusive addition.

Call graph

compute_octants

Return AABB octants.

Attributes: pure

subroutine compute_octants(self, octant)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
octant	type(aabb_object)	out		AABB octants.

Call graph

compute_vertices_nearby

Compute vertices nearby.

Attributes: pure

subroutine compute_vertices_nearby(self, facet, tolerance_to_be_identical, tolerance_to_be_nearby)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
facet	type(facet_object)	inout		Facets list.
tolerance_to_be_identical	real(kind=R8P)	in		Tolerance to identify identical vertices.
tolerance_to_be_nearby	real(kind=R8P)	in		Tolerance to identify nearby vertices.

Call graph

destroy

Destroy AABB.

Attributes: elemental

subroutine destroy(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.

Call graph

get_aabb_facets

Get AABB facets list.

Attributes: pure

subroutine get_aabb_facets(self, facet, aabb_facet)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
facet	type(facet_object)	in		Whole facets list.
aabb_facet	type(facet_object)	out	allocatable	AABB facets list.

Call graph

initialize

Initialize AABB.

Attributes: pure

subroutine initialize(self, facet, bmin, bmax)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.
facet	type(facet_object)	in	optional	Facets list.
bmin	type(vector_R8P)	in	optional	Minimum point of AABB.
bmax	type(vector_R8P)	in	optional	Maximum point of AABB.

Call graph

save_geometry_tecplot_ascii

Save AABB geometry into Tecplot ascii file.

subroutine save_geometry_tecplot_ascii(self, file_unit, aabb_name)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
file_unit	integer(kind=I4P)	in		File unit.
aabb_name	character(len=*)	in	optional	Name of AABB.

Call graph

save_facets_into_file_stl

Save facets into file STL.

subroutine save_facets_into_file_stl(self, facet, file_name, is_ascii)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
facet	type(facet_object)	in		Facets list.
file_name	character(len=*)	in		File name.
is_ascii	logical	in		Sentinel for file format.

Call graph

translate

Translate AABB by delta.

Attributes: elemental

subroutine translate(self, delta)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.
delta	type(vector_R8P)	in		Delta of translation.

Call graph

union

Make AABB the union of other AABBs.

Attributes: pure

subroutine union(self, node, id)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.
node	type(aabb_node_object)	in		Nodes list.
id	integer(kind=I4P)	in		Nodes ID list.

Call graph

update_extents

Update AABB bounding box extents.

Attributes: pure

subroutine update_extents(self, facet)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	inout		AABB.
facet	type(facet_object)	in		Facets list.

Call graph

aabb_node_assign_aabb_node

Operator =.

Attributes: pure

subroutine aabb_node_assign_aabb_node(lhs, rhs)

Arguments

Name	Type	Intent	Attributes	Description
lhs	class(aabb_node_object)	inout		Left hand side.
rhs	type(aabb_node_object)	in		Right hand side.

Call graph

Functions

bmin

Return AABB bmin.

Attributes: pure

Returns: type(vector_R8P)

function bmin(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.

bmax

Return AABB bmax.

Attributes: pure

Returns: type(vector_R8P)

function bmax(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.

closest_point

Return closest point on (or in) AABB from point reference.

Attributes: pure

Returns: type(vector_R8P)

function closest_point(self, point) result(closest)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.
point	type(vector_R8P)	in		Point reference.

Call graph

distance

Return the (square) distance from point to AABB.

Attributes: pure

Returns: real(kind=R8P)

function distance(self, point)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
point	type(vector_R8P)	in		Point reference.

Call graph

distance_from_facets

Return the (square) distance from point to AABB's facets.

Attributes: pure

Returns: real(kind=R8P)

function distance_from_facets(self, facet, point) result(distance)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
facet	type(facet_object)	in		Facets list.
point	type(vector_R8P)	in		Point reference.

Call graph

do_ray_intersect

Return true if AABB is intersected by ray from origin and oriented as ray direction vector.

Attributes: pure

Returns: logical

function do_ray_intersect(self, ray_origin, ray_direction) result(do_intersect)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
ray_origin	type(vector_R8P)	in		Ray origin.
ray_direction	type(vector_R8P)	in		Ray direction.

Call graph

facet_id

Return facets IDs list.

Attributes: pure

Returns: type(list_id_object)

function facet_id(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.

Call graph

has_facets

Return true if AABB has facets.

Attributes: pure

Returns: logical

function has_facets(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.

Call graph

is_allocated

Return true if node is allocated.

Attributes: pure

Returns: logical

function is_allocated(self)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB box.

Call graph

ray_intersections_number

Return ray intersections number.

Attributes: pure

Returns: integer(kind=I4P)

function ray_intersections_number(self, facet, ray_origin, ray_direction) result(intersections_number)

Arguments

Name	Type	Intent	Attributes	Description
self	class(aabb_node_object)	in		AABB.
facet	type(facet_object)	in		Facets list.
ray_origin	type(vector_R8P)	in		Ray origin.
ray_direction	type(vector_R8P)	in		Ray direction.

Call graph