Reference documentation for deal.II version 9.4.1
\(\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\}}\)
No Matches
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
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< PreconditionerTypepreconditioner

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 intcounter
std::map< std::string, unsigned intcounter_map
std::vector< std::atomic< bool > * > validity_pointers
const std::type_info * object_info
static std::mutex mutex
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBaseExcNoSubscriber (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
SolverCG<> solver(...);
//...initialize and build A
// Define and initialize preconditioner:
solver.solve (A, x, b, precondition);
Definition: vector.h:109
typename BaseClass::AdditionalData AdditionalData
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > A
Definition: precondition.h:503
void initialize(const MatrixType &A, const AdditionalData &parameters=AdditionalData())

Definition at line 1132 of file precondition.h.

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