43#ifndef IFPACK2_BLOCKRELAXATION_DECL_HPP
44#define IFPACK2_BLOCKRELAXATION_DECL_HPP
50#include "Ifpack2_Partitioner.hpp"
52#include "Ifpack2_ContainerFactory.hpp"
53#include "Tpetra_BlockCrsMatrix.hpp"
81template<
class MatrixType,
class ContainerType = Container<MatrixType> >
84 typename MatrixType::local_ordinal_type,
85 typename MatrixType::global_ordinal_type,
86 typename MatrixType::node_type>,
88 typename MatrixType::local_ordinal_type,
89 typename MatrixType::global_ordinal_type,
90 typename MatrixType::node_type> >
108 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
111 typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type>
row_matrix_type;
113 static_assert (std::is_same<MatrixType, row_matrix_type>::value,
114 "Ifpack2::BlockRelaxation: Please use MatrixType = Tpetra::RowMatrix.");
116 static_assert (std::is_same<ContainerType, Container<row_matrix_type> >::value,
117 "Ifpack2::BlockRelaxation: Do NOT specify the (second) "
118 "ContainerType template parameter explicitly. The default "
119 "value is fine. Please instead specify the container type to "
120 "use by setting the \"relaxation: container\" parameter.");
123 typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type>
import_type;
131 void setParametersImpl(Teuchos::ParameterList& params);
133 void computeImporter()
const;
139 typedef Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> vector_type;
140 typedef Teuchos::ScalarTraits<scalar_type> STS;
141 typedef Teuchos::ScalarTraits<magnitude_type> STM;
144 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
180 explicit BlockRelaxation (
const Teuchos::RCP<const row_matrix_type>& Matrix);
219 bool supportsZeroStartingSolution() {
return true; }
224 Teuchos::RCP<const Teuchos::ParameterList>
232 return(IsInitialized_);
270 setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
287 void apply(
const MV& X,
289 Teuchos::ETransp mode = Teuchos::NO_TRANS,
290 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
291 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
299 bool hasTransposeApply()
const;
310 Teuchos::ETransp mode = Teuchos::NO_TRANS)
const;
317 Teuchos::RCP<const Teuchos::Comm<int> >
getComm()
const;
320 Teuchos::RCP<const row_matrix_type>
getMatrix()
const;
352 describe (Teuchos::FancyOStream& out,
353 const Teuchos::EVerbosityLevel verbLevel =
354 Teuchos::Describable::verbLevel_default)
const;
359 Teuchos::RCP<Ifpack2::Partitioner<Tpetra::RowGraph<local_ordinal_type,global_ordinal_type,node_type> > >
getPartitioner(){
return Partitioner_;}
370 virtual void ApplyInverseJacobi (
const MV& X, MV& Y)
const;
372 virtual void ApplyInverseGS (
const MV& X, MV& Y)
const;
374 virtual void ApplyInverseSGS (
const MV& X, MV& Y)
const;
378 void ExtractSubmatricesStructure();
385 Teuchos::RCP<const row_matrix_type> A_;
388 mutable Teuchos::RCP<Container<row_matrix_type> > Container_;
395 mutable Teuchos::RCP<vector_type> DiagRCP_;
398 Teuchos::RCP<Ifpack2::Partitioner<Tpetra::RowGraph<local_ordinal_type,global_ordinal_type,node_type> > > Partitioner_;
402 std::string PartitionerType_;
405 Teuchos::ParameterList List_;
414 std::string containerType_;
417 Details::RelaxationType PrecType_;
423 bool ZeroStartingSolution_;
427 bool hasBlockCrsMatrix_;
440 std::string schwarzCombineMode_;
461 mutable int NumApply_;
464 double InitializeTime_;
470 mutable double ApplyTime_;
483 Teuchos::RCP<vector_type> W_;
485 mutable Teuchos::RCP<const Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type>> Importer_;
Declaration of interface for preconditioners that can change their matrix after construction.
Block relaxation preconditioners (or smoothers) for Tpetra::RowMatrix and Tpetra::CrsMatrix sparse ma...
Definition: Ifpack2_BlockRelaxation_decl.hpp:91
Teuchos::RCP< const row_matrix_type > getMatrix() const
The input matrix of this preconditioner's constructor.
Definition: Ifpack2_BlockRelaxation_def.hpp:375
Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > row_matrix_type
Tpetra::RowMatrix specialization corresponding to MatrixType.
Definition: Ifpack2_BlockRelaxation_decl.hpp:111
Teuchos::RCP< const map_type > getDomainMap() const
Returns the Tpetra::Map object associated with the domain of this operator.
Definition: Ifpack2_BlockRelaxation_def.hpp:384
void setZeroStartingSolution(bool zeroStartingSolution)
Set this preconditioner's parameters.
Definition: Ifpack2_BlockRelaxation_decl.hpp:221
int getNumApply() const
Returns the number of calls to apply().
Definition: Ifpack2_BlockRelaxation_def.hpp:432
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Return a list of all the parameters that this class accepts.
Definition: Ifpack2_BlockRelaxation_def.hpp:126
void compute()
compute the preconditioner for the specified matrix, diagonal perturbation thresholds and relaxation ...
Definition: Ifpack2_BlockRelaxation_def.hpp:729
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_BlockRelaxation_def.hpp:463
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
Definition: Ifpack2_BlockRelaxation_def.hpp:1108
Tpetra::Import< local_ordinal_type, global_ordinal_type, node_type > import_type
Tpetra::Importer specialization for use with MatrixType and compatible MultiVectors.
Definition: Ifpack2_BlockRelaxation_decl.hpp:123
MatrixType::local_ordinal_type local_ordinal_type
The type of local indices in the input MatrixType.
Definition: Ifpack2_BlockRelaxation_decl.hpp:100
virtual ~BlockRelaxation()
Destructor.
Definition: Ifpack2_BlockRelaxation_def.hpp:120
bool isInitialized() const
Returns true if the preconditioner has been successfully initialized.
Definition: Ifpack2_BlockRelaxation_decl.hpp:231
int getNumCompute() const
Returns the number of calls to compute().
Definition: Ifpack2_BlockRelaxation_def.hpp:424
double getApplyTime() const
Returns the time spent in apply().
Definition: Ifpack2_BlockRelaxation_def.hpp:456
int getNumInitialize() const
Returns the number of calls to initialize().
Definition: Ifpack2_BlockRelaxation_def.hpp:417
MatrixType::node_type node_type
Node type of the input MatrixType.
Definition: Ifpack2_BlockRelaxation_decl.hpp:105
void initialize()
Initialize.
Definition: Ifpack2_BlockRelaxation_def.hpp:593
Teuchos::RCP< const map_type > getRangeMap() const
Returns the Tpetra::Map object associated with the range of this operator.
Definition: Ifpack2_BlockRelaxation_def.hpp:398
bool isComputed() const
Return true if compute() has been called.
Definition: Ifpack2_BlockRelaxation_decl.hpp:239
void applyMat(const MV &X, MV &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS) const
Applies the matrix to a Tpetra::MultiVector.
Definition: Ifpack2_BlockRelaxation_def.hpp:577
double getComputeTime() const
Returns the time spent in compute().
Definition: Ifpack2_BlockRelaxation_def.hpp:448
void setParameters(const Teuchos::ParameterList ¶ms)
Sets all the parameters for the preconditioner.
Definition: Ifpack2_BlockRelaxation_def.hpp:179
double getInitializeTime() const
Returns the time spent in initialize().
Definition: Ifpack2_BlockRelaxation_def.hpp:440
void apply(const MV &X, MV &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
Applies the preconditioner to X, returns the result in Y.
Definition: Ifpack2_BlockRelaxation_def.hpp:480
std::string description() const
A one-line description of this object.
Definition: Ifpack2_BlockRelaxation_def.hpp:1044
MatrixType::global_ordinal_type global_ordinal_type
The type of global indices in the input MatrixType.
Definition: Ifpack2_BlockRelaxation_decl.hpp:103
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
The communicator over which the input matrix is distributed.
Definition: Ifpack2_BlockRelaxation_def.hpp:361
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_BlockRelaxation_decl.hpp:108
Teuchos::RCP< Ifpack2::Partitioner< Tpetra::RowGraph< local_ordinal_type, global_ordinal_type, node_type > > > getPartitioner()
For diagnostic purposes.
Definition: Ifpack2_BlockRelaxation_decl.hpp:359
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_BlockRelaxation_def.hpp:58
MatrixType::scalar_type scalar_type
The type of the entries of the input MatrixType.
Definition: Ifpack2_BlockRelaxation_decl.hpp:97
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:108
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74