Scrambler  1
EllipticDeclarations Module Reference

Module containing variables used by elliptic solvers. More...

+ Collaboration diagram for EllipticDeclarations:

List of all members.

Data Types

type  EllipticLevelObjectDef
 Stores handles to Hypre entities associated with a given level. More...
type  EllipticObjectDef
 Stores handles to Hypre entities associated with a particular equation. More...

Public Member Functions

subroutine AddElliptic (i, str)
 Adds an elliptic field and assigns it to slot i.
CHARACTER(LEN=MAXELLIPTICLENGTH)
function 
EllipticName (i)
 Returns a string containing the name of the elliptic.
subroutine CheckErr (errString, iErr)
 Checks the error code returned by hypre calls.
subroutine CheckIters (n, m)

Public Attributes

TYPE(EllipticObjectDef),
dimension(:), pointer 
EllipticObjects
INTEGER, parameter, public StructInterface = 1
INTEGER, parameter, public SStructInterface = 2
INTEGER, parameter, public StructPCG = 1
INTEGER, parameter, public StructGMRES = 2
INTEGER NrEllipticObjects
INTEGER iPoissonSolve
LOGICAL lPoissonSolve
REAL(KIND=qPREC), dimension(:),
allocatable 
elliptic_maxspeed
INTEGER nEllipticLo
INTEGER nEllipticHi
INTEGER NrEllipticVars = 0
INTEGER, parameter MAXELLIPTICLENGTH = 20
INTEGER, parameter MAXELLIPTICVARS = 40
CHARACTER(LEN=MAXELLIPTICLENGTH),
dimension(0:maxellipticvars) 
EllipticNames

Detailed Description

Module containing variables used by elliptic solvers.

Definition at line 32 of file elliptic_declarations.f90.


Member Function/Subroutine Documentation

subroutine AddElliptic ( INTEGER  i,
CHARACTER(LEN=*), optional  str 
)

Adds an elliptic field and assigns it to slot i.

Parameters:
iinteger to assign next slot
stroptional string to define variable

Definition at line 89 of file elliptic_declarations.f90.

CHARACTER(LEN=MAXELLIPTICLENGTH) function EllipticName ( INTEGER  i)

Returns a string containing the name of the elliptic.

Parameters:
iindex of elliptic

Definition at line 109 of file elliptic_declarations.f90.

subroutine CheckErr ( CHARACTER(*)  errString,
INTEGER  iErr 
)

Checks the error code returned by hypre calls.

Parameters:
errStringstring passed in by calling routine
iErrerror to check returned by hypre

Definition at line 124 of file elliptic_declarations.f90.

subroutine CheckIters ( INTEGER  n,
INTEGER  m 
)

Definition at line 141 of file elliptic_declarations.f90.


Member Data Documentation

TYPE(EllipticObjectDef), dimension(:), pointer EllipticObjects

Definition at line 64 of file elliptic_declarations.f90.

INTEGER, parameter, public StructInterface = 1

Definition at line 66 of file elliptic_declarations.f90.

INTEGER, parameter, public SStructInterface = 2

Definition at line 66 of file elliptic_declarations.f90.

INTEGER, parameter, public StructPCG = 1

Definition at line 67 of file elliptic_declarations.f90.

INTEGER, parameter, public StructGMRES = 2

Definition at line 67 of file elliptic_declarations.f90.

Definition at line 69 of file elliptic_declarations.f90.

INTEGER iPoissonSolve

Definition at line 69 of file elliptic_declarations.f90.

LOGICAL lPoissonSolve

Definition at line 71 of file elliptic_declarations.f90.

REAL(KIND=qPREC), dimension(:), allocatable elliptic_maxspeed

Definition at line 72 of file elliptic_declarations.f90.

INTEGER nEllipticLo

Definition at line 74 of file elliptic_declarations.f90.

INTEGER nEllipticHi

Definition at line 74 of file elliptic_declarations.f90.

INTEGER NrEllipticVars = 0

Definition at line 75 of file elliptic_declarations.f90.

INTEGER, parameter MAXELLIPTICLENGTH = 20

Definition at line 77 of file elliptic_declarations.f90.

INTEGER, parameter MAXELLIPTICVARS = 40

Definition at line 78 of file elliptic_declarations.f90.

CHARACTER(LEN = MAXELLIPTICLENGTH), dimension(0:maxellipticvars) EllipticNames

Definition at line 80 of file elliptic_declarations.f90.


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