LduMatrix::smoother Class Reference

Inheritance diagram for LduMatrix::smoother:

Collaboration diagram for LduMatrix::smoother:

Public Member Functions
virtual const word &	type () const =0
	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 ()=default
const word &	fieldName () const noexcept
const LduMatrix< Type, DType, LUType > &	matrix () const noexcept
virtual void	smooth (Field< Type > &psi, const label nSweeps) const =0

Static Public Member Functions
static autoPtr< smoother >	New (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &smootherDict)

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

Detailed Description

Definition at line 261 of file LduMatrix.H.

Constructor & Destructor Documentation

smoother()

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

Definition at line 98 of file LduMatrixSmoother.C.

~smoother()

virtual ~smoother ( )

virtualdefault

Member Function Documentation

type()

virtual const word& type ( ) const

pure virtual

declareRunTimeSelectionTable() [1/2]

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

declareRunTimeSelectionTable() [2/2]

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

New()

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

static

Definition at line 29 of file LduMatrixSmoother.C.

References LduMatrix::asymmetric(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, dictionary::get(), and LduMatrix::symmetric().

Here is the call graph for this function:

fieldName()

const word& fieldName ( ) const

inlinenoexcept

Definition at line 337 of file LduMatrix.H.

References LduMatrix::smoother::fieldName_.

matrix()

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

inlinenoexcept

Definition at line 342 of file LduMatrix.H.

References LduMatrix::smoother::matrix_.

smooth()

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

pure virtual

Implemented in TGaussSeidelSmoother< Type, DType, LUType >.

Member Data Documentation

fieldName_

word fieldName_

protected

Definition at line 267 of file LduMatrix.H.

Referenced by LduMatrix::smoother::fieldName().

matrix_

const LduMatrix<Type, DType, LUType>& matrix_

protected

Definition at line 268 of file LduMatrix.H.

Referenced by LduMatrix::smoother::matrix().

---

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

• src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H
• src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrixSmoother.C