Octopus
box_oct_m::box_t Type Reference

class to tell whether a point is inside or outside More...

Detailed Description

class to tell whether a point is inside or outside

The purpose of a box is to tell if something is inside or outside of it. To do that it provides a function that tells if a given list of points are inside or outside the box. Furthermore, a box might be turned inside out, i.e., in that case what is usually considered inside becomes outside and vice-versa.

Definition at line 141 of file box.F90.

Inheritance diagram for box_oct_m::box_t:
Inheritance graph

Public Attributes

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(box_contains_points), deferred contains_points
 
procedure(box_bounds), deferred bounds
 
procedure(box_write_info), deferred write_info
 
procedure(box_short_info), deferred short_info
 
procedure get_surface_points => box_get_surface_points
 
procedure get_surface_point_info => box_get_surface_point_info
 
procedure, non_overridable contains_point => box_contains_point
 
procedure, non_overridable is_inside_out => box_is_inside_out
 
procedure, non_overridable turn_inside_out => box_turn_inside_out
 

Private Attributes

logical inside_out = .false.
 if the box is inside out or not More...
 

Member Function/Subroutine Documentation

◆ contains_points()

procedure(box_contains_points), deferred box_oct_m::box_t::contains_points
private

Definition at line 149 of file box.F90.

◆ bounds()

procedure(box_bounds), deferred box_oct_m::box_t::bounds
private

Definition at line 150 of file box.F90.

◆ write_info()

procedure(box_write_info), deferred box_oct_m::box_t::write_info
private

Definition at line 151 of file box.F90.

◆ short_info()

procedure(box_short_info), deferred box_oct_m::box_t::short_info
private

Definition at line 152 of file box.F90.

◆ get_surface_points()

procedure box_oct_m::box_t::get_surface_points
private

Definition at line 153 of file box.F90.

◆ get_surface_point_info()

procedure box_oct_m::box_t::get_surface_point_info
private

Definition at line 154 of file box.F90.

◆ contains_point()

procedure, non_overridable box_oct_m::box_t::contains_point
private

Definition at line 155 of file box.F90.

◆ is_inside_out()

procedure, non_overridable box_oct_m::box_t::is_inside_out
private

Definition at line 156 of file box.F90.

◆ turn_inside_out()

procedure, non_overridable box_oct_m::box_t::turn_inside_out
private

Definition at line 157 of file box.F90.

Member Data Documentation

◆ dim

integer, public box_oct_m::box_t::dim

dimensions of the space the box lives in

Definition at line 143 of file box.F90.

◆ inside_out

logical box_oct_m::box_t::inside_out = .false.
private

if the box is inside out or not

Definition at line 144 of file box.F90.

◆ bounding_box_l

real(real64), dimension(:), allocatable, public box_oct_m::box_t::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.

Definition at line 145 of file box.F90.


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