Public Member Functions | Static Public Member Functions | List of all members
GaussSeidelSmoother Class Reference
Numerics » Matrix manipulation and solvers » Smoothers

A lduMatrix::smoother for Gauss-Seidel. More...

Inheritance diagram for GaussSeidelSmoother:
Inheritance graph
[legend]
Collaboration diagram for GaussSeidelSmoother:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("GaussSeidel")
 Runtime type information. More...
 
 GaussSeidelSmoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Construct from components. More...
 
virtual void smooth (solveScalarField &psi, const scalarField &Source, const direction cmpt, const label nSweeps) const
 Smooth the solution for a given number of sweeps. More...
 
virtual void scalarSmooth (solveScalarField &psi, const solveScalarField &Source, const direction cmpt, const label nSweeps) const
 Smooth the solution for a given number of sweeps. More...
 
- Public Member Functions inherited from lduMatrix::smoother
virtual const word & type () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, smoother, symMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls))
 
 declareRunTimeSelectionTable (autoPtr, smoother, asymMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls))
 
 smoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
 Construct for given field name, matrix etc. More...
 
virtual ~smoother ()=default
 Destructor. More...
 
const word & fieldName () const noexcept
 
const lduMatrix & matrix () const noexcept
 
const FieldField< Field, scalar > & interfaceBouCoeffs () const noexcept
 
const FieldField< Field, scalar > & interfaceIntCoeffs () const noexcept
 
const lduInterfaceFieldPtrsList & interfaces () const noexcept
 

Static Public Member Functions

static void smooth (const word &fieldName, solveScalarField &psi, const lduMatrix &matrix, const solveScalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt, const label nSweeps)
 Smooth for the given number of sweeps. More...
 
- Static Public Member Functions inherited from lduMatrix::smoother
static word getName (const dictionary &)
 Find the smoother name (directly or from a sub-dictionary) More...
 
static autoPtr< smoother > New (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Return a new smoother. More...
 

Additional Inherited Members

- Protected Attributes inherited from lduMatrix::smoother
word fieldName_
 
const lduMatrix & matrix_
 
const FieldField< Field, scalar > & interfaceBouCoeffs_
 
const FieldField< Field, scalar > & interfaceIntCoeffs_
 
const lduInterfaceFieldPtrsList & interfaces_
 

Detailed Description

A lduMatrix::smoother for Gauss-Seidel.

Source files

Definition at line 50 of file GaussSeidelSmoother.H.

Constructor & Destructor Documentation

◆ GaussSeidelSmoother()

GaussSeidelSmoother ( const word &  fieldName,
const lduMatrix &  matrix,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const FieldField< Field, scalar > &  interfaceIntCoeffs,
const lduInterfaceFieldPtrsList &  interfaces,
const dictionary &  solverControls 
)

Construct from components.

Definition at line 42 of file GaussSeidelSmoother.C.

Member Function Documentation

◆ TypeName()

TypeName ( "GaussSeidel"  )

Runtime type information.

◆ smooth() [1/2]

void smooth ( const word &  fieldName,
solveScalarField &  psi,
const lduMatrix &  matrix,
const solveScalarField &  source,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const lduInterfaceFieldPtrsList &  interfaces,
const direction  cmpt,
const label  nSweeps 
)
static

Smooth for the given number of sweeps.

Definition at line 65 of file GaussSeidelSmoother.C.

References UList< T >::begin(), lduMatrix::diag(), lduMatrix::initMatrixInterfaces(), lduMatrix::lduAddr(), lduMatrix::lower(), lduAddressing::ownerStartAddr(), psi, Foam::fvc::sweep(), lduMatrix::updateMatrixInterfaces(), lduMatrix::upper(), lduAddressing::upperAddr(), and lduMatrix::work().

Here is the call graph for this function:

◆ smooth() [2/2]

void smooth ( solveScalarField &  psi,
const scalarField &  Source,
const direction  cmpt,
const label  nSweeps 
) const
virtual

Smooth the solution for a given number of sweeps.

Implements lduMatrix::smoother.

Definition at line 172 of file GaussSeidelSmoother.C.

References psi, and Foam::fvc::smooth().

Here is the call graph for this function:

◆ scalarSmooth()

void scalarSmooth ( solveScalarField &  psi,
const solveScalarField &  Source,
const direction  cmpt,
const label  nSweeps 
) const
virtual

Smooth the solution for a given number of sweeps.

Implements lduMatrix::smoother.

Definition at line 194 of file GaussSeidelSmoother.C.

References psi, and Foam::fvc::smooth().

Here is the call graph for this function:
The documentation for this class was generated from the following files: