LduMatrix< Type, DType, LUType >::smoother Class Referenceabstract

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

Inheritance diagram for LduMatrix< Type, DType, LUType >::smoother:
Collaboration diagram for LduMatrix< Type, DType, LUType >::smoother:

Public Member Functions

virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, smoother, symMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix),(fieldName, matrix))
 
 declareRunTimeSelectionTable (autoPtr, smoother, asymMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix),(fieldName, matrix))
 
 smoother (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix)
 
virtual ~smoother ()
 
const wordfieldName () const
 
const LduMatrix< Type, DType,
LUType > & 
matrix () const
 
virtual void smooth (Field< Type > &psi, const label nSweeps) const =0
 Smooth the solution for a given number of sweeps. More...
 

Static Public Member Functions

static autoPtr< smootherNew (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &smootherDict)
 Return a new smoother. More...
 

Protected Attributes

word fieldName_
 
const LduMatrix< Type, DType,
LUType > & 
matrix_
 

Detailed Description

template<class Type, class DType, class LUType>
class Foam::LduMatrix< Type, DType, LUType >::smoother

Abstract base-class for LduMatrix smoothers.

Definition at line 259 of file LduMatrix.H.

Constructor & Destructor Documentation

smoother ( const word fieldName,
const LduMatrix< Type, DType, LUType > &  matrix 
)

Definition at line 110 of file LduMatrixSmoother.C.

virtual ~smoother ( )
inlinevirtual

Definition at line 330 of file LduMatrix.H.

Member Function Documentation

virtual const word& type ( ) const
pure virtual

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
smoother  ,
symMatrix  ,
(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix ,
(fieldName, matrix  
)
declareRunTimeSelectionTable ( autoPtr  ,
smoother  ,
asymMatrix  ,
(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix ,
(fieldName, matrix  
)
Foam::autoPtr< typename Foam::LduMatrix< Type, DType, LUType >::smoother > New ( const word fieldName,
const LduMatrix< Type, DType, LUType > &  matrix,
const dictionary smootherDict 
)
static

Return a new smoother.

Definition at line 33 of file LduMatrixSmoother.C.

References LduMatrix< Type, DType, LUType >::asymmetric(), Foam::endl(), Foam::exit(), FatalIOErrorIn, dictionary::lookup(), and LduMatrix< Type, DType, LUType >::symmetric().

Here is the call graph for this function:

const word& fieldName ( ) const
inline

Definition at line 338 of file LduMatrix.H.

const LduMatrix<Type, DType, LUType>& matrix ( ) const
inline

Definition at line 343 of file LduMatrix.H.

virtual void smooth ( Field< Type > &  psi,
const label  nSweeps 
) const
pure virtual

Smooth the solution for a given number of sweeps.

Implemented in TGaussSeidelSmoother< Type, DType, LUType >.

Member Data Documentation

word fieldName_
protected
const LduMatrix<Type, DType, LUType>& matrix_
protected

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