DICGaussSeidelSmoother Class Reference

Combined DIC/GaussSeidel smoother for symmetric matrices in which DIC smoothing is followed by GaussSeidel to ensure that any "spikes" created by the DIC sweeps are smoothed-out. More...

Inheritance diagram for DICGaussSeidelSmoother:
[legend]
Collaboration diagram for DICGaussSeidelSmoother:
[legend]

Public Member Functions

 TypeName ("DICGaussSeidel")
 Runtime type information. More...
 
 DICGaussSeidelSmoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
 Construct from matrix 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 wordtype () 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),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces))
 
 declareRunTimeSelectionTable (autoPtr, smoother, asymMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces))
 
 smoother (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces)
 
virtual ~smoother ()=default
 Destructor. More...
 
const wordfieldName () const noexcept
 
const lduMatrixmatrix () const noexcept
 
const FieldField< Field, scalar > & interfaceBouCoeffs () const noexcept
 
const FieldField< Field, scalar > & interfaceIntCoeffs () const noexcept
 
const lduInterfaceFieldPtrsListinterfaces () const noexcept
 
virtual void smooth (solveScalarField &psi, const scalarField &source, const direction cmpt, const label nSweeps) const =0
 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 =0
 Smooth the solution for a given number of sweeps. More...
 

Additional Inherited Members

- 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< smootherNew (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...
 
- Protected Attributes inherited from lduMatrix::smoother
word fieldName_
 
const lduMatrixmatrix_
 
const FieldField< Field, scalar > & interfaceBouCoeffs_
 
const FieldField< Field, scalar > & interfaceIntCoeffs_
 
const lduInterfaceFieldPtrsListinterfaces_
 

Detailed Description

Combined DIC/GaussSeidel smoother for symmetric matrices in which DIC smoothing is followed by GaussSeidel to ensure that any "spikes" created by the DIC sweeps are smoothed-out.

Source files

Definition at line 57 of file DICGaussSeidelSmoother.H.

Constructor & Destructor Documentation

◆ DICGaussSeidelSmoother()

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

Construct from matrix components.

Definition at line 44 of file DICGaussSeidelSmoother.C.

Member Function Documentation

◆ TypeName()

TypeName ( "DICGaussSeidel"  )

Runtime type information.

◆ smooth()

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 82 of file DICGaussSeidelSmoother.C.

References psi.

◆ 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 95 of file DICGaussSeidelSmoother.C.

References psi.


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