MueLu  Version of the Day
MueLu_RAPShiftFactory_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_RAPSHIFTFACTORY_DECL_HPP
47 #define MUELU_RAPSHIFTFACTORY_DECL_HPP
48 
49 #include <string>
50 
51 #include <Xpetra_Matrix_fwd.hpp>
52 #include <Xpetra_CrsMatrix_fwd.hpp>
53 #include <Xpetra_MatrixFactory_fwd.hpp>
54 #include <Xpetra_Vector_fwd.hpp>
55 #include <Xpetra_VectorFactory_fwd.hpp>
56 
57 #include "MueLu_ConfigDefs.hpp"
59 
61 #include "MueLu_Level_fwd.hpp"
62 #include "MueLu_PerfUtils_fwd.hpp"
64 #include "MueLu_Utilities_fwd.hpp"
65 
66 namespace MueLu {
74  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
76 #undef MUELU_RAPSHIFTFACTORY_SHORT
77 #include "MueLu_UseShortNames.hpp"
78 
79  public:
81 
82 
84 
85  virtual ~RAPShiftFactory() { }
86 
88 
90 
91 
92  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
93 
95 
97 
98  void Build(Level &fineLevel, Level &coarseLevel) const;
100 
102 
103 
105  void SetImplicitTranspose(bool const &implicit) {
106  implicitTranspose_ = implicit;
107  }
108 
110  void SetRepairZeroDiagonal(bool const &repairZeroDiagonals) {
111  repairZeroDiagonals_ = repairZeroDiagonals;
112  if(repairZeroDiagonals_) checkAc_ = true; // make sure that plausibility check is performed. Otherwise SetRepairZeroDiagonal(true) has no effect.
113  }
114 
116  void SetPlausibilityCheck(bool const &checkAc) {
117  checkAc_ = checkAc;
118  }
119 
120  void SetShifts(std::vector<Scalar>& shifts) {
121  shifts_.clear();
122  shifts_ = shifts;
123  }
124 
126 
128 
133  void AddTransferFactory(const RCP<const FactoryBase>& factory);
134 
135  // TODO add a function to remove a specific transfer factory?
136 
138  size_t NumTransferFactories() const { return transferFacts_.size(); }
139 
141 
142  private:
143 
145  void CheckMainDiagonal(RCP<Matrix> & Ac) const;
146 
149 
152  bool checkAc_;
153 
158 
160  std::vector<RCP<const FactoryBase> > transferFacts_;
161 
162  // vector of shifting terms
163  std::vector<Scalar> shifts_;
164 
165  }; //class RAPShiftFactory
166 
167 } //namespace MueLu
168 
169 #define MUELU_RAPSHIFTFACTORY_SHORT
170 #endif // MUELU_RAPSHIFTFACTORY_DECL_HPP
Factory for building coarse grid matrices, when the matrix is of the form K+a*M. Useful when you want...
void CheckMainDiagonal(RCP< Matrix > &Ac) const
Base class for factories that use two levels (fineLevel and coarseLevel).
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Namespace for MueLu classes and methods.
bool implicitTranspose_
If true, the action of the restriction operator action is implicitly defined by the transpose of the ...
size_t NumTransferFactories() const
Returns number of transfer factories.
void SetPlausibilityCheck(bool const &checkAc)
Indicate that a simple plausibility check shall be done for Ac after building RAP.
std::vector< RCP< const FactoryBase > > transferFacts_
list of user-defined transfer Factories
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void AddTransferFactory(const RCP< const FactoryBase > &factory)
Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.
void SetShifts(std::vector< Scalar > &shifts)
void SetImplicitTranspose(bool const &implicit)
Indicate that the restriction operator action should be implicitly defined by the transpose of the pr...
void SetRepairZeroDiagonal(bool const &repairZeroDiagonals)
Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0...
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.