Iterative solver for symmetric and asymmetric matrices which uses a run-time selected smoother e.g. GaussSeidel to converge the solution to the required tolerance. More...

Inheritance diagram for smoothSolver:

[legend]

Collaboration diagram for smoothSolver:

[legend]

Public Member Functions
	TypeName ("smoothSolver")
	Runtime type information. More...

	smoothSolver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
	Construct from matrix components and solver controls. More...

virtual	~smoothSolver ()=default
	Destructor. More...

virtual solverPerformance	solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
	Solve the matrix with this solver. More...

Public Member Functions inherited from lduMatrix::solver
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, solver, 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, solver, 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))

	solver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
	Construct solver for given field name, matrix etc. More...

virtual	~solver ()=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	read (const dictionary &)
	Read and reset the solver parameters from the given stream. More...

virtual solverPerformance	scalarSolve (solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
	Solve with given field and rhs (in solveScalar precision). More...

solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &tmpField, const lduMatrix::normTypes normType) const
	Return the matrix norm using the specified norm method. More...

solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &tmpField) const
	Return the matrix norm used to normalise the residual for the stopping criterion. More...

Protected Member Functions
virtual void	readControls ()
	Read the control parameters from the controlDict_. More...

Protected Attributes
label	nSweeps_
	Number of sweeps before the evaluation of residual. More...

Protected Attributes inherited from lduMatrix::solver
word	fieldName_

const lduMatrix &	matrix_

const FieldField< Field, scalar > &	interfaceBouCoeffs_

const FieldField< Field, scalar > &	interfaceIntCoeffs_

lduInterfaceFieldPtrsList	interfaces_

dictionary	controlDict_
	Dictionary of solution controls. More...

int	log_
	Verbosity level for solver output statements. More...

label	minIter_
	Minimum number of iterations in the solver. More...

label	maxIter_
	Maximum number of iterations in the solver. More...

lduMatrix::normTypes	normType_
	The normalisation type. More...

scalar	tolerance_
	Final convergence tolerance. More...

scalar	relTol_
	Convergence tolerance relative to the initial. More...

profilingTrigger	profiling_
	Profiling instrumentation. More...

Additional Inherited Members
Static Public Member Functions inherited from lduMatrix::solver
static autoPtr< solver >	New (const word &solverName, 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 solver of given type. More...

static autoPtr< solver >	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 solver given dictionary. More...

Detailed Description

Iterative solver for symmetric and asymmetric matrices which uses a run-time selected smoother e.g. GaussSeidel to converge the solution to the required tolerance.

To improve efficiency, the residual is evaluated after every nSweeps smoothing iterations.

Source files

Definition at line 55 of file smoothSolver.H.

Constructor & Destructor Documentation

◆ smoothSolver()

smoothSolver	(	const word &	fieldName,
		const lduMatrix &	matrix,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const FieldField< Field, scalar > &	interfaceIntCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const dictionary &	solverControls
	)

Construct from matrix components and solver controls.

Definition at line 43 of file smoothSolver.C.

◆ ~smoothSolver()

virtual ~smoothSolver ( )

virtualdefault

Destructor.

Member Function Documentation

◆ readControls()

void readControls ( )

protectedvirtual

Read the control parameters from the controlDict_.

Reimplemented from lduMatrix::solver.

Definition at line 68 of file smoothSolver.C.

References lduMatrix::solver::controlDict_, dictionary::getOrDefault(), smoothSolver::nSweeps_, and lduMatrix::solver::readControls().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "smoothSolver" )

Runtime type information.

◆ solve()

Foam::solverPerformance solve	(	scalarField &	psi,
		const scalarField &	source,
		const direction	cmpt = `0`
	)		const

virtual

Solve the matrix with this solver.

Implements lduMatrix::solver.

Definition at line 76 of file smoothSolver.C.

References addProfiling, SolverPerformance< Type >::checkConvergence(), Foam::ensightOutput::debug, Foam::endl(), SolverPerformance< Type >::finalResidual(), Foam::gSumMag(), Foam::Info, SolverPerformance< Type >::initialResidual(), messageStream::masterStream(), mesh, lduMatrix::smoother::New(), SolverPerformance< Type >::nIterations(), psi, refPtr< Container< Type > >::ref(), lduMatrix::setResidualField(), UList< T >::size(), lduMatrix::smoother::smooth(), and Foam::solve().

Here is the call graph for this function:

Member Data Documentation

◆ nSweeps_

label nSweeps_

protected

Number of sweeps before the evaluation of residual.

Definition at line 66 of file smoothSolver.H.

Referenced by smoothSolver::readControls().

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

src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.H
src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members