MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_TentativePFactory_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_TENTATIVEPFACTORY_DECL_HPP
47 #define MUELU_TENTATIVEPFACTORY_DECL_HPP
48 
49 #include <Teuchos_ScalarTraits.hpp>
52 
53 #include <Xpetra_CrsMatrix_fwd.hpp>
54 #include <Xpetra_Matrix_fwd.hpp>
57 #include <Xpetra_Map_fwd.hpp>
58 #include <Xpetra_Matrix_fwd.hpp>
61 #include <Xpetra_Import_fwd.hpp>
64 
65 #include "MueLu_ConfigDefs.hpp"
67 
68 #include "MueLu_Aggregates_fwd.hpp"
72 #include "MueLu_Level_fwd.hpp"
73 #include "MueLu_PerfUtils_fwd.hpp"
74 #include "MueLu_PFactory.hpp"
75 #include "MueLu_Utilities_fwd.hpp"
76 
77 namespace MueLu {
78 
118  template <class Scalar = double,
119  class LocalOrdinal = int,
120  class GlobalOrdinal = LocalOrdinal,
122  class TentativePFactory : public PFactory {
123 #undef MUELU_TENTATIVEPFACTORY_SHORT
124 #include "MueLu_UseShortNames.hpp"
125 
126  public:
128 
129 
132 
134  virtual ~TentativePFactory() { }
136 
138 
140 
141 
142  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
143 
145 
147 
148 
149  void Build (Level& fineLevel, Level& coarseLevel) const;
150  void BuildP(Level& fineLevel, Level& coarseLevel) const;
151 
153 
154  private:
155 
156  void BuildPuncoupled(RCP<Matrix> A, RCP<Aggregates> aggregates, RCP<AmalgamationInfo> amalgInfo, RCP<MultiVector> fineNullspace,
157  RCP<const Map> coarseMap, RCP<Matrix>& Ptentative, RCP<MultiVector>& coarseNullspace, const int levelID) const;
158  void BuildPcoupled (RCP<Matrix> A, RCP<Aggregates> aggregates, RCP<AmalgamationInfo> amalgInfo, RCP<MultiVector> fineNullspace,
159  RCP<const Map> coarseMap, RCP<Matrix>& Ptentative, RCP<MultiVector>& coarseNullspace) const;
160  bool isGoodMap(const Map& rowMap, const Map& colMap) const;
161 
162  mutable bool bTransferCoordinates_ = false;
163 
164  }; //class TentativePFactory
165 
166 } //namespace MueLu
167 
168 //TODO: noQR_
169 
170 #define MUELU_TENTATIVEPFACTORY_SHORT
171 #endif // MUELU_TENTATIVEPFACTORY_DECL_HPP
void BuildPuncoupled(RCP< Matrix > A, RCP< Aggregates > aggregates, RCP< AmalgamationInfo > amalgInfo, RCP< MultiVector > fineNullspace, RCP< const Map > coarseMap, RCP< Matrix > &Ptentative, RCP< MultiVector > &coarseNullspace, const int levelID) const
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void BuildPcoupled(RCP< Matrix > A, RCP< Aggregates > aggregates, RCP< AmalgamationInfo > amalgInfo, RCP< MultiVector > fineNullspace, RCP< const Map > coarseMap, RCP< Matrix > &Ptentative, RCP< MultiVector > &coarseNullspace) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Factory for building tentative prolongator.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
bool isGoodMap(const Map &rowMap, const Map &colMap) const
Factory that provides an interface for a concrete implementation of a prolongation operator...
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.