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 &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
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
virtual void	scalarSmooth (solveScalarField &psi, const solveScalarField &source, const direction cmpt, const label nSweeps) const =0

Static Public Member Functions
static word	getName (const 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)

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

Detailed Description

Definition at line 283 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
	)

Definition at line 154 of file lduMatrixSmoother.C.

~smoother()

virtual ~smoother ( )

virtualdefault

Member Function Documentation

getName()

Foam::word getName ( const dictionary &  solverControls )

static

Definition at line 36 of file lduMatrixSmoother.C.

References Foam::constant::electromagnetic::e, dictionary::lookupEntry(), and Foam::name().

Here is the call graph for this function:

type()

virtual const word& type ( ) const

pure virtual

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)	,
		(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces)
	)

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)	,
		(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces)
	)

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

Definition at line 60 of file lduMatrixSmoother.C.

References lduMatrix::asymmetric(), Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, dictionary::lookupEntry(), Foam::name(), and lduMatrix::symmetric().

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 382 of file lduMatrix.H.

References lduMatrix::smoother::fieldName_.

matrix()

const lduMatrix& matrix ( ) const

inlinenoexcept

Definition at line 387 of file lduMatrix.H.

References lduMatrix::smoother::matrix_.

interfaceBouCoeffs()

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

inlinenoexcept

Definition at line 392 of file lduMatrix.H.

References lduMatrix::smoother::interfaceBouCoeffs_.

interfaceIntCoeffs()

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

inlinenoexcept

Definition at line 397 of file lduMatrix.H.

References lduMatrix::smoother::interfaceIntCoeffs_.

interfaces()

const lduInterfaceFieldPtrsList& interfaces ( ) const

inlinenoexcept

Definition at line 402 of file lduMatrix.H.

References lduMatrix::smoother::interfaces_.

smooth()

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

pure virtual

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

scalarSmooth()

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

pure virtual

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

Member Data Documentation

fieldName_

word fieldName_

protected

Definition at line 289 of file lduMatrix.H.

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

matrix_

const lduMatrix& matrix_

protected

Definition at line 290 of file lduMatrix.H.

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

interfaceBouCoeffs_

const FieldField<Field, scalar>& interfaceBouCoeffs_

protected

Definition at line 291 of file lduMatrix.H.

Referenced by lduMatrix::smoother::interfaceBouCoeffs().

interfaceIntCoeffs_

const FieldField<Field, scalar>& interfaceIntCoeffs_

protected

Definition at line 292 of file lduMatrix.H.

Referenced by lduMatrix::smoother::interfaceIntCoeffs().

interfaces_

const lduInterfaceFieldPtrsList& interfaces_

protected

Definition at line 293 of file lduMatrix.H.

Referenced by lduMatrix::smoother::interfaces().

---

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