Scrambler  1
Ambients Module Reference

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

+ Collaboration diagram for Ambients:

List of all members.

Data Types

type  AmbientDef
 Ambient data type. More...
type  pAmbientDef

Public Member Functions

subroutine CreateAmbient (Ambient, density, pressure)
 Creates an Ambient object.
subroutine UpdateAmbient (Ambient)
 Updates an Ambient object.
subroutine AddAmbientToList (Ambient)
subroutine DestroyAmbient (Ambient)
subroutine AmbientGridInit (Info, Ambient)
subroutine AmbientBeforeStep (Info, Ambient)
subroutine AmbientSetErrFlag (Info, Ambient)
subroutine PlaceAmbient (Info, Ambient, nOverlaps, mSs, offsets)
 Places ambients in info object.

Public Attributes

TYPE(pAmbientDefpAmbient

Detailed Description

Module that handles the placement of ambients.

Definition at line 32 of file ambients.f90.


Member Function/Subroutine Documentation

subroutine CreateAmbient ( TYPE(AmbientDef), pointer  Ambient,
REAL(KIND=qPREC), optional  density,
REAL(KIND=qPREC), optional  pressure 
)

Creates an Ambient object.

Parameters:
AmbientAmbient object

Definition at line 71 of file ambients.f90.

subroutine UpdateAmbient ( TYPE(AmbientDef), pointer  Ambient)

Updates an Ambient object.

Parameters:
AmbientAmbient object

Definition at line 86 of file ambients.f90.

subroutine AddAmbientToList ( TYPE(AmbientDef), pointer  Ambient)

Definition at line 105 of file ambients.f90.

subroutine DestroyAmbient ( TYPE(AmbientDef), pointer  Ambient)

Definition at line 115 of file ambients.f90.

subroutine AmbientGridInit ( TYPE(InfoDef)  Info,
TYPE(AmbientDef), pointer  Ambient 
)

Definition at line 131 of file ambients.f90.

subroutine AmbientBeforeStep ( TYPE(InfoDef)  Info,
TYPE(AmbientDef), pointer  Ambient 
)

Definition at line 145 of file ambients.f90.

subroutine AmbientSetErrFlag ( TYPE(InfoDef)  Info,
Type(AmbientDef), pointer  Ambient 
)

Definition at line 165 of file ambients.f90.

subroutine PlaceAmbient ( TYPE(InfoDef)  Info,
TYPE(AmbientDef), pointer  Ambient,
INTEGER  nOverlaps,
INTEGER, dimension(:,:,:), pointer  mSs,
REAL(KIND=qPREC), dimension(:,:), pointer  offsets 
)

Places ambients in info object.

Parameters:
InfoInfo object

Definition at line 173 of file ambients.f90.


Member Data Documentation

Definition at line 63 of file ambients.f90.


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