3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::SORCGBackend Class Reference

Sequential SOR-preconditioned CG solver. More...

#include <dumux/linear/seqsolverbackend.hh>

Inheritance diagram for Dumux::SORCGBackend:

Description

Sequential SOR-preconditioned CG solver.

Solver: CG (conjugate gradient) is an iterative method for solving linear systems with a symmetric, positive definite matrix.
See: Helfenstein, R., Koko, J. (2010). "Parallel preconditioned conjugate gradient algorithm on GPU", Journal of Computational and Applied Mathematics, Volume 236, Issue 15, Pages 3584–3590, http://dx.doi.org/10.1016/j.cam.2011.04.025.

Preconditioner: SOR successive overrelaxation method. The relaxation is controlled by the parameter LinearSolver.PreconditionerRelaxation. In each preconditioning step, it is applied as often as given by the parameter LinearSolver.PreconditionerIterations.
See: Golub, G. H., and Van Loan, C. F. (2012). Matrix computations. JHU Press.

Public Types

using Scalar = double
 

Public Member Functions

template<class Matrix , class Vector >
bool solve (const Matrix &A, Vector &x, const Vector &b)
 
std::string name () const
 
 LinearSolver (const std::string &paramGroup="")
 Contruct the solver. More...
 
const std::string & paramGroup () const
 the parameter group for getting parameter from the parameter tree More...
 
int verbosity () const
 the verbosity level More...
 
void setVerbosity (int v)
 set the verbosity level More...
 
int maxIter () const
 the maximum number of linear solver iterations More...
 
void setMaxIter (int i)
 set the maximum number of linear solver iterations More...
 
Scalar residReduction () const
 the linear solver residual reduction More...
 
void setResidualReduction (Scalar r)
 set the linear solver residual reduction More...
 
Scalar relaxation () const
 the linear solver relaxation factor More...
 
void setRelaxation (Scalar r)
 set the linear solver relaxation factor More...
 
int precondIter () const
 the number of preconditioner iterations More...
 
void setPrecondIter (int i)
 set the number of preconditioner iterations More...
 
int precondVerbosity () const
 the preconditioner verbosity More...
 
void setPrecondVerbosity (int verbosityLevel)
 set the preconditioner verbosity More...
 

Member Typedef Documentation

◆ Scalar

using Dumux::LinearSolver::Scalar = double
inherited

export Scalar type (might be needed to set parameters from output) TODO: Do we need this?

Member Function Documentation

◆ LinearSolver()

Dumux::LinearSolver::LinearSolver ( const std::string &  paramGroup = "")
inline

Contruct the solver.

Note
Read parameters from the parameter tree
  • LinearSolver.Verbosity the verbosity level of the linear solver
  • LinearSolver.MaxIterations the maximum iterations of the solver
  • LinearSolver.ResidualReduction the residual reduction threshold, i.e. stopping criterion
  • LinearSolver.Preconditioner.Relaxation precondition relaxation
  • LinearSolver.Preconditioner.Iterations the number of preconditioner iterations
  • LinearSolver.Preconditioner.Verbosity the preconditioner verbosity level

◆ maxIter()

int Dumux::LinearSolver::maxIter ( ) const
inlineinherited

the maximum number of linear solver iterations

◆ name()

std::string Dumux::SORCGBackend::name ( ) const
inline

◆ paramGroup()

const std::string & Dumux::LinearSolver::paramGroup ( ) const
inlineinherited

the parameter group for getting parameter from the parameter tree

◆ precondIter()

int Dumux::LinearSolver::precondIter ( ) const
inlineinherited

the number of preconditioner iterations

◆ precondVerbosity()

int Dumux::LinearSolver::precondVerbosity ( ) const
inlineinherited

the preconditioner verbosity

◆ relaxation()

Scalar Dumux::LinearSolver::relaxation ( ) const
inlineinherited

the linear solver relaxation factor

◆ residReduction()

Scalar Dumux::LinearSolver::residReduction ( ) const
inlineinherited

the linear solver residual reduction

◆ setMaxIter()

void Dumux::LinearSolver::setMaxIter ( int  i)
inlineinherited

set the maximum number of linear solver iterations

◆ setPrecondIter()

void Dumux::LinearSolver::setPrecondIter ( int  i)
inlineinherited

set the number of preconditioner iterations

◆ setPrecondVerbosity()

void Dumux::LinearSolver::setPrecondVerbosity ( int  verbosityLevel)
inlineinherited

set the preconditioner verbosity

◆ setRelaxation()

void Dumux::LinearSolver::setRelaxation ( Scalar  r)
inlineinherited

set the linear solver relaxation factor

◆ setResidualReduction()

void Dumux::LinearSolver::setResidualReduction ( Scalar  r)
inlineinherited

set the linear solver residual reduction

◆ setVerbosity()

void Dumux::LinearSolver::setVerbosity ( int  v)
inlineinherited

set the verbosity level

◆ solve()

template<class Matrix , class Vector >
bool Dumux::SORCGBackend::solve ( const Matrix &  A,
Vector &  x,
const Vector &  b 
)
inline

◆ verbosity()

int Dumux::LinearSolver::verbosity ( ) const
inlineinherited

the verbosity level


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