Scrambler  1
Shapes Module Reference

Module that handles the placement of shapes. More...

+ Collaboration diagram for Shapes:

List of all members.

Data Types

type  ShapeDef
 Shape data type. More...

Public Member Functions

subroutine CreateShape (Shape, type, dimensions)
subroutine UpdateShape (Shape)
subroutine SetShapeOrientation (Shape, psi, theta, phi)
subroutine SetShapeType (Shape, type, dimensions)
REAL(KIND=qPREC) function,
dimension(3) 
TransformCoordsFromShape (Shape, pos, tnow)
REAL(KIND=qPREC) function,
dimension(3) 
TransformCoordsToShape (Shape, pos, tnow)
REAL(KIND=qPREC) function,
dimension(3) 
RotateVectorFromShape (Shape, pos)
REAL(KIND=qPREC) function,
dimension(3) 
RotateVectorToShape (Shape, pos)
subroutine SetShapeBounds (Shape)
REAL(KIND=qPREC) function,
dimension(3, 2) 
GetShapeBounds (Shape, tnow)
LOGICAL function IsInShape (Shape, pos, coords, tnow)
subroutine PrintShape (shape, tnow)
subroutine GetRandomPointsInShape (shape, min_separation, boundary_separation, positions, tnow)
REAL(KIND=qPREC) function ShapeVolume (shape)

Public Attributes

INTEGER, parameter SPHERE = 1
INTEGER, parameter ELLIPSOID = 2
INTEGER, parameter CYLINDER = 3
INTEGER, parameter ELLIPTICAL_PRISM = 4
INTEGER, parameter RECTANGULAR_PRISM = 5

Detailed Description

Module that handles the placement of shapes.

Definition at line 32 of file shapes.f90.


Member Function/Subroutine Documentation

subroutine CreateShape ( TYPE(ShapeDef), pointer  Shape,
INTEGER, optional  type,
REAL(KIND=qPREC), dimension(3), optional  dimensions 
)

Definition at line 58 of file shapes.f90.

subroutine UpdateShape ( TYPE(ShapeDef), pointer  Shape)

Definition at line 69 of file shapes.f90.

subroutine SetShapeOrientation ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC)  psi,
REAL(KIND=qPREC)  theta,
REAL(KIND=qPREC)  phi 
)

Definition at line 74 of file shapes.f90.

subroutine SetShapeType ( TYPE(ShapeDef), pointer  Shape,
INTEGER  type,
REAL(KIND=qPREC), dimension(3)  dimensions 
)

Definition at line 137 of file shapes.f90.

REAL(KIND=qPREC) function, dimension(3) TransformCoordsFromShape ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC), dimension(3)  pos,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 155 of file shapes.f90.

REAL(KIND=qPREC) function, dimension(3) TransformCoordsToShape ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC), dimension(3)  pos,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 172 of file shapes.f90.

REAL(KIND=qPREC) function, dimension(3) RotateVectorFromShape ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC), dimension(3)  pos 
)

Definition at line 189 of file shapes.f90.

REAL(KIND=qPREC) function, dimension(3) RotateVectorToShape ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC), dimension(3)  pos 
)

Definition at line 198 of file shapes.f90.

subroutine SetShapeBounds ( TYPE(ShapeDef), pointer  Shape)

Definition at line 208 of file shapes.f90.

REAL(KIND=qPREC) function, dimension(3,2) GetShapeBounds ( TYPE(ShapeDef Shape,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 249 of file shapes.f90.

LOGICAL function IsInShape ( TYPE(ShapeDef), pointer  Shape,
REAL(KIND=qPREC), dimension(3)  pos,
REAL(KIND=qPREC), dimension(3)  coords,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 260 of file shapes.f90.

subroutine PrintShape ( TYPE(ShapeDef), pointer  shape,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 288 of file shapes.f90.

subroutine GetRandomPointsInShape ( TYPE(ShapeDef), pointer  shape,
REAL(KIND=qPREC)  min_separation,
REAL(KIND=qPREC)  boundary_separation,
REAL(KIND=qPREC), dimension(:,:)  positions,
REAL(KIND=qPREC), optional  tnow 
)

Definition at line 320 of file shapes.f90.

REAL(KIND=qPREC) function ShapeVolume ( TYPE(ShapeDef), pointer  shape)

Definition at line 464 of file shapes.f90.


Member Data Documentation

INTEGER, parameter SPHERE = 1

Definition at line 37 of file shapes.f90.

INTEGER, parameter ELLIPSOID = 2

Definition at line 37 of file shapes.f90.

INTEGER, parameter CYLINDER = 3

Definition at line 37 of file shapes.f90.

INTEGER, parameter ELLIPTICAL_PRISM = 4

Definition at line 37 of file shapes.f90.

INTEGER, parameter RECTANGULAR_PRISM = 5

Definition at line 37 of file shapes.f90.


The documentation for this module was generated from the following file:
 All Classes Files Functions Variables