Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_Details_Fic_def.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 
44 
45 #ifndef __IFPACK2_FIC_DEF_HPP__
46 #define __IFPACK2_FIC_DEF_HPP__
47 
48 #include "Ifpack2_Details_Fic_decl.hpp"
50 #include <impl/Kokkos_Timer.hpp>
51 #include <shylu_fastic.hpp>
52 
53 namespace Ifpack2
54 {
55 namespace Details
56 {
57 
58 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
61  FastILU_Base<Scalar, LocalOrdinal, GlobalOrdinal, Node>(A) {}
62 
63 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
65 getSweeps() const
66 {
67  return localPrec_->getNFact();
68 }
69 
70 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
72 getNTrisol() const
73 {
74  return localPrec_->getNTrisol();
75 }
76 
77 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
79 checkLocalIC() const
80 {
81  localPrec_->checkIC();
82 }
83 
84 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
87 {
88  auto nRows = this->mat_->getNodeNumRows();
89  auto& p = this->params_;
90  localPrec_ = Teuchos::rcp(new LocalFIC(this->localRowPtrs_, this->localColInds_, this->localValues_, nRows,
91  p.nFact, p.nTrisol, p.level, p.omega,
92  p.shift, p.guessFlag ? 1 : 0, p.blockSize));
93  localPrec_->initialize();
94  this->initTime_ = localPrec_->getInitializeTime();
95 }
96 
97 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
100 {
101  //update values in local prec (until compute(), values aren't needed)
102  localPrec_->setValues(this->localValues_);
103  localPrec_->compute();
104  this->computeTime_ = localPrec_->getComputeTime();
105 }
106 
107 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
110 {
111  localPrec_->apply(x, y);
112  //since this may be applied to multiple vectors, add to applyTime_ instead of setting it
113  this->applyTime_ += localPrec_->getApplyTime();
114 }
115 
116 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
118 getName() const
119 {
120  return "Fic";
121 }
122 
123 #define IFPACK2_DETAILS_FIC_INSTANT(S, L, G, N) \
124 template class Ifpack2::Details::Fic<S, L, G, N>;
125 
126 } //namespace Details
127 } //namespace Ifpack2
128 
129 #endif
130 
Fic(Teuchos::RCP< const TRowMatrix > mat_)
Constructor.
Definition: Ifpack2_Details_Fic_def.hpp:60
int getSweeps() const
Get the sweeps ("nFact") from localPrec_.
Definition: Ifpack2_Details_Fic_def.hpp:65
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:118
void initLocalPrec()
Construct the underlying preconditioner (localPrec_) using given params and then call localPrec_-&gt;ini...
Definition: Ifpack2_Details_Fic_def.hpp:86
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
The base class of the Ifpack2 FastILU wrappers (Filu, Fildl and Fic)
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:66
void computeLocalPrec()
Get values array from the matrix and then call compute() on the underlying preconditioner.
Definition: Ifpack2_Details_Fic_def.hpp:99
int getNTrisol() const
Get the number of triangular solves ("nTrisol") from localPrec_.
Definition: Ifpack2_Details_Fic_def.hpp:72
void checkLocalIC() const
Verify and print debug info about the internal IC preconditioner.
Definition: Ifpack2_Details_Fic_def.hpp:79
Kokkos::View< Scalar *, execution_space > ScalarArray
Array of Scalar on device.
Definition: Ifpack2_Details_FastILU_Base_decl.hpp:88
void applyLocalPrec(ScalarArray x, ScalarArray 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:109
Provides functions for retrieving local CRS arrays (row pointers, column indices, and values) from Tp...