MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_SmootherBase.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_SMOOTHERBASE_HPP
47#define MUELU_SMOOTHERBASE_HPP
48
49#include "Xpetra_MultiVector.hpp"
50
51#include "MueLu_ConfigDefs.hpp"
52#include "MueLu_BaseClass.hpp"
53
54namespace MueLu {
64 template <class Scalar = DefaultScalar,
67 class Node = DefaultNode>
68 class SmootherBase : public virtual BaseClass {
69 public:
73 typedef Node node_type;
74
75 private:
76
77#undef MUELU_SMOOTHERBASE_SHORT
79
80 public:
83
84 virtual ~SmootherBase() {}
86
88
89
91 virtual void Apply(MultiVector& x, const MultiVector& rhs, bool InitialGuessIsZero = false) const = 0;
92
94 virtual size_t getNodeSmootherComplexity() const= 0;
95
96 void declareConstructionOutcome(bool fail, std::string msg) {
98 if (!fail)
100 else
102 };
105
107
108 private:
111
112 }; //class SmootherBase
113} //namespace MueLu
114
115#define MUELU_SMOOTHERBASE_SHORT
116
117#endif //ifndef MUELU_SMOOTHERBASE_HPP
118
119// SmootherBase = Interface used by Hierarchy.Iterate(). Minimal condition to be used as smoother.
120// SmootherPrototype = minimal interface used by the generic SmootherFactory.
121// Note that one can implements and use his own SmootherFactory. In this case, SmootherBase is enough.
122// AdvSmootherPrototype = for more complex case of reusing setup between presmoother and postsmoother
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Base class for MueLu classes.
Base class for smoothers.
void declareConstructionOutcome(bool fail, std::string msg)
LocalOrdinal local_ordinal_type
virtual void Apply(MultiVector &x, const MultiVector &rhs, bool InitialGuessIsZero=false) const =0
Apply smoother.
std::string constructionErrorMsg()
GlobalOrdinal global_ordinal_type
virtual size_t getNodeSmootherComplexity() const =0
Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::Ordinal...
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar