MueLu Version of the Day
Loading...
Searching...
No Matches
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
49#include <Teuchos_ParameterList.hpp>
50
51#include <Xpetra_Matrix_fwd.hpp>
52
53#include "MueLu_ConfigDefs.hpp"
55
56#include "MueLu_SmootherPrototype.hpp"
57
64
65// Note: DirectSolver is a SmootherPrototype that cannot be turned into a smoother using Setup().
66// When this prototype is cloned using Copy(), the clone is an Amesos or an Amesos2 smoother.
67// The clone can be used as a smoother after calling Setup().
68
69namespace MueLu {
70
77 template <class Scalar = SmootherPrototype<>::scalar_type,
81 class DirectSolver : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
82#undef MUELU_DIRECTSOLVER_SHORT
84
85 public:
86
88
89
92 DirectSolver(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
93
95 virtual ~DirectSolver() { }
96
98
100
101
102 void DeclareInput(Level& currentLevel) const;
103
105
107
108
110 void Setup(Level& currentLevel);
111
113 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
114
116
118 void SetFactory(const std::string& varName, const RCP<const FactoryBase>& factory);
119
121 RCP<SmootherPrototype> Copy() const;
122
124
125
127 std::string description() const;
128
129 void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
130
133 if(!s_.is_null())
134 return s_->getNodeSmootherComplexity();
135 else return 0.0;
136 }
137
139
140 private:
141
142 //
143 // Parameters
144 //
145
147 std::string type_;
148
149 //
150 // Underlying Smoother
151 //
152
155 mutable
156 RCP<SmootherPrototype> s_;
157
158 // Records for the case if something goes wrong
161
162 }; // class DirectSolver
163
164} // namespace MueLu
165
166#define MUELU_DIRECTSOLVER_SHORT
167#endif // MUELU_DIRECTSOLVER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that encapsulates direct solvers. Autoselection of AmesosSmoother or Amesos2Smoother according ...
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
DirectSolver cannot be applied. Apply() always returns a RuntimeError exception.
virtual ~DirectSolver()
Destructor.
std::string description() const
Return a simple one-line description of this object.
void Setup(Level &currentLevel)
DirectSolver cannot be turned into a smoother using Setup(). Setup() always returns a RuntimeError ex...
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Custom SetFactory.
RCP< SmootherPrototype > sBelos_
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< SmootherPrototype > sStratimikos_
RCP< SmootherPrototype > s_
RCP< SmootherPrototype > sEpetra_
Smoother.
RCP< SmootherPrototype > sRefMaxwell_
void DeclareInput(Level &currentLevel) const
Input.
std::string type_
amesos1/2-specific key phrase that denote smoother type
RCP< SmootherPrototype > sTpetra_
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for smoother prototypes.
Namespace for MueLu classes and methods.