MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_BlockedRAPFactory_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_BLOCKEDRAPFACTORY_DECL_HPP
47 #define MUELU_BLOCKEDRAPFACTORY_DECL_HPP
48 
49 #include <Xpetra_Matrix_fwd.hpp>
50 #include <Xpetra_CrsMatrix_fwd.hpp>
54 #include <Xpetra_Vector_fwd.hpp>
56 
57 #include "MueLu_ConfigDefs.hpp"
58 #include "MueLu_RAPFactory_fwd.hpp"
59 
60 #include "MueLu_Level_fwd.hpp"
62 #include "MueLu_PerfUtils_fwd.hpp"
64 #include "MueLu_Utilities_fwd.hpp"
65 
66 namespace MueLu {
71  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
73 #undef MUELU_BLOCKEDRAPFACTORY_SHORT
74 #include "MueLu_UseShortNames.hpp"
75 
76  public:
78 
79 
81 
82  virtual ~BlockedRAPFactory() { }
84 
86 
87 
89 
90  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
91 
93 
95 
96  void Build(Level &fineLevel, Level &coarseLevel) const;
98 
100 
101 
103  void SetRepairZeroDiagonal(bool const &repair) {
104  repairZeroDiagonals_ = repair;
105  if(repair) checkAc_ = true; // make sure that plausibility check is performed. Otherwise SetRepairZeroDiagonal(true) has no effect.
106  }
107 
109  void SetPlausibilityCheck(bool const &check) {
110  checkAc_ = check;
111  }
112 
114 
119  void AddTransferFactory(const RCP<const FactoryBase>& factory);
120 
121  // TODO add a function to remove a specific transfer factory?
122 
124  size_t NumTransferFactories() const { return transferFacts_.size(); }
125 
127 
128  private:
129 
132  static void CheckMainDiagonal(RCP<BlockedCrsMatrix> & bAc, bool repairZeroDiagonals = false);
133 
136  bool checkAc_;
137 
142 
144 
146  std::vector<RCP<const FactoryBase> > transferFacts_;
147 
149 
150  }; //class BlockedRAPFactory
151 
152 } //namespace MueLu
153 
154 #define MUELU_BLOCKEDRAPFACTORY_SHORT
155 #endif // MUELU_BLOCKEDRAPFACTORY_DECL_HPP
void SetPlausibilityCheck(bool const &check)
Indicate that a simple plausibility check shall be done for Ac after building RAP.
Factory for building coarse matrices.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Base class for factories that use two levels (fineLevel and coarseLevel).
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
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.
static void CheckMainDiagonal(RCP< BlockedCrsMatrix > &bAc, bool repairZeroDiagonals=false)
std::vector< RCP< const FactoryBase > > transferFacts_
list of user-defined transfer Factories
void SetRepairZeroDiagonal(bool const &repair)
Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0...
size_t NumTransferFactories() const
Returns number of transfer factories.