Scrambler  1
Outflows Module Reference

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

+ Collaboration diagram for Outflows:

List of all members.

Data Types

type  OutflowDef
type  pOutflowDef

Public Member Functions

subroutine CreateOutflowObject (Outflow, density, temperature, velocity)
 Initializes Outflow Module.
subroutine UpdateOutflow (Outflow)
 Initializes a outflow object.
subroutine AddOutflowObjToList (Outflow)
subroutine DestroyOutflowObject (Outflow, id)
subroutine OutflowGridInit (Info, Outflow)
subroutine OutflowBeforeStep (Info, Outflow)
subroutine OutflowSetErrFlag (Info, Outflow)
subroutine OutflowBeforeGlobalStep (n)
subroutine PlaceOutflow (Info, Outflow, location)
 Place a outflow in an info object.
subroutine SourceOutflow (Info, Outflow, t, dt, location)
 Place a outflow in an info object.
subroutine OutflowLaunch (Outflow, pos, q, dq)
subroutine OutflowSource (Outflow, pos, q, dq, t, dt)
REAL(KIND=qPREC) function emf_Launch_2D (Outflow, pos)
REAL(KIND=qPREC) function emf_Launch_3D (Outflow, pos)
REAL(KIND=qPREC) function emf_source_2D (Outflow, pos, t, dt)
subroutine SetOutflowGeometry (Outflow)
 Initializes Outflow geometric variables using radius and thickness.
subroutine SetOutflowBounds (Outflow)

Public Attributes

REAL(KIND=qPREC), parameter default_buffer = 2d0
 Outflow Data Type.
TYPE(pOutflowDefpOutflow
INTEGER nOutflowObjects = 0

Private Member Functions

REAL(KIND=qPREC) function,
dimension(3), private 
emf_source_3D (Outflow, pos, t, dt)

Detailed Description

Module that handles the placement of outflows.

Definition at line 39 of file outflows.f90.


Member Function/Subroutine Documentation

subroutine CreateOutflowObject ( TYPE(OutflowDef), pointer  Outflow,
REAL(KIND=qPREC), optional  density,
REAL(KIND=qPREC), optional  temperature,
REAL(KIND=qPREC), optional  velocity 
)

Initializes Outflow Module.

Definition at line 113 of file outflows.f90.

subroutine UpdateOutflow ( TYPE(OutflowDef), pointer  Outflow)

Initializes a outflow object.

Parameters:
OutflowOutflow object

Definition at line 133 of file outflows.f90.

subroutine AddOutflowObjToList ( TYPE(OutflowDef), pointer  Outflow)

Definition at line 140 of file outflows.f90.

subroutine DestroyOutflowObject ( TYPE(OutflowDef), pointer  Outflow,
INTEGER, optional  id 
)

Definition at line 150 of file outflows.f90.

subroutine OutflowGridInit ( TYPE(InfoDef)  Info,
TYPE(OutflowDef), pointer  Outflow 
)

Definition at line 170 of file outflows.f90.

subroutine OutflowBeforeStep ( TYPE(InfoDef)  Info,
TYPE(OutflowDef), pointer  Outflow 
)

Definition at line 176 of file outflows.f90.

subroutine OutflowSetErrFlag ( TYPE(InfoDef)  Info,
TYPE(OutflowDef), pointer  Outflow 
)

Definition at line 184 of file outflows.f90.

subroutine OutflowBeforeGlobalStep ( INTEGER  n)

Definition at line 205 of file outflows.f90.

subroutine PlaceOutflow ( TYPE(InfoDef)  Info,
Type(OutflowDef Outflow,
INTEGER  location 
)

Place a outflow in an info object.

Parameters:
InfoInfo object
OutflowOutflow object

Definition at line 214 of file outflows.f90.

subroutine SourceOutflow ( TYPE(InfoDef)  Info,
Type(OutflowDef Outflow,
REAL(KIND=qPREC)  t,
REAL(KIND=qPREC)  dt,
INTEGER  location 
)

Place a outflow in an info object.

Parameters:
InfoInfo object
OutflowOutflow object

Definition at line 321 of file outflows.f90.

subroutine OutflowLaunch ( TYPE(OutflowDef Outflow,
REAL(KIND=qPrec), dimension(:)  pos,
REAL(KIND=qPrec), dimension(:)  q,
REAL(KIND=qPrec), dimension(:)  dq 
)

Definition at line 425 of file outflows.f90.

subroutine OutflowSource ( TYPE(OutflowDef Outflow,
REAL(KIND=qPrec), dimension(:)  pos,
REAL(KIND=qPrec), dimension(:)  q,
REAL(KIND=qPrec), dimension(:)  dq,
REAL(KIND=qPrec)  t,
REAL(KIND=qPrec)  dt 
)

Definition at line 552 of file outflows.f90.

REAL(KIND=qPREC) function emf_Launch_2D ( TYPE(OutflowDef Outflow,
REAL(KIND=qPREC), dimension(:)  pos 
)

Definition at line 678 of file outflows.f90.

REAL(KIND=qPREC) function emf_Launch_3D ( TYPE(OutflowDef Outflow,
REAL(KIND=qPREC), dimension(:)  pos 
)

Definition at line 687 of file outflows.f90.

REAL(KIND=qPREC) function, dimension(3), private emf_source_3D ( TYPE(OutflowDef Outflow,
REAL(KIND=qPREC), dimension(:)  pos,
REAL(KIND=qPREC)  t,
REAL(KIND=qPREC)  dt 
) [private]

Definition at line 717 of file outflows.f90.

REAL(KIND=qPREC) function emf_source_2D ( TYPE(OutflowDef Outflow,
REAL(KIND=qPREC), dimension(:)  pos,
REAL(KIND=qPREC)  t,
REAL(KIND=qPREC)  dt 
)

Definition at line 746 of file outflows.f90.

subroutine SetOutflowGeometry ( TYPE(OutflowDef Outflow)

Initializes Outflow geometric variables using radius and thickness.

Parameters:
OutflowOutflow object

Definition at line 759 of file outflows.f90.

subroutine SetOutflowBounds ( TYPE(OutflowDef Outflow)

Definition at line 784 of file outflows.f90.


Member Data Documentation

REAL(KIND=qPREC), parameter default_buffer = 2d0

Outflow Data Type.

Definition at line 51 of file outflows.f90.

Definition at line 98 of file outflows.f90.

INTEGER nOutflowObjects = 0

Definition at line 101 of file outflows.f90.


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