MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_IndefBlockedDiagonalSmoother_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/*
47 * MueLu_IndefBlockedDiagonalSmoother_decl.hpp
48 *
49 * Created on: 13 May 2014
50 * Author: wiesner
51 */
52
53#ifndef MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_DECL_HPP_
54#define MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_DECL_HPP_
55
56
57#include "MueLu_ConfigDefs.hpp"
58
59#include <Teuchos_ParameterList.hpp>
60
61//Xpetra
62#include <Xpetra_MapExtractor_fwd.hpp>
63#include <Xpetra_MultiVectorFactory_fwd.hpp>
64#include <Xpetra_CrsMatrixWrap_fwd.hpp>
65#include <Xpetra_Matrix_fwd.hpp>
66
67//MueLu
69#include "MueLu_SmootherPrototype.hpp"
75
80
81namespace MueLu {
82
93 template <class Scalar = SmootherPrototype<>::scalar_type,
98 public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
99 {
100 typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
101
102#undef MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_SHORT
104
105 public:
106
108
109
113
117
119
120
121 RCP<const ParameterList> GetValidParameterList() const;
122
123 void DeclareInput(Level &currentLevel) const;
124
126 void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos = 0);
127
129
131
132
135 void Setup(Level &currentLevel);
136
142 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
144
145 RCP<SmootherPrototype> Copy() const;
146
148
149
151 std::string description() const;
152
154 //using MueLu::Describable::describe; // overloading, not hiding
155 void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
156
158 size_t getNodeSmootherComplexity() const;
159
161
162 private:
163
165 std::string type_;
166
167 RCP<const FactoryBase> AFact_;
168
170 RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
171 RCP<Matrix> F_;
172 RCP<Matrix> Z_;
173
174 RCP<const MapExtractorClass> rangeMapExtractor_;
175 RCP<const MapExtractorClass> domainMapExtractor_;
176
178 Teuchos::RCP<SmootherBase> velPredictSmoo_;
179 Teuchos::RCP<SmootherBase> schurCompSmoo_;
180
182
187 std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
188 };
189
190} // namespace MueLu
191
192#define MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_SHORT
193
194#endif /* MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Cheap Blocked diagonal smoother for indefinite 2x2 block matrices.
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
RCP< Matrix > Z_
pressure stabilization term or null block
std::string description() const
Return a simple one-line description of this object.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos=0)
Add a factory manager for BraessSarazin internal SchurComplement handling.
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
Teuchos::RCP< SmootherBase > schurCompSmoo_
smoother for SchurComplement equation
Teuchos::RCP< SmootherBase > velPredictSmoo_
Block smoothers.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
RCP< const ParameterList > GetValidParameterList() const
Input.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
vector of factory managers
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for smoother prototypes.
Namespace for MueLu classes and methods.