Octopus
box_image_oct_m Module Reference

Data Types

interface  box_image_t
 Class implementing a box generated from a 2D image. More...
 

Functions/Subroutines

class(box_image_t) function, pointer box_image_constructor (center, axes, lsize, filename, periodic_dim, namespace)
 
subroutine box_image_finalize (this)
 
logical function, dimension(1:nn) box_image_shape_contains_points (this, nn, xx)
 
subroutine box_image_write_info (this, iunit, namespace)
 
character(len=box_info_len) function box_image_short_info (this, unit_length)
 

Function/Subroutine Documentation

◆ box_image_constructor()

class(box_image_t) function, pointer box_image_oct_m::box_image_constructor ( real(real64), dimension(2), intent(in)  center,
real(real64), dimension(2, 2), intent(in)  axes,
real(real64), dimension(2), intent(in)  lsize,
character(len=*), intent(in)  filename,
integer, intent(in)  periodic_dim,
type(namespace_t), intent(in)  namespace 
)
Parameters
[in]lsizeLength of the image along each basis vector. Since it might be modified here, we currently need to return the new value, as this is still needed in simul_box_t. Later this should be changed.

Definition at line 153 of file box_image.F90.

◆ box_image_finalize()

subroutine box_image_oct_m::box_image_finalize ( type(box_image_t), intent(inout)  this)

Definition at line 225 of file box_image.F90.

◆ box_image_shape_contains_points()

logical function, dimension(1:nn) box_image_oct_m::box_image_shape_contains_points ( class(box_image_t), intent(in)  this,
integer, intent(in)  nn,
real(real64), dimension(:,:), intent(in), contiguous  xx 
)

Definition at line 242 of file box_image.F90.

◆ box_image_write_info()

subroutine box_image_oct_m::box_image_write_info ( class(box_image_t), intent(in)  this,
integer, intent(in), optional  iunit,
type(namespace_t), intent(in), optional  namespace 
)

Definition at line 268 of file box_image.F90.

◆ box_image_short_info()

character(len=box_info_len) function box_image_oct_m::box_image_short_info ( class(box_image_t), intent(in)  this,
type(unit_t), intent(in)  unit_length 
)

Definition at line 283 of file box_image.F90.