EllipticControl Module Reference

Module for managing elliptic solves. More...

Collaboration diagram for EllipticControl:

List of all members.

Public Member Functions
Initialization routines
subroutine, public	EllipticInit
	Initializes variables needed by elliptic solvers and by control module.
Main control routines for a level
subroutine	InitialElliptic (n)
	Solves elliptic equations at simulation start on level n.
subroutine	Elliptic (n)
	Solves elliptic equations on level n.
Level operations for all elliptic equations
subroutine, public	EllipticSetup (n)
	Creates hypre grid structure for level n.
subroutine, public	EllipticSolve (n)
	Solves elliptic equations on level n.
subroutine, public	EllipticDestroy (n)
	Destroys hypre grid object for level n.
subroutine	PostElliptic (n)
	Performs any necessary grid updates post elliptic solves on level n.
Level operations for individual elliptic equations
subroutine	PreSolveComm (i, n, done_solving)
	Performs any presolve communication.
subroutine	BetweenSolveComm (i, n, done_solving)
	Performs any between solve communication in the case of sub-cycling.
subroutine	PostSolveComm (i, n)
	Performs any post solve communication.
subroutine, public	ApplyEllipticBC (n)
Public Attributes
INTEGER	isolve = 0

---

Detailed Description

Module for managing elliptic solves.

Definition at line 38 of file elliptic_control.f90.

---

Member Function/Subroutine Documentation

subroutine, public EllipticInit

(

)

Initializes variables needed by elliptic solvers and by control module.

Definition at line 57 of file elliptic_control.f90.

subroutine InitialElliptic

(

INTEGER

n

)

Solves elliptic equations at simulation start on level n.

Parameters:

n

level

Definition at line 85 of file elliptic_control.f90.

subroutine Elliptic

(

INTEGER

n

)

Solves elliptic equations on level n.

Parameters:

n

level

Definition at line 109 of file elliptic_control.f90.

subroutine, public EllipticSetup

(

INTEGER

n

)

Creates hypre grid structure for level n.

Parameters:

n

level

Definition at line 141 of file elliptic_control.f90.

subroutine, public EllipticSolve

(

INTEGER

n

)

Solves elliptic equations on level n.

Parameters:

n

level

Definition at line 202 of file elliptic_control.f90.

subroutine, public EllipticDestroy

(

INTEGER

n

)

Destroys hypre grid object for level n.

Parameters:

n

level

Definition at line 298 of file elliptic_control.f90.

subroutine PostElliptic

(

INTEGER

n

)

Performs any necessary grid updates post elliptic solves on level n.

Parameters:

n

level

Definition at line 312 of file elliptic_control.f90.

subroutine PreSolveComm	(	INTEGER	i,
		INTEGER	n,
		LOGICAL	done_solving
	)

Performs any presolve communication.

Parameters:

i	Handle for elliptic equation
n	level
done_solving	Logical flag that determins whether a solve needs to be performed

Definition at line 331 of file elliptic_control.f90.

subroutine BetweenSolveComm	(	INTEGER	i,
		INTEGER	n,
		LOGICAL	done_solving
	)

Performs any between solve communication in the case of sub-cycling.

Parameters:

i	Handle for elliptic equation
n	level
done_solving	Logical flag that determins whether a solve needs to be performed

Definition at line 344 of file elliptic_control.f90.

subroutine PostSolveComm	(	INTEGER	i,
		INTEGER	n
	)

Performs any post solve communication.

Parameters:

i	Handle for elliptic equation
n	level

Definition at line 356 of file elliptic_control.f90.

subroutine, public ApplyEllipticBC

(

INTEGER

n

)

Definition at line 367 of file elliptic_control.f90.

---

Member Data Documentation

INTEGER isolve = 0

Definition at line 49 of file elliptic_control.f90.

---

The documentation for this module was generated from the following file:

• elliptic_control.f90