MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_FilteredAFactory_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_FILTEREDAFACTORY_DECL_HPP
47 #define MUELU_FILTEREDAFACTORY_DECL_HPP
48 
49 #include <string>
50 
51 #include "MueLu_ConfigDefs.hpp"
53 
54 #include "MueLu_GraphBase.hpp"
55 #include "MueLu_Level_fwd.hpp"
57 
58 namespace MueLu {
59 
65  template <class Scalar = DefaultScalar,
68  class Node = DefaultNode>
70 #undef MUELU_FILTEREDAFACTORY_SHORT
71 #include "MueLu_UseShortNames.hpp"
72 
73  public:
74 
76 
77 
79 
81  virtual ~FilteredAFactory() { }
82 
84 
86 
88 
89 
90  void DeclareInput(Level& currentLevel) const;
91 
93 
95 
96 
102  void Build(Level& currentLevel) const;
103 
105  private:
106  void BuildReuse(const Matrix& A, const GraphBase& G, const bool lumping, Matrix& filteredA) const;
107  void BuildNew (const Matrix& A, const GraphBase& G, const bool lumping, Matrix& filteredA) const;
108 
109  }; //class FilteredAFactory
110 
111 } //namespace MueLu
112 
113 #define MUELU_FILTEREDAFACTORY_SHORT
114 #endif // MUELU_FILTEREDAFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &currentLevel) const
Build method.
MueLu::DefaultNode Node
void BuildNew(const Matrix &A, const GraphBase &G, const bool lumping, Matrix &filteredA) const
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual ~FilteredAFactory()
Destructor.
MueLu representation of a graph.
void BuildReuse(const Matrix &A, const GraphBase &G, const bool lumping, Matrix &filteredA) const
void DeclareInput(Level &currentLevel) const
Input.
Factory for building filtered matrices using filtered graphs.
Base class for factories that use one level (currentLevel).