Reference documentation for deal.II version Git b33e53217d 2019-05-21 07:35:10 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | List of all members
SolverSelector< VectorType > Class Template Reference

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

Inheritance diagram for SolverSelector< VectorType >:
[legend]

Public Types

using vector_type = VectorType
 

Public Member Functions

 SolverSelector ()=default
 
 SolverSelector (const std::string &name, SolverControl &control)
 
virtual ~SolverSelector () override=default
 
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 ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") 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 ::ExceptionBaseExcSolverDoesNotExist (std::string arg1)
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (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 SolverSelector that calls the @p SolverCG
SolverSelector<Vector<double> > solver_selector ("cg", control);
// generate e.g. a @p PreconditionRelaxation
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",
...

Assuming that in the users parameter file there exists the line

set solver = cg

then the constructor call in the above example can be written as

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

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.

Author
Ralf Hartmann, 1999

Definition at line 91 of file solver_selector.h.

Member Typedef Documentation

◆ vector_type

template<typename VectorType = Vector<double>>
using SolverSelector< VectorType >::vector_type = VectorType

An alias for the underlying vector type

Definition at line 97 of file solver_selector.h.

Constructor & Destructor Documentation

◆ SolverSelector() [1/2]

template<typename VectorType = Vector<double>>
SolverSelector< VectorType >::SolverSelector ( )
default

Constructor, filling in default values

◆ SolverSelector() [2/2]

template<typename VectorType >
SolverSelector< VectorType >::SolverSelector ( const std::string &  name,
SolverControl control 
)

Constructor, selecting the solver name and the SolverControl object control already.

Definition at line 251 of file solver_selector.h.

◆ ~SolverSelector()

template<typename VectorType = Vector<double>>
virtual SolverSelector< VectorType >::~SolverSelector ( )
overridevirtualdefault

Destructor

Member Function Documentation

◆ solve()

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

Solver procedure. Calls the solve function of the solver whose SolverName was specified in the constructor.

Definition at line 271 of file solver_selector.h.

◆ select()

template<typename VectorType >
void SolverSelector< VectorType >::select ( const std::string &  name)

Select a new solver. Note that all solver names used in this class are all lower case.

Definition at line 261 of file solver_selector.h.

◆ set_control()

template<typename VectorType >
void SolverSelector< VectorType >::set_control ( SolverControl ctrl)

Set a new SolverControl. This needs to be set before solving.

Definition at line 314 of file solver_selector.h.

◆ set_data() [1/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 352 of file solver_selector.h.

◆ set_data() [2/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 362 of file solver_selector.h.

◆ set_data() [3/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 372 of file solver_selector.h.

◆ set_data() [4/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 382 of file solver_selector.h.

◆ set_data() [5/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 332 of file solver_selector.h.

◆ set_data() [6/6]

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

Set the additional data. For more information see the Solver class.

Definition at line 342 of file solver_selector.h.

◆ get_solver_names()

template<typename VectorType >
std::string SolverSelector< VectorType >::get_solver_names ( )
static

Get the names of all implemented solvers. The list of possible options includes:

  • "richardson"
  • "cg"
  • "bicgstab"
  • "gmres"
  • "fgmres"
  • "minres"

Definition at line 323 of file solver_selector.h.

Member Data Documentation

◆ control

template<typename VectorType = Vector<double>>
SmartPointer<SolverControl, SolverSelector<VectorType> > SolverSelector< VectorType >::control
protected

Stores the SolverControl that is needed in the constructor of each Solver class. This can be changed with set_control().

Definition at line 207 of file solver_selector.h.

◆ solver_name

template<typename VectorType = Vector<double>>
std::string SolverSelector< VectorType >::solver_name
protected

Stores the name of the solver.

Definition at line 212 of file solver_selector.h.

◆ richardson_data

template<typename VectorType = Vector<double>>
SolverRichardson<VectorType>::AdditionalData SolverSelector< VectorType >::richardson_data
private

Stores the additional data.

Definition at line 218 of file solver_selector.h.

◆ cg_data

template<typename VectorType = Vector<double>>
SolverCG<VectorType>::AdditionalData SolverSelector< VectorType >::cg_data
private

Stores the additional data.

Definition at line 223 of file solver_selector.h.

◆ minres_data

template<typename VectorType = Vector<double>>
SolverMinRes<VectorType>::AdditionalData SolverSelector< VectorType >::minres_data
private

Stores the additional data.

Definition at line 228 of file solver_selector.h.

◆ bicgstab_data

template<typename VectorType = Vector<double>>
SolverBicgstab<VectorType>::AdditionalData SolverSelector< VectorType >::bicgstab_data
private

Stores the additional data.

Definition at line 233 of file solver_selector.h.

◆ gmres_data

template<typename VectorType = Vector<double>>
SolverGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::gmres_data
private

Stores the additional data.

Definition at line 238 of file solver_selector.h.

◆ fgmres_data

template<typename VectorType = Vector<double>>
SolverFGMRES<VectorType>::AdditionalData SolverSelector< VectorType >::fgmres_data
private

Stores the additional data.

Definition at line 243 of file solver_selector.h.


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