MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_RefMaxwellSmoother_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_REFMAXWELLSMOOTHER_DECL_HPP
47#define MUELU_REFMAXWELLSMOOTHER_DECL_HPP
48
49#include <Teuchos_ParameterList.hpp>
50
51#include <Xpetra_Matrix_fwd.hpp>
52
53#include "MueLu_ConfigDefs.hpp"
54
56
59#include "MueLu_Level_fwd.hpp"
60#include "MueLu_SmootherPrototype.hpp"
61#include "MueLu_RefMaxwell.hpp"
62
63
64namespace MueLu {
65
73 template <class Scalar = SmootherPrototype<>::scalar_type,
77 class RefMaxwellSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
78#undef MUELU_REFMAXWELLSMOOTHER_SHORT
80
81 public:
82
84
85
92 RefMaxwellSmoother(const std::string type, const Teuchos::ParameterList& paramList);
93
95 virtual ~RefMaxwellSmoother() = default;
96
98
99 void SetParameterList(const Teuchos::ParameterList& paramList);
100
102
103
104 void DeclareInput(Level &currentLevel) const;
105
107
109
110
116 void Setup(Level &currentLevel);
117
126 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
127
129
131
132
133 RCP<SmootherPrototype> Copy() const;
134
136
138
139
141 std::string description() const;
142
144 //using MueLu::Describable::describe; // overloading, not hiding
145 //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
146 void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
147
149
151 size_t getNodeSmootherComplexity() const;
152
153 private:
154 void SetupRefMaxwell(Level& currentLevel);
155
156 private:
157
158 std::string type_;
160
162 RCP<Operator> op_;
163
164 }; // class RefMaxwellSmoother
165
166} // namespace MueLu
167
168#define MUELU_REFMAXWELLSMOOTHER_SHORT
169#endif // MUELU_REFMAXWELLSMOOTHER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Class that encapsulates Operator smoothers.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
void SetupRefMaxwell(Level &currentLevel)
void Setup(Level &currentLevel)
Set up the smoother.
RCP< Operator > op_
matrix, used in apply if solving residual equation
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameters from a parameter list and return with default values.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void DeclareInput(Level &currentLevel) const
Input.
std::string description() const
Return a simple one-line description of this object.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the preconditioner.
RCP< SmootherPrototype > Copy() const
virtual ~RefMaxwellSmoother()=default
Destructor.
Base class for smoother prototypes.
Namespace for MueLu classes and methods.