control Struct Reference

Collaboration diagram for control:

Public Member Functions
	control ()
	Null constructor. More...
	control (const dictionary &dict)
	Construct from dict and set the controls. More...
void	read (const dictionary &dict)
	Read dict and set the controls. More...

Public Attributes
label	nIter
	Optional maximum number of limiter iterations. More...
scalar	tol
	Optional limiter convergence tolerance. More...
Switch	globalBounds
	Optional switch to select global bounds only. More...
scalar	extremaCoeff
	Optional coefficient to relax the local boundedness constraint. More...
scalar	boundaryExtremaCoeff
	Optional coefficient to relax the local boundedness constraint. More...
scalar	smoothingCoeff
	Optional coefficient to reduce the allowed range of the solution to. More...

Detailed Description

Definition at line 66 of file MULES.H.

Constructor & Destructor Documentation

control() [1/2]

control ( )

inline

Null constructor.

Should be followed by a call to read(dict)

Definition at line 107 of file MULES.H.

control() [2/2]

control

(

const dictionary &

dict

)

Construct from dict and set the controls.

Definition at line 38 of file MULES.C.

References dict, and control::read().

Here is the call graph for this function:

Member Function Documentation

read()

void read

(

const dictionary &

dict

)

Read dict and set the controls.

Definition at line 44 of file MULES.C.

References dict, and dictionary::lookupOrDefault().

Referenced by control::control(), and twoPhaseSolver::read().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

nIter

label nIter

Optional maximum number of limiter iterations.

Defaults to 3

Definition at line 70 of file MULES.H.

Referenced by Foam::MULES::limiter().

tol

scalar tol

Optional limiter convergence tolerance.

1e-2 is usually sufficient but 1e-3 can be used for very tight convergence Defaults to 0, i.e. unused and nIter iterations are performed

Definition at line 76 of file MULES.H.

Referenced by Foam::MULES::limiter().

globalBounds

Switch globalBounds

Optional switch to select global bounds only.

rather than local and global bounds

Definition at line 80 of file MULES.H.

Referenced by Foam::MULES::limiter(), and phaseSystem::solve().

extremaCoeff

scalar extremaCoeff

Optional coefficient to relax the local boundedness constraint.

by adding extremaCoeff*local_range to the allowed range allowing the solution to approach the global bounds in case temporary smearing has caused the solution to deviate from the entire range.

A value of 0 enforces strict local boundedness, a value of 1 enforces the global bounds only. Defaults to 0

Definition at line 90 of file MULES.H.

Referenced by Foam::MULES::limiter(), and phaseSystem::solve().

boundaryExtremaCoeff

scalar boundaryExtremaCoeff

Optional coefficient to relax the local boundedness constraint.

in the cells adjacent to boundaries only Defaults to 0

Definition at line 95 of file MULES.H.

Referenced by Foam::MULES::limiter().

smoothingCoeff

scalar smoothingCoeff

Optional coefficient to reduce the allowed range of the solution to.

smoothingCoeff*local_range.

This option should only be used to improve the smoothness of the solution at low Courant number (explicit solution with sub-cycling) otherwise excessive smearing may result.

Definition at line 103 of file MULES.H.

Referenced by Foam::MULES::limiter().

---

The documentation for this struct was generated from the following files:

• src/finiteVolume/fvMatrices/solvers/MULES/MULES.H
• src/finiteVolume/fvMatrices/solvers/MULES/MULES.C