Reference documentation for deal.II version Git c1e8229cd1 20210506 12:37:45 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 an incomplete Cholesky factorization (IC) preconditioner for symmetric 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). Trilinos allows to set the amount of fillin elements, governed by the additional data argument ic_fill
, so one can gradually choose between a factorization on the sparse matrix structure only (ic_fill=0
) to a full factorization (ic_fill
in the range of 10 to 50, depending on the spatial dimension of the PDE problem and the degree of the finite element basis functions; generally, more required fillin elements require this parameter to be set to a higher integer value).
The AdditionalData data structure allows to set preconditioner options. Besides the fillin argument, 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 IC 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 IC approximate solve as inner solver, based on the (outer) parallel partitioning.
Definition at line 865 of file trilinos_precondition.h.

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

) 
Initialize function. Takes the matrix the preconditioner should be computed of, and additional flags if there are any.
Definition at line 477 of file trilinos_precondition.cc.

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

inherited 
Return the MPI communicator object in use with this matrix.
Definition at line 67 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 78 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 87 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 94 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 236 of file trilinos_precondition.h.

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

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