![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/lac/trilinos_tpetra_precondition.h>
Classes | |
struct | AdditionalData |
Standardized data struct to pipe additional flags to the preconditioner. More... | |
Public Member Functions | |
PreconditionBase ()=default | |
Constructor. Does not do anything. The initialize function of the derived classes will have to create the preconditioner from a given sparse matrix. | |
void | clear () |
Desctructor. 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 | Tvmult (Vector< Number, MemorySpace > &dst, const Vector< Number, MemorySpace > &src) const |
Apply the transpose preconditioner. | |
virtual void | vmult (::Vector< Number > &dst, ::Vector< Number > &src) const |
Apply the 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 |
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 & | ExcTransposeNotSupported () |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Protected Attributes | |
Teuchos::RCP< TpetraTypes::LinearOperator< Number, MemorySpace > > | preconditioner |
Teuchos::ParameterList | parameter_list |
The list of preconditioner parameters. | |
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 |
The base class for all preconditioners based on Tpetra sparse matrices.
Definition at line 56 of file trilinos_tpetra_precondition.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
|
default |
Constructor. Does not do anything. The initialize
function of the derived classes will have to create the preconditioner from a given sparse matrix.
void LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::clear | ( | ) |
Desctructor. Destroys the preconditioner, leaving an object like just after having called the constructor.
|
virtual |
Apply the preconditioner.
dst | Input vector to apply the preconditioner to |
src | Result vector |
|
virtual |
Apply the transpose preconditioner.
dst | Input vector to apply the preconditioner to |
src | Result vector |
|
virtual |
Apply the preconditioner.
dst | Input vector to apply the preconditioner to |
src | Result vector |
|
virtual |
Apply the transpose preconditioner.
const TpetraTypes::LinearOperator< Number, MemorySpace > & LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::trilinos_operator | ( | ) | const |
Access to underlying Trilinos data.
Calling this function from an uninitialized object will cause an exception.
Teuchos::RCP< TpetraTypes::LinearOperator< Number, MemorySpace > > LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::trilinos_rcp | ( | ) | const |
Access to underlying Trilinos data.
Calling this function from an uninitialized object will cause an exception.
IndexSet LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::locally_owned_domain_indices | ( | ) | const |
Return the partitioning of the domain space of this matrix, i.e., the partitioning of the vectors this matrix has to be multiplied with.
IndexSet LinearAlgebra::TpetraWrappers::PreconditionBase< Number, MemorySpace >::locally_owned_range_indices | ( | ) | const |
Return the partitioning of the range space of this matrix, i.e., the partitioning of the vectors that are result from matrix-vector products.
|
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.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
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.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.
|
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.
|
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.
Definition at line 52 of file subscriptor.cc.
|
protected |
This is a pointer to the preconditioner object that is used when applying the preconditioner.
Definition at line 191 of file trilinos_tpetra_precondition.h.
|
protected |
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 204 of file trilinos_tpetra_precondition.h.
|
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.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
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.
|
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.
|
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.