GAMGSolver Class Reference

Geometric agglomerated algebraic multigrid solver. More...

Inheritance diagram for GAMGSolver:

Collaboration diagram for GAMGSolver:

Public Member Functions
	TypeName ("GAMG")
	Runtime type information. More...
	GAMGSolver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
	Construct from lduMatrix and solver controls. More...
virtual	~GAMGSolver ()
	Destructor. More...
virtual solverPerformance	solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
	Solve. 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)
virtual	~solver ()
	Destructor. More...
const word &	fieldName () const
const lduMatrix &	matrix () const
const FieldField< Field, scalar > &	interfaceBouCoeffs () const
const FieldField< Field, scalar > &	interfaceIntCoeffs () const
const lduInterfaceFieldPtrsList &	interfaces () const
virtual void	read (const dictionary &)
	Read and reset the solver parameters from the given stream. More...
scalar	normFactor (const scalarField &psi, const scalarField &source, const scalarField &Apsi, scalarField &tmpField) const
	Return the matrix norm used to normalise the residual for the. More...

Friends
class	GAMGPreconditioner

Additional Inherited Members
Static Public Member Functions inherited from lduMatrix::solver
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. 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 controls. More...
label	maxIter_
	Maximum number of iterations in the solver. More...
label	minIter_
	Minimum number of iterations in the solver. More...
scalar	tolerance_
	Final convergence tolerance. More...
scalar	relTol_
	Convergence tolerance relative to the initial. More...
Static Protected Attributes inherited from lduMatrix::solver
static const label	defaultMaxIter_ = 1000
	Default maximum number of iterations in the solver. More...

Detailed Description

Geometric agglomerated algebraic multigrid solver.

Characteristics:

• Requires positive definite, diagonally dominant matrix.
• Agglomeration algorithm: selectable and optionally cached.
• Restriction operator: summation.
• Prolongation operator: injection.
• Smoother: Gauss-Seidel.
• Coarse matrix creation: central coefficient: summation of fine grid central coefficients with the removal of intra-cluster face; off-diagonal coefficient: summation of off-diagonal faces.
• Coarse matrix scaling: performed by correction scaling, using steepest descent optimisation.
• Type of cycle: V-cycle with optional pre-smoothing.
• Coarsest-level matrix solved using PCG or PBiCGStab.

Source files

• GAMGSolver.H
• GAMGSolver.C
• GAMGSolverAgglomerateMatrix.C
• GAMGSolverInterpolate.C
• GAMGSolverScale.C
• GAMGSolverSolve.C

Definition at line 70 of file GAMGSolver.H.

Constructor & Destructor Documentation

GAMGSolver()

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

Construct from lduMatrix and solver controls.

Definition at line 45 of file GAMGSolver.C.

References GAMGAgglomeration::agglomProcIDs(), lduMatrix::diag(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, GAMGAgglomeration::hasMeshLevel(), GAMGAgglomeration::hasProcMesh(), GAMGAgglomeration::interfaceLevel(), lduMatrix::solver::interfaces(), lduMatrix::lower(), lduMatrix::solver::matrix(), GAMGAgglomeration::meshLevel(), GAMGInterface::New(), Foam::nl, Foam::Pout, GAMGAgglomeration::procAgglomMap(), GAMGAgglomeration::processorAgglomerate(), PtrList< T >::set(), UPtrList< T >::set(), UPtrList< T >::size(), GAMGAgglomeration::size(), List< T >::size(), OStringStream::str(), lduMatrix::solver::type(), and OSstream::write().

Here is the call graph for this function:

~GAMGSolver()

~GAMGSolver ( )

virtual

Destructor.

Definition at line 282 of file GAMGSolver.C.

Member Function Documentation

TypeName()

TypeName

(

"GAMG"

)

Runtime type information.

solve()

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

virtual

Solve.

Implements lduMatrix::solver.

Definition at line 33 of file GAMGSolverSolve.C.

References lduMatrix::Amul(), SolverPerformance< Type >::checkConvergence(), Foam::endl(), lduMatrix::solver::fieldName_, SolverPerformance< Type >::finalResidual(), Foam::gSumMag(), Foam::Info, SolverPerformance< Type >::initialResidual(), lduMatrix::solver::interfaceBouCoeffs_, lduMatrix::solver::interfaces_, lduMatrix::solver::matrix(), lduMatrix::solver::matrix_, lduMatrix::solver::maxIter_, lduMatrix::solver::minIter_, SolverPerformance< Type >::nIterations(), lduMatrix::solver::normFactor(), Foam::Pout, SolverPerformance< Type >::print(), psi, lduMatrix::solver::relTol_, List< T >::size(), and lduMatrix::solver::tolerance_.

Here is the call graph for this function:

Friends And Related Function Documentation

GAMGPreconditioner

friend class GAMGPreconditioner

friend

Definition at line 320 of file GAMGSolver.H.

---

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

• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.H
• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.C
• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolverAgglomerateMatrix.C
• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolverInterpolate.C
• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolverScale.C
• src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolverSolve.C