deal.II version GIT relicensing-6816-g8d70a4508a 2026-09-28 16:30:01+00:00
\(\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\}}\)
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
LinearAlgebra::TpetraWrappers::PreconditionJacobi< Number, MemorySpace > Class Template Reference
TpetraWrappers | Linear algebra classes | Linear algebra classes » Matrix classes » Preconditioners and Relaxation Operators

The classical Jacobi preconditioner within Ifpack2. More...

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

Detailed Description

template<typename Number, typename MemorySpace = ::MemorySpace::Host>
class LinearAlgebra::TpetraWrappers::PreconditionJacobi< Number, MemorySpace >

The classical Jacobi preconditioner within Ifpack2.

Definition at line 348 of file trilinos_tpetra_precondition.h.

Inheritance diagram for LinearAlgebra::TpetraWrappers::PreconditionJacobi< Number, MemorySpace >:
[legend]

Classes

struct  AdditionalData
 The set of additional parameters to tune the preconditioner. More...
 

Public Member Functions

 PreconditionJacobi ()
 Constructor.
 
void initialize (const SparseMatrix< Number, MemorySpace > &A, const AdditionalData &additional_data=AdditionalData())
 Compute the preconditioner based on the given matrix and parameters.
 
void initialize (const SparseMatrix< Number, MemorySpace > &A)
 
void clear ()
 Destructor. Destroys the preconditioner, leaving an object like just after having called the constructor.
 
virtual void vmult (Vector< Number, MemorySpace > &dst, const Vector< Number, MemorySpace > &src) const
 Apply the preconditioner.
 
virtual void vmult (::Vector< Number > &dst, ::Vector< Number > &src) const
 Apply the preconditioner.
 
virtual void Tvmult (Vector< Number, MemorySpace > &dst, const Vector< Number, MemorySpace > &src) const
 Apply the transpose preconditioner.
 
virtual void Tvmult (::Vector< Number > &dst, ::Vector< Number > &src) const
 Apply the transpose preconditioner.
 
const TpetraTypes::LinearOperator< Number, MemorySpace > & trilinos_operator () const
 Access to underlying Trilinos data.
 
Teuchos::RCP< TpetraTypes::LinearOperator< Number, MemorySpace > > trilinos_rcp () const
 Access to underlying Trilinos data.
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
Partitioners
IndexSet locally_owned_domain_indices () const
 
IndexSet locally_owned_range_indices () const
 
Querying the observer pointers an object has.
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 

Static Public Member Functions

static ::ExceptionBase & ExcTrilinosIpack2PreconditionerUnsupported (std::string arg1)
 
static ::ExceptionBase & ExcNonMatchingMaps (std::string arg1)
 
static ::ExceptionBase & ExcTransposeNotSupported ()
 
static ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 

Protected Attributes

std::string preconditioner_type
 
Teuchos::RCP< TpetraTypes::LinearOperator< Number, MemorySpace > > preconditioner
 
Teuchos::ParameterList parameter_list
 The list of preconditioner parameters.
 

Private Member Functions

EnableObserverPointer functionality

Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void check_no_subscribers () const noexcept
 

Private Attributes

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 Private Attributes

static std::mutex mutex
 

Constructor & Destructor Documentation

◆ PreconditionJacobi()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
LinearAlgebra::TpetraWrappers::PreconditionJacobi< Number, MemorySpace >::PreconditionJacobi ( )

Constructor.

Member Function Documentation

