MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AdvSmootherPrototype.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_ADVSMOOTHERPROTOTYPE_HPP
47#define MUELU_ADVSMOOTHERPROTOTYPE_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50#include "MueLu_SmootherPrototype.hpp"
51
52namespace MueLu {
53
54 class Level;
55
65 template <class Scalar = SmootherPrototype<>::scalar_type,
69 class AdvSmootherPrototype : public SmootherPrototypex<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
70#undef MUELU_ADVSMOOTHERPROTOTYPE_HPP
72
73 public:
75
77 : type_("undefined")
78 {}
79
82
84
85
86 virtual void CopyParameters(const AdvSmootherPrototype& smootherPrototype) = 0;
87
89
91
92
94 std::string GetType() const { return type_; }
95
99 //TODO: remove, type_ should be const
100 void SetType(std::string & type) { type_ = type; }
101
103
104 private:
105 std::string type_;
106
107 }; //class AdvSmootherPrototype
108
109} //namespace MueLu
110
111#define MUELU_ADVSMOOTHERPROTOTYPE_SHORT
112
113#endif //ifndef MUELU_ADVSMOOTHERPROTOTYPE_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
void SetType(std::string &type)
Set the smoother type. This method must be called by constructors of derived classes.
std::string GetType() const
Get the smoother type.
virtual void CopyParameters(const AdvSmootherPrototype &smootherPrototype)=0
AdvSmootherPrototype()
@nameConstructors/Destructors.
Namespace for MueLu classes and methods.