box_cylinder_oct_m::box_cylinder_t Interface Reference

Class implementing a cylinder box. The cylinder axis is always along the first direction defined by the box_shape_t basis vectors. More...

Detailed Description

Class implementing a cylinder box. The cylinder axis is always along the first direction defined by the box_shape_t basis vectors.

Definition at line 135 of file box_cylinder.F90.

Inheritance diagram for box_cylinder_oct_m::box_cylinder_t:

Public Attributes
real(real64), public	radius
	the radius of the cylinder More...
real(real64), public	half_length
	half the length of the cylinder 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_cylinder_shape_contains_points
procedure	get_surface_points => box_cylinder_shape_get_surface_points
procedure	get_surface_point_info => box_cylinder_shape_get_surface_point_info
procedure	write_info => box_cylinder_write_info
procedure	short_info => box_cylinder_short_info
final	box_cylinder_finalize

Private Attributes
logical	periodic_boundaries = .false.
	are the bases of the cylinder to be treated as periodic? More...

Member Function/Subroutine Documentation

shape_contains_points()

procedure box_cylinder_oct_m::box_cylinder_t::shape_contains_points

private

Definition at line 142 of file box_cylinder.F90.

get_surface_points()

procedure box_cylinder_oct_m::box_cylinder_t::get_surface_points

private

Definition at line 143 of file box_cylinder.F90.

get_surface_point_info()

procedure box_cylinder_oct_m::box_cylinder_t::get_surface_point_info

private

Definition at line 144 of file box_cylinder.F90.

write_info()

procedure box_cylinder_oct_m::box_cylinder_t::write_info

private

Definition at line 145 of file box_cylinder.F90.

short_info()

procedure box_cylinder_oct_m::box_cylinder_t::short_info

private

Definition at line 146 of file box_cylinder.F90.

box_cylinder_finalize()

final box_cylinder_oct_m::box_cylinder_t::box_cylinder_finalize

finalprivate

Definition at line 147 of file box_cylinder.F90.

Member Data Documentation

radius

real(real64), public box_cylinder_oct_m::box_cylinder_t::radius

the radius of the cylinder

Definition at line 137 of file box_cylinder.F90.

half_length

real(real64), public box_cylinder_oct_m::box_cylinder_t::half_length

half the length of the cylinder

Definition at line 138 of file box_cylinder.F90.

periodic_boundaries

logical box_cylinder_oct_m::box_cylinder_t::periodic_boundaries = .false.

private

are the bases of the cylinder to be treated as periodic?

Definition at line 140 of file box_cylinder.F90.

---

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

• boxes/box_cylinder.F90