PreconditionJacobi< MatrixType > Class Template Reference

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

Inheritance diagram for PreconditionJacobi< MatrixType >:

Public Types
using	AdditionalData = typename PreconditionRelaxation< MatrixType >::AdditionalData
Public Types inherited from PreconditionRelaxation< SparseMatrix< double > >
using	size_type = typename MatrixType::size_type

Public Member Functions
template<class VectorType >
void	vmult (VectorType &, const VectorType &) const
template<class VectorType >
void	Tvmult (VectorType &, const VectorType &) const
template<class VectorType >
void	step (VectorType &x, const VectorType &rhs) const
template<class VectorType >
void	Tstep (VectorType &x, const VectorType &rhs) const
Public Member Functions inherited from PreconditionRelaxation< SparseMatrix< double > >
void	initialize (const SparseMatrix< double > &A, const AdditionalData &parameters=AdditionalData())
void	clear ()
size_type	m () const
size_type	n () 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 (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)

Additional Inherited Members
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 inherited from PreconditionRelaxation< SparseMatrix< double > >
SmartPointer< const SparseMatrix< double >, PreconditionRelaxation< SparseMatrix< double > > >	A
double	relaxation

Detailed Description

template<typename MatrixType = SparseMatrix<double>>
class PreconditionJacobi< MatrixType >

Jacobi preconditioner using matrix built-in function. The MatrixType class used is required to have a function precondition_Jacobi(VectorType&, const VectorType&, double). This class satisfies the relaxation concept.

// Declare related objects
 
SparseMatrix<double> A;
Vector<double> x;
Vector<double> b;
SolverCG<> solver(...);
 
//...initialize and build A
 
// Define and initialize preconditioner:
 
PreconditionJacobi<SparseMatrix<double> > precondition;
precondition.initialize(
  A, PreconditionJacobi<SparseMatrix<double>>::AdditionalData(.6));
 
solver.solve (A, x, b, precondition);

Author

Guido Kanschat, 2000

Definition at line 508 of file precondition.h.

---

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

• include/deal.II/lac/precondition.h