Loading...
Searching...
No Matches
GAMGSolver Class Reference
Numerics » Matrix manipulation and solvers » Solvers

Geometric agglomerated algebraic multigrid solver. More...

#include <GAMGSolver.H>

Inheritance diagram for GAMGSolver:
Inheritance graph
[legend]
Collaboration diagram for GAMGSolver:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("GAMG")
 Runtime type information.
 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.
virtual ~GAMGSolver ()
 Destructor.
virtual solverPerformance solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
 Solve.
Public Member Functions inherited from lduMatrix::solver
virtual const word & type () const =0
 Runtime type information.
 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.
virtual ~solver ()=default
 Destructor.
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.
virtual solverPerformance scalarSolve (solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
 Solve with given field and rhs (in solveScalar precision).
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.
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.

Friends

class GAMGPreconditioner

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.
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.
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.
int log_
 Verbosity level for solver output statements.
label minIter_
 Minimum number of iterations in the solver.
label maxIter_
 Maximum number of iterations in the solver.
lduMatrix::normTypes normType_
 The normalisation type.
scalar tolerance_
 Final convergence tolerance.
scalar relTol_
 Convergence tolerance relative to the initial.
profilingTrigger profiling_
 Profiling instrumentation.

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 any lduSolver (PCG, PBiCGStab, smoothSolver) or direct solver on master processor
Source files

Definition at line 72 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 43 of file GAMGSolver.C.

References IOstreamOption::BINARY, lduMatrix::solver::controlDict_, entry::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, lduMatrix::solver::fieldName(), forAll, lduMatrix::solver::interfaceBouCoeffs(), lduMatrix::solver::interfaceIntCoeffs(), lduMatrix::solver::interfaces(), entry::isDict(), keyType::LITERAL_RECURSIVE, lduMatrix::solver::log_, lduMatrix::solver::matrix(), lduMatrix::solver::matrix_, GAMGInterface::New(), lduMatrix::solver::New(), Foam::nl, os(), Foam::Pout, lduMatrix::solver::readControls(), Foam::refCast(), lduMatrix::solver::relTol_, ISpanStream::reset(), PtrList< T >::set(), UPtrList< T >::set(), UPtrList< T >::size(), lduMatrix::solver::solver(), lduMatrix::solver::tolerance_, and lduMatrix::solver::type().

Referenced by GAMGPreconditioner::GAMGPreconditioner().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~GAMGSolver()

~GAMGSolver ( )
virtual

Destructor.

Definition at line 339 of file GAMGSolver.C.

Member Function Documentation

◆ TypeName()

TypeName ( "GAMG" )

Runtime type information.

References lduMatrix::solver::fieldName(), lduMatrix::solver::interfaceBouCoeffs(), lduMatrix::solver::interfaceIntCoeffs(), lduMatrix::solver::interfaces(), lduMatrix::solver::matrix(), and psi.

Here is the call graph for this function:

◆ solve()

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

Solve.

Implements lduMatrix::solver.

Definition at line 30 of file GAMGSolverSolve.C.

References SolverPerformance< Type >::checkConvergence(), Foam::endl(), lduMatrix::solver::fieldName_, SolverPerformance< Type >::finalResidual(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::gSumMag(), Foam::Info, SolverPerformance< Type >::initialResidual(), lduMatrix::solver::interfaceBouCoeffs_, lduMatrix::solver::interfaces_, lduMatrix::solver::log_, lduMatrix::solver::matrix(), lduMatrix::solver::matrix_, lduMatrix::solver::maxIter_, mesh, lduMatrix::solver::minIter_, SolverPerformance< Type >::nIterations(), lduMatrix::solver::normFactor(), Foam::Pout, SolverPerformance< Type >::print(), psi, refPtr< T >::ref(), lduMatrix::solver::relTol_, lduMatrix::setResidualField(), UList< T >::size(), and lduMatrix::solver::tolerance_.

Here is the call graph for this function:

◆ GAMGPreconditioner

friend class GAMGPreconditioner
friend

Definition at line 405 of file GAMGSolver.H.

References GAMGPreconditioner.

Referenced by GAMGPreconditioner.

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