Loading...
Searching...
No Matches
lduMatrix::smoother Class Referenceabstract

Abstract base-class for lduMatrix smoothers. More...

#include <lduMatrix.H>

Inheritance diagram for lduMatrix::smoother:
Inheritance graph
[legend]
Collaboration diagram for lduMatrix::smoother:
Collaboration graph
[legend]

Public Member Functions

virtual const word & type () const =0
 Runtime type information.
 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.
virtual ~smoother ()=default
 Destructor.
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
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.
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.

Static Public Member Functions

static word getName (const dictionary &)
 Find the smoother name (directly or from a sub-dictionary).
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.

Protected Attributes

word fieldName_
const lduMatrix & matrix_
const FieldField< Field, scalar > & interfaceBouCoeffs_
const FieldField< Field, scalar > & interfaceIntCoeffs_
const lduInterfaceFieldPtrsList & interfaces_

Detailed Description

Abstract base-class for lduMatrix smoothers.

Definition at line 409 of file lduMatrix.H.

Constructor & Destructor Documentation

◆ smoother()

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.

Definition at line 154 of file lduMatrixSmoother.C.

References fieldName(), fieldName_, interfaceBouCoeffs(), interfaceBouCoeffs_, interfaceIntCoeffs(), interfaceIntCoeffs_, interfaces(), interfaces_, lduMatrix::lduMatrix(), matrix(), and matrix_.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), and symGaussSeidelSmoother::symGaussSeidelSmoother().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~smoother()

virtual ~smoother ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getName()

Foam::word getName ( const dictionary & solverControls)
static

Find the smoother name (directly or from a sub-dictionary).

Definition at line 35 of file lduMatrixSmoother.C.

References e, keyType::LITERAL, dictionary::lookupEntry(), and Foam::name().

Here is the call graph for this function:

◆ type()

virtual const word & type ( ) const
pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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)  )

References fieldName(), interfaceBouCoeffs(), interfaceIntCoeffs(), interfaces(), lduMatrix::lduMatrix(), matrix(), and smoother().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

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)  )

References fieldName(), interfaceBouCoeffs(), interfaceIntCoeffs(), interfaces(), lduMatrix::lduMatrix(), matrix(), and smoother().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::lduMatrix::smoother > New ( const word & fieldName,
const lduMatrix & matrix,
const FieldField< Field, scalar > & interfaceBouCoeffs,
const FieldField< Field, scalar > & interfaceIntCoeffs,
const lduInterfaceFieldPtrsList & interfaces,
const dictionary & solverControls )
static

Return a new smoother.

Definition at line 59 of file lduMatrixSmoother.C.

References e, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, fieldName(), interfaceBouCoeffs(), interfaceIntCoeffs(), interfaces(), lduMatrix::lduMatrix(), keyType::LITERAL, dictionary::lookupEntry(), matrix(), Foam::name(), and dictionary::null.

Referenced by smoothSolver::solve().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fieldName()

const word & fieldName ( ) const
inlinenoexcept

Definition at line 523 of file lduMatrix.H.

References fieldName_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), New(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), smoother(), symGaussSeidelSmoother::symGaussSeidelSmoother(), DICGaussSeidelSmoother::TypeName(), DICSmoother::TypeName(), DILUGaussSeidelSmoother::TypeName(), DILUSmoother::TypeName(), FDICSmoother::TypeName(), GaussSeidelSmoother::TypeName(), nonBlockingGaussSeidelSmoother::TypeName(), and symGaussSeidelSmoother::TypeName().

Here is the caller graph for this function:

◆ matrix()

const lduMatrix & matrix ( ) const
inlinenoexcept

Definition at line 528 of file lduMatrix.H.

References lduMatrix::lduMatrix(), matrix_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), New(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), smoother(), symGaussSeidelSmoother::symGaussSeidelSmoother(), DICGaussSeidelSmoother::TypeName(), DICSmoother::TypeName(), DILUGaussSeidelSmoother::TypeName(), DILUSmoother::TypeName(), FDICSmoother::TypeName(), GaussSeidelSmoother::TypeName(), nonBlockingGaussSeidelSmoother::TypeName(), and symGaussSeidelSmoother::TypeName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interfaceBouCoeffs()

const FieldField< Field, scalar > & interfaceBouCoeffs ( ) const
inlinenoexcept

Definition at line 533 of file lduMatrix.H.

References interfaceBouCoeffs_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), New(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), smoother(), symGaussSeidelSmoother::symGaussSeidelSmoother(), DICGaussSeidelSmoother::TypeName(), DICSmoother::TypeName(), DILUGaussSeidelSmoother::TypeName(), DILUSmoother::TypeName(), FDICSmoother::TypeName(), GaussSeidelSmoother::TypeName(), nonBlockingGaussSeidelSmoother::TypeName(), and symGaussSeidelSmoother::TypeName().

