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

Inheritance diagram for PreconditionSelector< MatrixType, VectorType >:

Public Types
typedef MatrixType::size_type	size_type

Public Member Functions
	PreconditionSelector (const std::string &preconditioning, const typename VectorType::value_type &omega=1.)

virtual	~PreconditionSelector ()

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

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

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 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
std::string	preconditioning

Private Attributes
SmartPointer< const MatrixType, PreconditionSelector< MatrixType, VectorType > >	A

const VectorType::value_type	omega

Detailed Description

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>
class PreconditionSelector< MatrixType, VectorType >

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.

Usage

The simplest use of this class is the following:

                                 // generate a @p SolverControl and
                                 // a @p VectorMemory
SolverControl control;
VectorMemory<Vector<double> > memory;
                                 // generate a solver
SolverCG<SparseMatrix<double>, Vector<double> > solver(control, memory);
                                 // generate a @p PreconditionSelector
PreconditionSelector<SparseMatrix<double>, Vector<double> >
  preconditioning("jacobi", 1.);
                                 // give a matrix whose diagonal entries
                                 // are to be used for the preconditioning.
                                 // Generally the matrix of the linear
                                 // equation system Ax=b.
preconditioning.use_matrix(A);
                                 // call the @p solve function with this
                                 // preconditioning as last argument
solver.solve(A,x,b,preconditioning);

The same example where also the SolverSelector class is used reads

                                 // generate a @p SolverControl and
                                 // a @p VectorMemory
SolverControl control;
VectorMemory<Vector<double> > memory;
                                 // generate a @p SolverSelector that
                                 // calls the @p SolverCG
SolverSelector<SparseMatrix<double>, Vector<double> >
  solver_selector("cg", control, memory);
                                 // generate a @p PreconditionSelector
PreconditionSelector<SparseMatrix<double>, Vector<double> >
  preconditioning("jacobi", 1.);
preconditioning.use_matrix(A);
solver_selector.solve(A,x,b,preconditioning);

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.

Author: Ralf Hartmann, 1999; extension for full compatibility with LinearOperator class: Jean-Paul Pelteret, 2015

Definition at line 95 of file precondition_selector.h.

Member Typedef Documentation

◆ size_type

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>

typedef MatrixType::size_type PreconditionSelector< MatrixType, VectorType >::size_type

Declare type for container size.

Definition at line 101 of file precondition_selector.h.

Constructor & Destructor Documentation

◆ PreconditionSelector()

template<typename MatrixType , typename VectorType >

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 195 of file precondition_selector.h.

◆ ~PreconditionSelector()

template<typename MatrixType , typename VectorType >

PreconditionSelector< MatrixType, VectorType >::~PreconditionSelector ( )

virtual

Destructor.

Definition at line 202 of file precondition_selector.h.

Member Function Documentation

◆ use_matrix()

template<typename MatrixType , typename VectorType >

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 210 of file precondition_selector.h.

◆ m()

template<typename MatrixType , typename VectorType >

PreconditionSelector< MatrixType, VectorType >::size_type PreconditionSelector< MatrixType, VectorType >::m ( ) const

inline

Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).

Definition at line 218 of file precondition_selector.h.

◆ n()

template<typename MatrixType , typename VectorType >

PreconditionSelector< MatrixType, VectorType >::size_type PreconditionSelector< MatrixType, VectorType >::n ( ) const

inline

Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).

Definition at line 227 of file precondition_selector.h.

◆ vmult()

template<typename MatrixType , typename VectorType >

void PreconditionSelector< MatrixType, VectorType >::vmult	(	VectorType &	dst,
		const VectorType &	src
	)		const

virtual

Precondition procedure. Calls the preconditioning that was specified in the constructor.

Definition at line 236 of file precondition_selector.h.

◆ Tvmult()

template<typename MatrixType , typename VectorType >

void PreconditionSelector< MatrixType, VectorType >::Tvmult	(	VectorType &	dst,
		const VectorType &	src
	)		const

virtual

Transpose precondition procedure. Calls the preconditioning that was specified in the constructor.

Definition at line 266 of file precondition_selector.h.

◆ get_precondition_names()

template<typename MatrixType , typename VectorType >

std::string PreconditionSelector< MatrixType, VectorType >::get_precondition_names ( )

static

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

"none"
"jacobi"
"sor"
"ssor"

Definition at line 296 of file precondition_selector.h.

Member Data Documentation

◆ preconditioning

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>

std::string PreconditionSelector< MatrixType, VectorType >::preconditioning

protected

Stores the name of the preconditioning.

Definition at line 174 of file precondition_selector.h.

◆ A

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>

SmartPointer<const MatrixType,PreconditionSelector<MatrixType,VectorType> > PreconditionSelector< MatrixType, VectorType >::A

private

Matrix that is used for the matrix-builtin preconditioning function. cf. also PreconditionUseMatrix.

Definition at line 181 of file precondition_selector.h.

◆ omega

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>

const VectorType::value_type PreconditionSelector< MatrixType, VectorType >::omega

private

Stores the damping parameter of the preconditioner.

Definition at line 186 of file precondition_selector.h.

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

deal.II/lac/precondition_selector.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>> class PreconditionSelector< MatrixType, VectorType >

Usage

Member Typedef Documentation

◆ size_type

Constructor & Destructor Documentation

◆ PreconditionSelector()

◆ ~PreconditionSelector()

Member Function Documentation

◆ use_matrix()

◆ m()

◆ n()

◆ vmult()

◆ Tvmult()

◆ get_precondition_names()

Member Data Documentation

◆ preconditioning

◆ A

◆ omega

template<typename MatrixType = SparseMatrix<double>, typename VectorType = ::Vector<double>>
class PreconditionSelector< MatrixType, VectorType >