OpenFOAM logo
Open Source CFD Toolkit

GaussSeidel Class Reference

Inheritance diagram for GaussSeidel:

Inheritance graph
[legend]
Collaboration diagram for GaussSeidel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("GaussSeidel")
 Runtime type information.
 GaussSeidel (const word &fieldName, scalarField &psi, const lduMatrix &matrix, const scalarField &source, const FieldField< Field, scalar > &coupleBouCoeffs, const FieldField< Field, scalar > &coupleIntCoeffs, const lduCoupledInterfacePtrsList &interfaces, const direction cmpt, const label nSweeps, const scalar tolerance, const scalar relTol=0.0)
 Construct from components.
 GaussSeidel (const word &fieldName, scalarField &psi, const lduMatrix &matrix, const scalarField &source, const FieldField< Field, scalar > &coupleBouCoeffs, const FieldField< Field, scalar > &coupleIntCoeffs, const lduCoupledInterfacePtrsList &interfaces, const direction cmpt, Istream &solverData)
 Construct from matrix components and solver data stream.
lduMatrix::solverPerformance solve ()
 Solve the matrix with this solver.

Static Public Member Functions

void smooth (const word &fieldName, scalarField &psi, const lduMatrix &matrix, const scalarField &Source, const FieldField< Field, scalar > &bouCoeffs, const lduCoupledInterfacePtrsList &interfaces, const direction cmpt, const label nSweeps)
 Smooth for the given number of sweeps.
label setMaxIter (const label mIter)
 Set maximum number of iterations.

Protected Attributes

scalar tolerance_
scalar relTol_
label nSweeps_
 Number of sweeps before the evaluation of residual.

Constructor & Destructor Documentation

GaussSeidel const word fieldName,
scalarField psi,
const lduMatrix matrix,
const scalarField source,
const FieldField< Field, scalar > &  coupleBouCoeffs,
const FieldField< Field, scalar > &  coupleIntCoeffs,
const lduCoupledInterfacePtrsList interfaces,
const direction  cmpt,
const label  nSweeps,
const scalar  tolerance,
const scalar  relTol = 0.0
 

Construct from components.

GaussSeidel const word fieldName,
scalarField psi,
const lduMatrix matrix,
const scalarField source,
const FieldField< Field, scalar > &  coupleBouCoeffs,
const FieldField< Field, scalar > &  coupleIntCoeffs,
const lduCoupledInterfacePtrsList interfaces,
const direction  cmpt,
Istream solverData
 

Construct from matrix components and solver data stream.


Member Function Documentation

label setMaxIter const label  mIter  )  [inline, static]
 

Set maximum number of iterations.

Definition at line 147 of file GaussSeidel.H.

void smooth const word fieldName,
scalarField psi,
const lduMatrix matrix,
const scalarField Source,
const FieldField< Field, scalar > &  bouCoeffs,
const lduCoupledInterfacePtrsList interfaces,
const direction  cmpt,
const label  nSweeps
[static]
 

Smooth for the given number of sweeps.

lduMatrix::solverPerformance solve  )  [virtual]
 

Solve the matrix with this solver.

Implements lduMatrix::solver.

TypeName "GaussSeidel"   ) 
 

Runtime type information.


Member Data Documentation

label nSweeps_ [protected]
 

Number of sweeps before the evaluation of residual.

Definition at line 85 of file GaussSeidel.H.

scalar relTol_ [protected]
 

Definition at line 82 of file GaussSeidel.H.

scalar tolerance_ [protected]
 

Definition at line 81 of file GaussSeidel.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org