box_parallelepiped_oct_m::box_parallelepiped_t Interface Reference

Class implementing a parallelepiped box. Currently this is restricted to a rectangular cuboid (all the faces must be rectangular) and the vectors generating the parallelepiped must be along the Cartesian axes. More...

Detailed Description

Class implementing a parallelepiped box. Currently this is restricted to a rectangular cuboid (all the faces must be rectangular) and the vectors generating the parallelepiped must be along the Cartesian axes.

Definition at line 135 of file box_parallelepiped.F90.

Inheritance diagram for box_parallelepiped_oct_m::box_parallelepiped_t:

Public Attributes
real(real64), dimension(:), allocatable, public	half_length
	half the length of the parallelepiped in each direction. More...
integer, public	n_periodic_boundaries = 0
	in how many directions the parallelepiped boundaries are periodic More...
Public Attributes inherited from box_shape_oct_m::box_shape_t
real(real64), dimension(:), allocatable, public	center
	where is the box centered More...
type(basis_vectors_t), public	axes
	Unit vectors used to define the orientation of the shape in space. More...
Public Attributes inherited from box_oct_m::box_t
integer, public	dim
	dimensions of the space the box lives in More...
real(real64), dimension(:), allocatable, public	bounding_box_l
	Half lengths of the bounding box that contains the box. Note that this box always contains the origin and is symmetrical with respect to it. More...

Private Member Functions
procedure	shape_contains_points => box_parallelepiped_shape_contains_points
procedure	get_surface_points => box_parallelepiped_shape_get_surface_points
procedure	get_surface_point_info => box_parallelepiped_shape_get_surface_point_info
procedure	write_info => box_parallelepiped_write_info
procedure	short_info => box_parallelepiped_short_info
procedure	regenerate => box_parallelepiped_regenerate
final	box_parallelepiped_finalize

Member Function/Subroutine Documentation

shape_contains_points()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::shape_contains_points

private

Definition at line 141 of file box_parallelepiped.F90.

get_surface_points()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::get_surface_points

private

Definition at line 142 of file box_parallelepiped.F90.

get_surface_point_info()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::get_surface_point_info

private

Definition at line 143 of file box_parallelepiped.F90.

write_info()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::write_info

private

Definition at line 144 of file box_parallelepiped.F90.

short_info()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::short_info

private

Definition at line 145 of file box_parallelepiped.F90.

regenerate()

procedure box_parallelepiped_oct_m::box_parallelepiped_t::regenerate

private

Definition at line 146 of file box_parallelepiped.F90.

box_parallelepiped_finalize()

final box_parallelepiped_oct_m::box_parallelepiped_t::box_parallelepiped_finalize

finalprivate

Definition at line 147 of file box_parallelepiped.F90.

Member Data Documentation

half_length

real(real64), dimension(:), allocatable, public box_parallelepiped_oct_m::box_parallelepiped_t::half_length

half the length of the parallelepiped in each direction.

Definition at line 137 of file box_parallelepiped.F90.

n_periodic_boundaries

integer, public box_parallelepiped_oct_m::box_parallelepiped_t::n_periodic_boundaries = 0

in how many directions the parallelepiped boundaries are periodic

Definition at line 139 of file box_parallelepiped.F90.

---

The documentation for this interface was generated from the following file:

• boxes/box_parallelepiped.F90