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

A linear solver based on the ISTL AMG preconditioner and the ISTL BiCGSTAB solver. More...

#include <dumux/linear/amgbackend.hh>

Inheritance diagram for Dumux::AMGBiCGSTABBackend< LinearSolverTraits >:

Description

template<class LinearSolverTraits>
class Dumux::AMGBiCGSTABBackend< LinearSolverTraits >

A linear solver based on the ISTL AMG preconditioner and the ISTL BiCGSTAB solver.

Public Types

using Scalar = double
 

Public Member Functions

 AMGBiCGSTABBackend (const std::string &paramGroup="")
 Construct the backend for the sequential case only. More...
 
 AMGBiCGSTABBackend (const typename LinearSolverTraits::GridView &gridView, const typename LinearSolverTraits::DofMapper &dofMapper, const std::string &paramGroup="")
 Construct the backend for parallel or sequential runs. More...
 
void updateAfterGridAdaption (const typename LinearSolverTraits::GridView &gridView, const typename LinearSolverTraits::DofMapper &dofMapper)
 Update the solver after grid adaption. More...
 
template<class Matrix , class Vector >
bool solve (Matrix &A, Vector &x, Vector &b)
 Solve a linear system. More...
 
std::string name () const
 The name of the solver. More...
 
const Dune::InverseOperatorResult & result () const
 The result containing the convergence history. More...
 
template<class Matrix , class Vector >
bool solve (const Matrix &A, Vector &x, const Vector &b)
 Solve the linear system Ax = b. 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?

Constructor & Destructor Documentation

◆ AMGBiCGSTABBackend() [1/2]

template<class LinearSolverTraits >
Dumux::AMGBiCGSTABBackend< LinearSolverTraits >::AMGBiCGSTABBackend ( const std::string &  paramGroup = "")
inline

Construct the backend for the sequential case only.

Parameters
paramGroupthe parameter group for parameter lookup

◆ AMGBiCGSTABBackend() [2/2]

template<class LinearSolverTraits >
Dumux::AMGBiCGSTABBackend< LinearSolverTraits >::AMGBiCGSTABBackend ( const typename LinearSolverTraits::GridView &  gridView,
const typename LinearSolverTraits::DofMapper &  dofMapper,
const std::string &  paramGroup = "" 
)
inline

Construct the backend for parallel or sequential runs.

Parameters
gridViewthe grid view on which we are performing the multi-grid
dofMapperan index mapper for dof entities
paramGroupthe parameter group for parameter lookup

Member Function Documentation

◆ maxIter()

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

the maximum number of linear solver iterations

◆ name()

template<class LinearSolverTraits >
std::string Dumux::AMGBiCGSTABBackend< LinearSolverTraits >::name ( ) const
inline

The name of the solver.

◆ 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

◆ result()

template<class LinearSolverTraits >
const Dune::InverseOperatorResult & Dumux::AMGBiCGSTABBackend< LinearSolverTraits >::result ( ) const
inline

The result containing the convergence history.

◆ 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() [1/2]

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

Solve the linear system Ax = b.

Note
This has to be overloaded by the actual solver

◆ solve() [2/2]

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

Solve a linear system.

Parameters
Athe matrix
xthe seeked solution vector, containing the initial solution upon entry
bthe right hand side vector

◆ updateAfterGridAdaption()

template<class LinearSolverTraits >
void Dumux::AMGBiCGSTABBackend< LinearSolverTraits >::updateAfterGridAdaption ( const typename LinearSolverTraits::GridView &  gridView,
const typename LinearSolverTraits::DofMapper &  dofMapper 
)
inline

Update the solver after grid adaption.

Parameters
gridViewthe grid view on which we are performing the multi-grid
dofMapperan index mapper for dof entities

◆ verbosity()

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

the verbosity level


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