Dumux::LinearSolverParameters< LinearSolverTraits > Class Template Reference

Generates a parameter tree required for the linear solvers and precondioners of the Dune ISTL. More...

#include <dumux/linear/linearsolverparameters.hh>

Description

template<class LinearSolverTraits>
class Dumux::LinearSolverParameters< LinearSolverTraits >

Generates a parameter tree required for the linear solvers and precondioners of the Dune ISTL.

Static Public Member Functions
static Dune::ParameterTree	createParameterTree (const std::string &paramGroup="")
	Create a tree containing parameters required for the linear solvers and precondioners of the Dune ISTL. More...
static void	setDefaultParameters (Dune::ParameterTree &params, const std::string &paramGroup="")
	Set some defaults for the solver parameters. More...
static void	fillValuesForIstlKeys (Dune::ParameterTree &params, const std::string &paramGroup="")
	Iterate over all keys required by the ISTL, translate them to Dumux syntax and add values to tree. More...

Static Public Attributes
static const std::vector< std::array< std::string, 2 > >	dumuxToIstlSolverParams
	Translation table for solver parameters. More...

Member Function Documentation

createParameterTree()

template<class LinearSolverTraits >

static Dune::ParameterTree Dumux::LinearSolverParameters< LinearSolverTraits >::createParameterTree ( const std::string &  paramGroup = "" )

inlinestatic

Create a tree containing parameters required for the linear solvers and precondioners of the Dune ISTL.

fillValuesForIstlKeys()

template<class LinearSolverTraits >

static void Dumux::LinearSolverParameters< LinearSolverTraits >::fillValuesForIstlKeys ( Dune::ParameterTree &  params, const std::string &  paramGroup = ""  )

inlinestatic

Iterate over all keys required by the ISTL, translate them to Dumux syntax and add values to tree.

setDefaultParameters()

template<class LinearSolverTraits >

static void Dumux::LinearSolverParameters< LinearSolverTraits >::setDefaultParameters ( Dune::ParameterTree &  params, const std::string &  paramGroup = ""  )

inlinestatic

Set some defaults for the solver parameters.

Member Data Documentation

dumuxToIstlSolverParams

template<class LinearSolverTraits >

const std::vector< std::array< std::string, 2 > > Dumux::LinearSolverParameters< LinearSolverTraits >::dumuxToIstlSolverParams

static

Translation table for solver parameters.

Translation table for solver parameters TODO change to constexpr array of std::string_view once we require g++ >= 7.3 (bug in older versions)

---

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

• linearsolverparameters.hh