Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_Details_Fic_decl.hpp
1 // @HEADER
2 // *****************************************************************************
3 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
4 //
5 // Copyright 2009 NTESS and the Ifpack2 contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
11 
12 #ifndef __IFPACK2_FIC_DECL_HPP__
13 #define __IFPACK2_FIC_DECL_HPP__
14 
15 #include <Ifpack2_Details_FastILU_Base.hpp>
16 
17 //forward-declare the local preconditioner type
18 template<typename LocalOrdinal, typename Scalar, typename execution_space>
19 class FastICPrec;
20 
21 namespace Ifpack2
22 {
23 namespace Details
24 {
25 
28 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
29 class Fic : public FastILU_Base<Scalar, LocalOrdinal, GlobalOrdinal, Node>
30 {
31  public:
33  typedef typename Base::TRowMatrix TRowMatrix;
34  typedef typename Base::ImplScalar ImplScalar;
35  typedef typename Base::ImplScalarArray ImplScalarArray;
36  typedef FastICPrec<LocalOrdinal, ImplScalar, typename Base::execution_space> LocalFIC;
37 
40 
42  int getSweeps() const;
43 
45  std::string getSpTrsvType() const;
46 
48  int getNTrisol() const;
49 
51  void checkLocalIC() const;
52 
53  protected:
54  mutable Teuchos::RCP<LocalFIC> localPrec_;
55 
56  void initLocalPrec();
57  //compute() takes A's local values
58  void computeLocalPrec();
60  std::string getName() const;
61 };
62 
63 } //namespace Details
64 } //namespace Ifpack2
65 
66 #endif
67 
Fic(Teuchos::RCP< const TRowMatrix > mat_)
Constructor.
Definition: Ifpack2_Details_Fic_def.hpp:27
int getSweeps() const
Get the sweeps ("nFact") from localPrec_.
Definition: Ifpack2_Details_Fic_def.hpp:32
std::string getName() const
Get the name of the underlying preconditioner (&quot;Filu&quot;, &quot;Fildl&quot; or &quot;Fic&quot;)
Definition: Ifpack2_Details_Fic_def.hpp:91
void initLocalPrec()
Construct the underlying preconditioner (localPrec_) using given params and then call localPrec_-&gt;ini...
Definition: Ifpack2_Details_Fic_def.hpp:60
The base class of the Ifpack2 FastILU wrappers (Filu, Fildl and Fic)
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:38
void computeLocalPrec()
Get values array from the matrix and then call compute() on the underlying preconditioner.
Definition: Ifpack2_Details_Fic_def.hpp:72
std::string getSpTrsvType() const
Get the name of triangular solve algorithm.
Definition: Ifpack2_Details_Fic_def.hpp:39
Kokkos::View< ImplScalar *, execution_space > ImplScalarArray
Array of Scalar on device.
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:62
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::impl_scalar_type ImplScalar
Kokkos scalar type.
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:48
The Ifpack2 wrapper to the incomplete Chebyshev preconditioner of ShyLU FastILU.
Definition: Ifpack2_Details_Fic_decl.hpp:29
Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > TRowMatrix
Tpetra row matrix.
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:50
void applyLocalPrec(ImplScalarArray x, ImplScalarArray y) const
Apply the local preconditioner with 1-D views of the local parts of X and Y (one vector only) ...
Definition: Ifpack2_Details_Fic_def.hpp:82
int getNTrisol() const
Get the number of triangular solves ("nTrisol") from localPrec_.
Definition: Ifpack2_Details_Fic_def.hpp:46
void checkLocalIC() const
Verify and print debug info about the internal IC preconditioner.
Definition: Ifpack2_Details_Fic_def.hpp:53