Reference documentation for deal.II version Git 3f1f337db3 20211023 13:19:02 0600

#include <deal.II/lac/trilinos_precondition.h>
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 
std::shared_ptr< Epetra_Map >  vector_distributor 
A wrapper class for a thresholded incomplete LU factorization (ILUT) preconditioner for Trilinos matrices. This preconditioner works both in serial and in parallel, depending on the matrix it is based on. In general, an incomplete factorization does not take all fillin elements that would appear in a full factorization (that is the basis for a direct solve). For the ILUT preconditioner, the parameter ilut_drop
lets the user specify which elements should be dropped (i.e., should not be part of the incomplete decomposition). Trilinos calculates first the complete factorization for one row, and then skips those elements that are lower than the threshold. This is the main difference to the non thresholded ILU preconditioner, where the parameter ilut_fill
governs the incomplete factorization structure. This parameter is available here as well, but provides only some extra information here.
The AdditionalData data structure allows to set preconditioner options. Besides the fillin arguments, these options are some options for perturbations (see the documentation of the AdditionalData structure for details), 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 0 for the additional fillin, 0 for the absolute augmentation tolerance, 1 for the relative augmentation tolerance, 0 for the overlap.
Note that a parallel application of the ILUT preconditioner is actually a blockJacobi preconditioner with block size equal to the local matrix size. Spoken more technically, this parallel operation is an additive Schwarz method with an ILU approximate solve as inner solver, based on the (outer) parallel partitioning.
Definition at line 1079 of file trilinos_precondition.h.

inherited 
Declare the type for container size.
Definition at line 82 of file trilinos_precondition.h.
void TrilinosWrappers::PreconditionILUT::initialize  (  const SparseMatrix &  matrix, 
const AdditionalData &  additional_data = AdditionalData() 

) 
Initialize function. Takes the matrix which is used to form the preconditioner, and additional flags if there are any.
Definition at line 568 of file trilinos_precondition.cc.

inherited 
Destroys the preconditioner, leaving an object like just after having called the constructor.
Definition at line 50 of file trilinos_precondition.cc.

inherited 
Return the MPI communicator object in use with this matrix.
Definition at line 59 of file trilinos_precondition.cc.

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.

virtualinherited 
Apply the preconditioner.
Reimplemented in TrilinosWrappers::PreconditionIdentity.

virtualinherited 
Apply the preconditioner on deal.II data structures instead of the ones provided in the Trilinos wrapper class.
Reimplemented in TrilinosWrappers::PreconditionIdentity.

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

virtualinherited 
Apply the transpose preconditioner.
Reimplemented in TrilinosWrappers::PreconditionIdentity.

virtualinherited 
Apply the transpose preconditioner on deal.II data structures instead of the ones provided in the Trilinos wrapper class.
Reimplemented in TrilinosWrappers::PreconditionIdentity.

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

inherited 
Calling this function from an uninitialized object will cause an exception.
Definition at line 66 of file trilinos_precondition.cc.

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 75 of file trilinos_precondition.cc.

inherited 
Return the partitioning of the range space of this matrix, i.e., the partitioning of the vectors that are result from matrixvector products.
Definition at line 82 of file trilinos_precondition.cc.

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 136 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 156 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 301 of file subscriptor.h.

inlineinherited 
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.

inherited 
List the subscribers to deallog
.
Definition at line 204 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 310 of file subscriptor.h.

protectedinherited 
This is a pointer to the preconditioner object that is used when applying the preconditioner.
Definition at line 232 of file trilinos_precondition.h.

protectedinherited 
Internal communication pattern in case the matrix needs to be copied from deal.II format.
Definition at line 238 of file trilinos_precondition.h.

protectedinherited 
Internal Trilinos map in case the matrix needs to be copied from deal.II format.
Definition at line 244 of file trilinos_precondition.h.