Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_IdentitySolver_decl.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_IDENTITY_SOLVER_DECL_HPP
44 #define IFPACK2_IDENTITY_SOLVER_DECL_HPP
45 
48 #include <type_traits>
49 
50 namespace Ifpack2 {
51 
58 template<class MatrixType>
60  virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
61  typename MatrixType::local_ordinal_type,
62  typename MatrixType::global_ordinal_type,
63  typename MatrixType::node_type>,
64  virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
65  typename MatrixType::local_ordinal_type,
66  typename MatrixType::global_ordinal_type,
67  typename MatrixType::node_type> >
68 {
69 public:
71  typedef typename MatrixType::scalar_type scalar_type;
73  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
75  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
77  typedef typename MatrixType::node_type node_type;
78 
82  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
84  typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type,
86 
87  static_assert(std::is_same<MatrixType, row_matrix_type>::value, "Ifpack2::IdentitySolver: The template parameter MatrixType must be a Tpetra::RowMatrix specialization. Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore. The constructor can take either a RowMatrix or a CrsMatrix just fine.");
88 
91 
93  virtual ~IdentitySolver();
94 
98  void setParameters (const Teuchos::ParameterList& params);
99 
101  void initialize();
102 
104  inline bool isInitialized() const {
105  return(isInitialized_);
106  }
107 
109  void compute();
110 
112  inline bool isComputed() const {
113  return(isComputed_);
114  }
115 
117 
118 
125  void
126  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
127  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
131 
134 
137 
142  void
143  applyMat (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
144  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
145  Teuchos::ETransp mode = Teuchos::NO_TRANS) const;
146 
149 
152  return matrix_;
153  }
154 
156  double getComputeFlops() const;
157 
159  double getApplyFlops() const;
160 
162  int getNumInitialize() const;
163 
165  int getNumCompute() const;
166 
168  int getNumApply() const;
169 
171  double getInitializeTime() const;
172 
174  double getComputeTime() const;
175 
177  double getApplyTime() const;
178 
180 
182 
184  std::string description() const;
185 
188 
193  virtual void setMatrix (const Teuchos::RCP<const row_matrix_type>& A);
194 
196 
197 private:
199  typedef Tpetra::Export<local_ordinal_type, global_ordinal_type, node_type> export_type;
200 
202 
211 
212  bool isInitialized_;
213  bool isComputed_;
214 
215  mutable int numInitialize_;
216  mutable int numCompute_;
217  mutable int numApply_;
218 
219  double initializeTime_;
220  double computeTime_;
221  double applyTime_;
222 };
223 
224 }//namespace Ifpack2
225 
226 #endif
int getNumApply() const
Return the number of calls to apply().
Definition: Ifpack2_IdentitySolver_def.hpp:174
MatrixType::node_type node_type
Node type of the input matrix.
Definition: Ifpack2_IdentitySolver_decl.hpp:77
double getComputeTime() const
Return the time spent in compute().
Definition: Ifpack2_IdentitySolver_def.hpp:184
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
int getNumCompute() const
Return the number of calls to compute().
Definition: Ifpack2_IdentitySolver_def.hpp:169
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Return the communicator associated with this matrix operator.
void applyMat(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS) const
Apply the original input matrix.
virtual ~IdentitySolver()
Destructor.
Definition: Ifpack2_IdentitySolver_def.hpp:66
void apply(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
Apply the preconditioner to X, and put the result in Y.
Definition: Ifpack2_IdentitySolver_def.hpp:124
Teuchos::RCP< const map_type > getRangeMap() const
Return the Tpetra::Map object associated with the range of this operator.
Definition: Ifpack2_IdentitySolver_def.hpp:254
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
Type of the absolute value (magnitude) of a scalar_type value.
Definition: Ifpack2_IdentitySolver_decl.hpp:80
Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > map_type
Specialization of Tpetra::Map used by this class.
Definition: Ifpack2_IdentitySolver_decl.hpp:82
bool isInitialized() const
Return true if the preconditioner has been successfully initialized.
Definition: Ifpack2_IdentitySolver_decl.hpp:104
void setParameters(const Teuchos::ParameterList &params)
Set this object&#39;s parameters.
Definition: Ifpack2_IdentitySolver_def.hpp:71
&quot;Identity&quot; preconditioner.
Definition: Ifpack2_IdentitySolver_decl.hpp:59
void initialize()
Initialize.
Definition: Ifpack2_IdentitySolver_def.hpp:76
bool isComputed() const
Return true if compute() has been called.
Definition: Ifpack2_IdentitySolver_decl.hpp:112
Teuchos::RCP< const map_type > getDomainMap() const
Return the Tpetra::Map object associated with the domain of this operator.
Definition: Ifpack2_IdentitySolver_def.hpp:244
IdentitySolver(const Teuchos::RCP< const row_matrix_type > &A)
Constructor: Takes the matrix to precondition.
Definition: Ifpack2_IdentitySolver_def.hpp:52
MatrixType::local_ordinal_type local_ordinal_type
Type of the local indices of the input matrix.
Definition: Ifpack2_IdentitySolver_decl.hpp:73
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Set this preconditioner&#39;s matrix.
Definition: Ifpack2_IdentitySolver_def.hpp:265
double getComputeFlops() const
Return the number of flops in the computation phase.
Declaration of interface for preconditioners that can change their matrix after construction.
std::string description() const
Return a simple one-line description of this object.
Definition: Ifpack2_IdentitySolver_def.hpp:194
static const EVerbosityLevel verbLevel_default
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_IdentitySolver_def.hpp:224
void compute()
Compute the preconditioner.
Definition: Ifpack2_IdentitySolver_def.hpp:107
Teuchos::RCP< const row_matrix_type > getMatrix() const
Return a reference to the matrix to be preconditioned.
Definition: Ifpack2_IdentitySolver_decl.hpp:151
int getNumInitialize() const
Return the number of calls to initialize().
Definition: Ifpack2_IdentitySolver_def.hpp:164
MatrixType::global_ordinal_type global_ordinal_type
Type of the global indices of the input matrix.
Definition: Ifpack2_IdentitySolver_decl.hpp:75
double getInitializeTime() const
Return the time spent in initialize().
Definition: Ifpack2_IdentitySolver_def.hpp:179
MatrixType::scalar_type scalar_type
Type of the entries of the input matrix.
Definition: Ifpack2_IdentitySolver_decl.hpp:71
double getApplyTime() const
Return the time spent in apply().
Definition: Ifpack2_IdentitySolver_def.hpp:189
double getApplyFlops() const
Return the number of flops for the application of the preconditioner.
Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > row_matrix_type
Specialization of Tpetra::RowMatrix used by this class.
Definition: Ifpack2_IdentitySolver_decl.hpp:85