Here is the caller graph for this function:

◆ interfaceIntCoeffs()

const FieldField< Field, scalar > & interfaceIntCoeffs ( ) const
inlinenoexcept

Definition at line 538 of file lduMatrix.H.

References interfaceIntCoeffs_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), New(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), smoother(), symGaussSeidelSmoother::symGaussSeidelSmoother(), DICGaussSeidelSmoother::TypeName(), DICSmoother::TypeName(), DILUGaussSeidelSmoother::TypeName(), DILUSmoother::TypeName(), FDICSmoother::TypeName(), GaussSeidelSmoother::TypeName(), nonBlockingGaussSeidelSmoother::TypeName(), and symGaussSeidelSmoother::TypeName().

Here is the caller graph for this function:

◆ interfaces()

const lduInterfaceFieldPtrsList & interfaces ( ) const
inlinenoexcept

Definition at line 543 of file lduMatrix.H.

References interfaces_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DICGaussSeidelSmoother::DICGaussSeidelSmoother(), DICSmoother::DICSmoother(), DILUGaussSeidelSmoother::DILUGaussSeidelSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), GaussSeidelSmoother::GaussSeidelSmoother(), New(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), smoother(), symGaussSeidelSmoother::symGaussSeidelSmoother(), DICGaussSeidelSmoother::TypeName(), DICSmoother::TypeName(), DILUGaussSeidelSmoother::TypeName(), DILUSmoother::TypeName(), FDICSmoother::TypeName(), GaussSeidelSmoother::TypeName(), nonBlockingGaussSeidelSmoother::TypeName(), and symGaussSeidelSmoother::TypeName().

Here is the caller graph for this function:

◆ smooth()

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

Smooth the solution for a given number of sweeps.

Implemented in DICGaussSeidelSmoother, DICSmoother, DILUGaussSeidelSmoother, DILUSmoother, FDICSmoother, GaussSeidelSmoother, nonBlockingGaussSeidelSmoother, and symGaussSeidelSmoother.

References psi.

◆ scalarSmooth()

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

Smooth the solution for a given number of sweeps.

Implemented in DICGaussSeidelSmoother, DICSmoother, DILUGaussSeidelSmoother, DILUSmoother, FDICSmoother, GaussSeidelSmoother, nonBlockingGaussSeidelSmoother, and symGaussSeidelSmoother.

References psi.

Member Data Documentation

◆ fieldName_

word fieldName_
protected

Definition at line 415 of file lduMatrix.H.

Referenced by fieldName(), GaussSeidelSmoother::scalarSmooth(), nonBlockingGaussSeidelSmoother::scalarSmooth(), symGaussSeidelSmoother::scalarSmooth(), GaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), symGaussSeidelSmoother::smooth(), and smoother().

◆ matrix_

const lduMatrix& matrix_
protected

Definition at line 416 of file lduMatrix.H.

Referenced by DICSmoother::DICSmoother(), DILUSmoother::DILUSmoother(), FDICSmoother::FDICSmoother(), matrix(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), GaussSeidelSmoother::scalarSmooth(), nonBlockingGaussSeidelSmoother::scalarSmooth(), symGaussSeidelSmoother::scalarSmooth(), DICSmoother::smooth(), DILUSmoother::smooth(), FDICSmoother::smooth(), GaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), symGaussSeidelSmoother::smooth(), and smoother().

◆ interfaceBouCoeffs_

const FieldField<Field, scalar>& interfaceBouCoeffs_
protected

Definition at line 417 of file lduMatrix.H.

Referenced by interfaceBouCoeffs(), GaussSeidelSmoother::scalarSmooth(), nonBlockingGaussSeidelSmoother::scalarSmooth(), symGaussSeidelSmoother::scalarSmooth(), DICSmoother::smooth(), DILUSmoother::smooth(), FDICSmoother::smooth(), GaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), symGaussSeidelSmoother::smooth(), and smoother().

◆ interfaceIntCoeffs_

const FieldField<Field, scalar>& interfaceIntCoeffs_
protected

Definition at line 418 of file lduMatrix.H.

Referenced by interfaceIntCoeffs(), and smoother().

◆ interfaces_

const lduInterfaceFieldPtrsList& interfaces_
protected

Definition at line 419 of file lduMatrix.H.

Referenced by interfaces(), GaussSeidelSmoother::scalarSmooth(), nonBlockingGaussSeidelSmoother::scalarSmooth(), symGaussSeidelSmoother::scalarSmooth(), DICSmoother::smooth(), DILUSmoother::smooth(), FDICSmoother::smooth(), GaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), symGaussSeidelSmoother::smooth(), and smoother().

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