PreconditionJacobi< MatrixType > Class Template Reference

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

Inheritance diagram for PreconditionJacobi< MatrixType >:

Public Types
using	AdditionalData = typename BaseClass::AdditionalData
using	size_type = types::global_dof_index

Public Member Functions
void	initialize (const MatrixType &A, const AdditionalData &parameters=AdditionalData())
void	clear ()
size_type	m () const
size_type	n () const
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

Protected Attributes
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > >	A
double	relaxation
unsigned int	n_iterations
std::shared_ptr< PreconditionerType >	preconditioner

Private Types
using	PreconditionerType = internal::PreconditionRelaxation::PreconditionJacobiImpl< MatrixType >
using	BaseClass = PreconditionRelaxation< MatrixType, PreconditionerType >

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator
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)
std::atomic< unsigned int >	counter
std::map< std::string, unsigned int >	counter_map
std::vector< std::atomic< bool > * >	validity_pointers
const std::type_info *	object_info
static std::mutex	mutex
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
void	check_no_subscribers () const noexcept

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);

Definition at line 1132 of file precondition.h.

---

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

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