box_oct_m Module Reference

Data Types
interface	box_bounds
	Box bounds along some axes. More...
interface	box_contains_points
	Given a list of points, this function should return an array indicating for each point if it is inside the box or not. More...
type	box_iterator_t
type	box_list_t
	These classes extends the list and list iterator to create a box list. More...
interface	box_short_info
	Return a string containing a short description of the box. More...
type	box_t
	class to tell whether a point is inside or outside More...
interface	box_write_info
	Write the complete information about the box to a file. More...

Functions/Subroutines
subroutine	box_turn_inside_out (this)
	Turn a box inside out. More...
logical function	box_is_inside_out (this)
	Is the box inside out? More...
recursive logical function	box_contains_point (this, xx)
	Convenience function to check if a single point is inside the box when that point is passed as a rank-one array. More...
logical function, dimension(1:nn)	box_get_surface_points (this, namespace, mesh_spacing, nn, xx, number_of_layers)
subroutine	box_get_surface_point_info (this, point_coordinates, mesh_spacing, normal_vector, surface_element)
subroutine	box_list_add_node (this, box)
class(box_t) function, pointer	box_iterator_get_next (this)

Variables
integer, parameter, public	box_info_len =200
real(real64), parameter, public	box_boundary_delta = 1e-12_real64

Function/Subroutine Documentation

box_turn_inside_out()

subroutine box_oct_m::box_turn_inside_out ( class(box_t), intent(inout)  this )

private

Turn a box inside out.

Definition at line 223 of file box.F90.

box_is_inside_out()

logical function box_oct_m::box_is_inside_out ( class(box_t), intent(in)  this )

private

Is the box inside out?

Definition at line 232 of file box.F90.

box_contains_point()

recursive logical function box_oct_m::box_contains_point ( class(box_t), intent(in)  this, real(real64), dimension(1:this%dim), intent(in), target  xx  )

private

Convenience function to check if a single point is inside the box when that point is passed as a rank-one array.

Definition at line 242 of file box.F90.

box_get_surface_points()

logical function, dimension(1:nn) box_oct_m::box_get_surface_points ( class(box_t), intent(in)  this, type(namespace_t), intent(in)  namespace, real(real64), dimension(:), intent(in)  mesh_spacing, integer, intent(in)  nn, real(real64), dimension(:,:), intent(in)  xx, integer, intent(in), optional  number_of_layers  )

private

Definition at line 256 of file box.F90.

box_get_surface_point_info()

subroutine box_oct_m::box_get_surface_point_info ( class(box_t), intent(in)  this, real(real64), dimension(:), intent(in)  point_coordinates, real(real64), dimension(:), intent(in)  mesh_spacing, real(real64), dimension(:), intent(out)  normal_vector, real(real64), intent(out)  surface_element  )

private

Parameters

[in]	point_coordinates	(x,y,z) coordinates of the point
[in]	mesh_spacing	spacing of the mesh
[out]	normal_vector	normal vector to the surface point
[out]	surface_element	surface element (needed to compute the surface integral)

Definition at line 271 of file box.F90.

box_list_add_node()

subroutine box_oct_m::box_list_add_node ( class(box_list_t)  this, class(box_t), target  box  )

private

Definition at line 286 of file box.F90.

box_iterator_get_next()

class(box_t) function, pointer box_oct_m::box_iterator_get_next ( class(box_iterator_t), intent(inout)  this )

private

Definition at line 300 of file box.F90.

Variable Documentation

box_info_len

integer, parameter, public box_oct_m::box_info_len =200

Definition at line 131 of file box.F90.

box_boundary_delta

real(real64), parameter, public box_oct_m::box_boundary_delta = 1e-12_real64

Definition at line 132 of file box.F90.