#include <deal.II/lac/solver_selector.h>

Inheritance diagram for SolverSelector< VectorType >:

Public Types
using	vector_type = VectorType

Public Member Functions
	SolverSelector ()=default

	~SolverSelector () override

template<class Matrix , class Preconditioner >
void	solve (const Matrix &A, VectorType &x, const VectorType &b, const Preconditioner &precond) const

void	select (const std::string &name)

void	set_control (SolverControl &ctrl)

void	set_data (const typename SolverRichardson< VectorType >::AdditionalData &data)

void	set_data (const typename SolverCG< VectorType >::AdditionalData &data)

void	set_data (const typename SolverMinRes< VectorType >::AdditionalData &data)

void	set_data (const typename SolverBicgstab< VectorType >::AdditionalData &data)

void	set_data (const typename SolverGMRES< VectorType >::AdditionalData &data)

void	set_data (const typename SolverFGMRES< VectorType >::AdditionalData &data)

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

void	subscribe (const char *identifier=nullptr) const

void	unsubscribe (const char *identifier=nullptr) const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Static Public Member Functions
static std::string	get_solver_names ()

static::ExceptionBase &	ExcSolverDoesNotExist (std::string arg1)

Static Public Member Functions inherited from Subscriptor
static::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
SmartPointer< SolverControl, SolverSelector< VectorType > >	control

std::string	solver_name

Private Attributes
SolverRichardson< VectorType >::AdditionalData	richardson_data

SolverCG< VectorType >::AdditionalData	cg_data

SolverMinRes< VectorType >::AdditionalData	minres_data

SolverBicgstab< VectorType >::AdditionalData	bicgstab_data

SolverGMRES< VectorType >::AdditionalData	gmres_data

SolverFGMRES< VectorType >::AdditionalData	fgmres_data

Detailed Description

template<typename VectorType = Vector<double>>
class SolverSelector< VectorType >

Selects a solver by changing a parameter.

By calling the solve function of this SolverSelector, it selects the solve function of that Solver that was specified in the constructor of this class.

Usage

The simplest use of this class is the following:

// generate a @p SolverControl and a @p VectorMemory
SolverControl control;
VectorMemory<Vector<double> > memory;
// Line 3:
// generate a @p SolverSelector that calls the @p SolverCG
SolverSelector<Vector<double> >
  solver_selector("cg", control, memory);
// generate e.g. a @p PreconditionRelaxation
PreconditionRelaxation<SparseMatrix<double>, Vector<double> >
  preconditioning(
    A, &SparseMatrix<double>::template precondition_SSOR<double>,0.8);
// call the @p solve function with this preconditioning as last argument
solver_selector.solve(A,x,b,preconditioning);

But the full usefulness of the SolverSelector class is not clear until the presentation of the following example that assumes the user using the ParameterHandler class and having declared a "solver" entry, e.g. with

Parameter_Handler prm;
prm.declare_entry ("solver", "none",
                   Patterns::Selection(
                     SolverSelector<>::get_solver_names()));
...

Assuming that in the users parameter file there exists the line

* set solver = cg
*

then `Line 3' of the above example reads

SolverSelector<SparseMatrix<double>, Vector<double> >

solver_selector(prm.get("solver"), control, memory);

If at some time there exists a new solver "xyz" then the user does not need to change his program. Only in the implementation of the SolverSelector the calling of this solver has to be added and each user with program lines quoted above only needs to 'set solver = xyz' in his parameter file to get access to that new solver. :-)

(By the way, thanks to Wolfgang for implementing the ParameterHandler.)

Author: Ralf Hartmann, 1999

Definition at line 99 of file solver_selector.h.

Member Typedef Documentation

template<typename VectorType = Vector<double>>

using SolverSelector< VectorType >::vector_type = VectorType

An alias for the underlying vector type

Definition at line 105 of file solver_selector.h.

Constructor & Destructor Documentation

template<typename VectorType = Vector<double>>

SolverSelector< VectorType >::SolverSelector ( )

default

Constructor, filling in default values