Reference documentation for deal.II version Git 16b398077e 2020-12-04 17:16:12 -0500
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
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)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 

Static Public Member Functions

static std::string get_solver_names ()
 
static ::ExceptionBaseExcSolverDoesNotExist (std::string arg1)
 
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 their 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 their parameter file to get access to that new solver.

Definition at line 89 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 95 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 248 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 268 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 258 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 311 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 349 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 359 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 369 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 379 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 329 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 339 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 320 of file solver_selector.h.

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

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

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

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

Read or write the data of this object to or from a stream for the purpose of serialization.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.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 204 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 209 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 215 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 220 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 225 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 230 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 235 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 240 of file solver_selector.h.


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