MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_MergedSmoother_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_MERGEDSMOOTHER_DECL_HPP
47#define MUELU_MERGEDSMOOTHER_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
51#include "MueLu_SmootherPrototype.hpp"
52
57namespace MueLu {
58
59 class Level;
60
61 template <class Scalar = SmootherPrototype<>::scalar_type,
65 class MergedSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
66#undef MUELU_MERGEDSMOOTHER_SHORT
68
69 public:
71
72
74 MergedSmoother(ArrayRCP<RCP<SmootherPrototype> >& smootherList, bool verbose = false);
75
78
80 RCP<SmootherPrototype> Copy() const;
81
83 virtual ~MergedSmoother() { }
85
87
88
89 void StandardOrder() { reverseOrder_ = false; }
90 void ReverseOrder() { reverseOrder_ = true; }
91
92 // TODO: GetOrder() is a better name (+ enum to define order)
93 bool GetReverseOrder() const { return reverseOrder_; }
94
95 // TODO const ArrayRCP<const RCP<const SmootherPrototype> > & GetSmootherList() const;
96 const ArrayRCP<const RCP<SmootherPrototype> > GetSmootherList() const { return smootherList_; }
97
99
100 void DeclareInput(Level &currentLevel) const;
101
103
104
106 void Setup(Level& level);
107
116 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
117
119
121 void SetFactory(const std::string& varName, const RCP<const FactoryBase>& factory);
122
123 void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
124
125 void CopyParameters(RCP<SmootherPrototype> src); // TODO: wrong prototype. We do not need an RCP here.
126
127 ArrayRCP<RCP<SmootherPrototype> > SmootherListDeepCopy(const ArrayRCP<const RCP<SmootherPrototype> >& srcSmootherList);
128
130 size_t getNodeSmootherComplexity() const;
131
133
134 private:
135 // List of smoothers. It is an ArrayRCP of RCP because:
136 // 1) I need a vector of pointers (to avoid slicing problems)
137 // 2) I can use an std::vector insead of an ArrayRCP but then the constructor will do a copy of user input
138 ArrayRCP<RCP<SmootherPrototype> > smootherList_;
139
140 //
142
143 // tmp, for debug
145
146 }; //class MergedSmoother
147
148} //namespace MueLu
149
150#define MUELU_MERGEDSMOOTHER_SHORT
151#endif // MUELU_MERGEDSMOOTHER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< SmootherPrototype > Copy() const
Copy method (performs a deep copy of input object)
virtual ~MergedSmoother()
Destructor.
void DeclareInput(Level &currentLevel) const
Input.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
ArrayRCP< RCP< SmootherPrototype > > smootherList_
ArrayRCP< RCP< SmootherPrototype > > SmootherListDeepCopy(const ArrayRCP< const RCP< SmootherPrototype > > &srcSmootherList)
void Setup(Level &level)
Set up.
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Custom SetFactory.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply.
MergedSmoother(ArrayRCP< RCP< SmootherPrototype > > &smootherList, bool verbose=false)
Constructor.
void CopyParameters(RCP< SmootherPrototype > src)
const ArrayRCP< const RCP< SmootherPrototype > > GetSmootherList() const
Base class for smoother prototypes.
Namespace for MueLu classes and methods.