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

Inheritance diagram for TrilinosWrappers::PreconditionSSOR:

[legend]

Classes
struct	AdditionalData

Public Types
using	size_type = ::types::global_dof_index

Public Member Functions
void	initialize (const SparseMatrix &matrix, const AdditionalData &additional_data=AdditionalData())

void	clear ()

MPI_Comm	get_mpi_communicator () const

void	transpose ()

virtual void	vmult (MPI::Vector &dst, const MPI::Vector &src) const

virtual void	vmult (::Vector< double > &dst, const ::Vector< double > &src) const

virtual void	vmult (::LinearAlgebra::distributed::Vector< double > &dst, const ::LinearAlgebra::distributed::Vector< double > &src) const

virtual void	Tvmult (MPI::Vector &dst, const MPI::Vector &src) const

virtual void	Tvmult (::Vector< double > &dst, const ::Vector< double > &src) const

virtual void	Tvmult (::LinearAlgebra::distributed::Vector< double > &dst, const ::LinearAlgebra::distributed::Vector< double > &src) const

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

Access to underlying Trilinos data
Epetra_Operator &	trilinos_operator () const

Partitioners
IndexSet	locally_owned_domain_indices () const

IndexSet	locally_owned_range_indices () const

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer 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

unsigned int	n_subscriptions () const

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

void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcNonMatchingMaps (std::string arg1)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
Teuchos::RCP< Epetra_Operator >	preconditioner

Epetra_MpiComm	communicator

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
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

Detailed Description

A wrapper class for a (pointwise) SSOR preconditioner for Trilinos matrices. This preconditioner works both in serial and in parallel, depending on the matrix it is based on.

The AdditionalData data structure allows to set preconditioner options. For the SSOR preconditioner, these options are the damping/relaxation parameter omega, a min_diagonal argument that can be used to make the preconditioner work even if the matrix contains some zero elements on the diagonal, and a parameter overlap that determines if and how much overlap there should be between the matrix partitions on the various MPI processes. The default settings are 1 for the relaxation parameter, 0 for the diagonal augmentation and 0 for the overlap.

Note that a parallel application of the SSOR preconditioner is actually a block-Jacobi preconditioner with block size equal to the local matrix size. Spoken more technically, this parallel operation is an additive Schwarz method with an SSOR approximate solve as inner solver, based on the outer parallel partitioning.

Definition at line 328 of file trilinos_precondition.h.

Member Typedef Documentation

◆ size_type

using TrilinosWrappers::PreconditionBase::size_type = ::types::global_dof_index

inherited

Declare the type for container size.

Definition at line 82 of file trilinos_precondition.h.

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Member Function Documentation

◆ initialize()

void PreconditionSSOR< MatrixType >::initialize	(	const SparseMatrix &	matrix,
		const AdditionalData &	additional_data = AdditionalData() )

Take the sparse matrix the preconditioner object should be built of, and additional flags (damping parameter, overlap in parallel computations, etc.) if there are any.

Definition at line 142 of file trilinos_precondition.cc.

◆ clear()

void TrilinosWrappers::PreconditionBase::clear ( )

inherited

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

Definition at line 39 of file trilinos_precondition.cc.

◆ get_mpi_communicator()

MPI_Comm TrilinosWrappers::PreconditionBase::get_mpi_communicator ( ) const

inherited

Return the underlying MPI communicator.

Definition at line 47 of file trilinos_precondition.cc.

◆ transpose()

void TrilinosWrappers::PreconditionBase::transpose ( )

inherited

Sets an internal flag so that all operations performed by the matrix, i.e., multiplications, are done in transposed order. However, this does not reshape the matrix to transposed form directly, so care should be taken when using this flag.

Note: Calling this function any even number of times in succession will return the object to its original state.

◆ vmult() [1/3]

virtual void TrilinosWrappers::PreconditionBase::vmult	(	MPI::Vector &	dst,
		const MPI::Vector &	src ) const

virtualinherited

Apply the preconditioner.

Reimplemented in TrilinosWrappers::PreconditionIdentity.

◆ vmult() [2/3]

