MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_DirectSolver_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_DIRECTSOLVER_DECL_HPP
47 #define MUELU_DIRECTSOLVER_DECL_HPP
48 
50 
51 #include <Xpetra_Matrix_fwd.hpp>
52 
53 #include "MueLu_ConfigDefs.hpp"
55 
56 #include "MueLu_SmootherPrototype.hpp"
57 
61 
62 // Note: DirectSolver is a SmootherPrototype that cannot be turned into a smoother using Setup().
63 // When this prototype is cloned using Copy(), the clone is an Amesos or an Amesos2 smoother.
64 // The clone can be used as a smoother after calling Setup().
65 
66 namespace MueLu {
67 
74  template <class Scalar = SmootherPrototype<>::scalar_type,
75  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
76  class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
77  class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
78  class DirectSolver : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
79 #undef MUELU_DIRECTSOLVER_SHORT
80 #include "MueLu_UseShortNames.hpp"
81 
82  public:
83 
85 
86 
89  DirectSolver(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
90 
92  virtual ~DirectSolver() { }
93 
95 
97 
98 
99  void DeclareInput(Level& currentLevel) const;
100 
102 
104 
105 
107  void Setup(Level& currentLevel);
108 
110  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
111 
113 
115  void SetFactory(const std::string& varName, const RCP<const FactoryBase>& factory);
116 
119 
121 
122 
124  std::string description() const;
125 
126  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
127 
129  size_t getNodeSmootherComplexity() const {
130  if(!s_.is_null())
131  return s_->getNodeSmootherComplexity();
132  else return 0.0;
133  }
134 
136 
137  private:
138 
139  //
140  // Parameters
141  //
142 
144  std::string type_;
145 
146  //
147  // Underlying Smoother
148  //
149 
152  mutable
154 
155  // Records for the case if something goes wrong
158 
159  }; // class DirectSolver
160 
161 } // namespace MueLu
162 
163 #define MUELU_DIRECTSOLVER_SHORT
164 #endif // MUELU_DIRECTSOLVER_DECL_HPP
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
DirectSolver cannot be applied. Apply() always returns a RuntimeError exception.
void Setup(Level &currentLevel)
DirectSolver cannot be turned into a smoother using Setup(). Setup() always returns a RuntimeError ex...
void DeclareInput(Level &currentLevel) const
Input.
Base class for smoother prototypes.
std::string type_
amesos1/2-specific key phrase that denote smoother type
DirectSolver(const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
Constructor Note: only parameters shared by Amesos and Amesos2 should be used for type and paramList ...
Class that encapsulates direct solvers. Autoselection of AmesosSmoother or Amesos2Smoother according ...
RCP< SmootherPrototype > Copy() const
When this prototype is cloned using Copy(), the clone is an Amesos or an Amesos2 smoother.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
std::string description() const
Return a simple one-line description of this object.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< SmootherPrototype > sTpetra_
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Custom SetFactory.
virtual ~DirectSolver()
Destructor.
RCP< SmootherPrototype > sEpetra_
Smoother.
RCP< SmootherPrototype > s_
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.