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

Inheritance diagram for lduMatrix::smoother:

[legend]

Collaboration diagram for lduMatrix::smoother:

[legend]

Public Member Functions
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

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

Static Public Member Functions
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...

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 155 of file lduMatrixSmoother.C.

◆ ~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 36 of file lduMatrixSmoother.C.

References Foam::constant::electromagnetic::e, dictionary::lookupEntry(), and 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)
	)

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

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