![]() |
Reference documentation for deal.II version 9.1.0-pre
|
#include <deal.II/lac/precondition_selector.h>
Public Types | |
using | size_type = typename MatrixType::size_type |
Public Member Functions | |
PreconditionSelector (const std::string &preconditioning, const typename VectorType::value_type &omega=1.) | |
virtual | ~PreconditionSelector () override |
void | use_matrix (const MatrixType &M) |
size_type | m () const |
size_type | n () const |
virtual void | vmult (VectorType &dst, const VectorType &src) const |
virtual void | Tvmult (VectorType &dst, const VectorType &src) const |
![]() | |
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_precondition_names () |
static::ExceptionBase & | ExcNoMatrixGivenToUse () |
![]() | |
static::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Protected Attributes | |
std::string | preconditioning |
Private Attributes | |
SmartPointer< const MatrixType, PreconditionSelector< MatrixType, VectorType > > | A |
const VectorType::value_type | omega |
Selects the preconditioner. The constructor of this class takes the name of the preconditioning and the damping parameter omega
of the preconditioning and the use_matrix
function takes the matrix that is used by the matrix-builtin precondition functions. Each time, the operator()
function is called, this preselected preconditioner, this matrix and this omega
is used for the preconditioning. This class is designed for being used as argument of the solve
function of a Solver
and it covers the selection of all matrix-builtin precondition functions. The selection of other preconditioners, like BlockSOR or ILU should be handled in derived classes by the user.
The simplest use of this class is the following:
The same example where also the SolverSelector
class is used reads
Now the use of the SolverSelector
in combination with the PreconditionSelector
allows the user to select both, the solver and the preconditioner, at the beginning of his program and each time the solver is started (that is several times e.g. in a nonlinear iteration) this preselected solver and preconditioner is called.
Definition at line 99 of file precondition_selector.h.
using PreconditionSelector< MatrixType, VectorType >::size_type = typename MatrixType::size_type |
Declare type for container size.
Definition at line 105 of file precondition_selector.h.
PreconditionSelector< MatrixType, VectorType >::PreconditionSelector | ( | const std::string & | preconditioning, |
const typename VectorType::value_type & | omega = 1. |
||
) |
Constructor. omega
denotes the damping parameter of the preconditioning.
Definition at line 204 of file precondition_selector.h.
|
overridevirtual |
Destructor.
Definition at line 213 of file precondition_selector.h.
void PreconditionSelector< MatrixType, VectorType >::use_matrix | ( | const MatrixType & | M | ) |
Takes the matrix that is needed for preconditionings that involves a matrix. e.g. for precondition_jacobi
, ~_sor
, ~_ssor
.
Definition at line 222 of file precondition_selector.h.
|
inline |
Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).
Definition at line 230 of file precondition_selector.h.
|
inline |
Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).
Definition at line 239 of file precondition_selector.h.
|
virtual |
Precondition procedure. Calls the preconditioning that was specified in the constructor.
Definition at line 249 of file precondition_selector.h.
|
virtual |
Transpose precondition procedure. Calls the preconditioning that was specified in the constructor.
Definition at line 280 of file precondition_selector.h.
|
static |
Get the names of all implemented preconditionings. The list of possible options includes:
Definition at line 312 of file precondition_selector.h.
|
protected |
Stores the name of the preconditioning.
Definition at line 183 of file precondition_selector.h.
|
private |
Matrix that is used for the matrix-builtin preconditioning function. cf. also PreconditionUseMatrix
.
Definition at line 191 of file precondition_selector.h.
|
private |
Stores the damping parameter of the preconditioner.
Definition at line 196 of file precondition_selector.h.