◆ initialize() [1/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
void LinearAlgebra::TpetraWrappers::PreconditionJacobi< Number, MemorySpace >::initialize ( const SparseMatrix< Number, MemorySpace > &  A,
const AdditionalData &  additional_data = AdditionalData() 
)

Compute the preconditioner based on the given matrix and parameters.

Parameters
AThe matrix to base the preconditioner on.
additional_dataThe set of parameters to tune the preconditioner.

◆ initialize() [2/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
void LinearAlgebra::TpetraWrappers::PreconditionIfpackBase< Number, MemorySpace >::initialize ( const SparseMatrix< Number, MemorySpace > &  A)
inherited

Initializes the preconditioner for the matrix A based on the parameter_set.

◆ clear()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::clear ( )
inherited

Destructor. Destroys the preconditioner, leaving an object like just after having called the constructor.

◆ vmult() [1/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
virtual void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::vmult ( Vector< Number, MemorySpace > &  dst,
const Vector< Number, MemorySpace > &  src 
) const
virtualinherited

Apply the preconditioner.

Parameters
dstInput vector to apply the preconditioner to
srcResult vector

◆ vmult() [2/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
virtual void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::vmult ( ::Vector< Number > &  dst,
::Vector< Number > &  src 
) const
virtualinherited

Apply the preconditioner.

Parameters
dstInput vector to apply the preconditioner to
srcResult vector

◆ Tvmult() [1/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
virtual void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::Tvmult ( Vector< Number, MemorySpace > &  dst,
const Vector< Number, MemorySpace > &  src 
) const
virtualinherited

Apply the transpose preconditioner.

Parameters
dstInput vector to apply the preconditioner to
srcResult vector

◆ Tvmult() [2/2]

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
virtual void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::Tvmult ( ::Vector< Number > &  dst,
::Vector< Number > &  src 
) const
virtualinherited

Apply the transpose preconditioner.

◆ trilinos_operator()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
const TpetraTypes::LinearOperator< Number, MemorySpace > & LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::trilinos_operator ( ) const
inherited

Access to underlying Trilinos data.

Calling this function from an uninitialized object will cause an exception.

◆ trilinos_rcp()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
Teuchos::RCP< TpetraTypes::LinearOperator< Number, MemorySpace > > LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::trilinos_rcp ( ) const
inherited

Access to underlying Trilinos data.

Calling this function from an uninitialized object will cause an exception.

◆ locally_owned_domain_indices()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
IndexSet LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::locally_owned_domain_indices ( ) const
inherited

Return the partitioning of the domain space of this matrix, i.e., the partitioning of the vectors this matrix has to be multiplied with.

Returns
IndexSet of the domain of this preconditioner

◆ locally_owned_range_indices()

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
IndexSet LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::locally_owned_range_indices ( ) const
inherited

Return the partitioning of the range space of this matrix, i.e., the partitioning of the vectors that are result from matrix-vector products.

Returns
IndexSet of the range of this preconditioner

◆ n_subscriptions()

unsigned int EnableObserverPointer::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 318 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void EnableObserverPointer::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 335 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 200 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >
void EnableObserverPointer::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 327 of file enable_observer_pointer.h.

◆ subscribe()

void EnableObserverPointer::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
privateinherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
privateinherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 154 of file enable_observer_pointer.cc.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const
privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 58 of file enable_observer_pointer.cc.

Member Data Documentation

◆ preconditioner_type

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
std::string LinearAlgebra::TpetraWrappers::PreconditionIfpackBase< Number, MemorySpace >::preconditioner_type
protectedinherited

The set preconditioner type to be handed to Ifpack2::Factory::create()

Definition at line 285 of file trilinos_tpetra_precondition.h.

◆ preconditioner

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
Teuchos::RCP<TpetraTypes::LinearOperator<Number, MemorySpace> > LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::preconditioner
protectedinherited

This is a pointer to the preconditioner object that is used when applying the preconditioner.

Definition at line 187 of file trilinos_tpetra_precondition.h.

◆ parameter_list

template<typename Number , typename MemorySpace = ::MemorySpace::Host>
Teuchos::ParameterList LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::parameter_list
protectedinherited

The list of preconditioner parameters.

This structure is Trilinos counterpart to the AdditionalData structures in deal.II. Therefore any initialize will at some point pass this to the preconditioner. Most derived classes will handle building this list based on an AdditionalData object that exposes and defaults the most sensible parameters. But some classes will also offer full customization for experienced Trilinos users.

Definition at line 199 of file trilinos_tpetra_precondition.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter
mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 212 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 218 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 224 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info
mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 232 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex
staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 239 of file enable_observer_pointer.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8