virtual void TrilinosWrappers::PreconditionBase::vmult	(	::Vector< double > &	dst,
		const ::Vector< double > &	src ) const

virtualinherited

Apply the preconditioner on deal.II data structures instead of the ones provided in the Trilinos wrapper class.

Reimplemented in TrilinosWrappers::PreconditionIdentity.

◆ vmult() [3/3]

virtual void TrilinosWrappers::PreconditionBase::vmult	(	::LinearAlgebra::distributed::Vector< double > &	dst,
		const ::LinearAlgebra::distributed::Vector< double > &	src ) const

virtualinherited

Apply the preconditioner on deal.II parallel data structures instead of the ones provided in the Trilinos wrapper class.

◆ Tvmult() [1/3]

virtual void TrilinosWrappers::PreconditionBase::Tvmult	(	MPI::Vector &	dst,
		const MPI::Vector &	src ) const

virtualinherited

Apply the transpose preconditioner.

Reimplemented in TrilinosWrappers::PreconditionIdentity.

◆ Tvmult() [2/3]

virtual void TrilinosWrappers::PreconditionBase::Tvmult	(	::Vector< double > &	dst,
		const ::Vector< double > &	src ) const

virtualinherited

Apply the transpose preconditioner on deal.II data structures instead of the ones provided in the Trilinos wrapper class.

Reimplemented in TrilinosWrappers::PreconditionIdentity.

◆ Tvmult() [3/3]

virtual void TrilinosWrappers::PreconditionBase::Tvmult	(	::LinearAlgebra::distributed::Vector< double > &	dst,
		const ::LinearAlgebra::distributed::Vector< double > &	src ) const

virtualinherited

Apply the transpose preconditioner on deal.II parallel data structures instead of the ones provided in the Trilinos wrapper class.

◆ trilinos_operator()

Epetra_Operator & TrilinosWrappers::PreconditionBase::trilinos_operator ( ) const

inherited

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

Definition at line 54 of file trilinos_precondition.cc.

◆ locally_owned_domain_indices()

IndexSet TrilinosWrappers::PreconditionBase::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.

Definition at line 63 of file trilinos_precondition.cc.

◆ locally_owned_range_indices()

IndexSet TrilinosWrappers::PreconditionBase::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.

Definition at line 70 of file trilinos_precondition.cc.

◆ subscribe()

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

inherited

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

Definition at line 135 of file subscriptor.cc.

◆ unsubscribe()

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

inherited

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 155 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::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 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void Subscriptor::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 203 of file subscriptor.cc.

◆ serialize()

template<class Archive >

void Subscriptor::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 309 of file subscriptor.h.

◆ check_no_subscribers()

void Subscriptor::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 52 of file subscriptor.cc.

Member Data Documentation

◆ preconditioner

Teuchos::RCP<Epetra_Operator> TrilinosWrappers::PreconditionBase::preconditioner

protectedinherited

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

Definition at line 222 of file trilinos_precondition.h.

◆ communicator

Epetra_MpiComm TrilinosWrappers::PreconditionBase::communicator

protectedinherited

Internal communication pattern in case the matrix needs to be copied from deal.II format.

Definition at line 228 of file trilinos_precondition.h.

◆ counter

std::atomic<unsigned int> Subscriptor::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 218 of file subscriptor.h.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map

mutableprivateinherited

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

Definition at line 224 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers

mutableprivateinherited

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

Definition at line 240 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::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 248 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::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 271 of file subscriptor.h.

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

include/deal.II/lac/trilinos_precondition.h
source/lac/trilinos_precondition.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ size_type

◆ map_value_type

◆ map_iterator

Member Function Documentation

◆ initialize()

◆ clear()

◆ get_mpi_communicator()

◆ transpose()

◆ vmult() [1/3]

◆ vmult() [2/3]

◆ vmult() [3/3]

◆ Tvmult() [1/3]

◆ Tvmult() [2/3]

◆ Tvmult() [3/3]

◆ trilinos_operator()

◆ locally_owned_domain_indices()

◆ locally_owned_range_indices()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ preconditioner

◆ communicator

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex