MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_MatrixAnalysisFactory_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 
47 #ifndef MUELU_MATRIXANALYSISFACTORY_DECL_HPP_
48 #define MUELU_MATRIXANALYSISFACTORY_DECL_HPP_
49 
50 #include <Xpetra_Map_fwd.hpp>
52 #include <Xpetra_Vector_fwd.hpp>
54 #include <Xpetra_Matrix_fwd.hpp>
55 
56 #include "MueLu_ConfigDefs.hpp"
58 #include "MueLu_Utilities_fwd.hpp"
59 
60 namespace MueLu {
61 
90  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
91  class MatrixAnalysisFactory : public TwoLevelFactoryBase {
92 #undef MUELU_MATRIXANALYSISFACTORY_SHORT
93 #include "MueLu_UseShortNames.hpp"
94 
95  public:
97 
98 
101 
103  virtual ~MatrixAnalysisFactory();
104 
106 
107  RCP<const ParameterList> GetValidParameterList() const;
108 
110 
111 
117  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
118 
120 
122 
123 
125  void Build(Level &fineLevel, Level &coarseLevel) const;
126 
128 
129  private:
130  void checkVectorEntries(const Teuchos::RCP<Vector>& vec, std::string info) const;
131 
132  }; // class MatrixAnalysisFactory
133 
134 } // namespace MueLu
135 
136 #define MUELU_MATRIXANALYSISFACTORY_SHORT
137 
138 
139 #endif /* MUELU_MATRIXANALYSISFACTORY_DECL_HPP_ */
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void checkVectorEntries(const Teuchos::RCP< Vector > &vec, std::string info) 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
Specifies the data that this class needs, and the factories that generate that data.