MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_BlockedDirectSolver_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_BlockedDirectSolver_decl.hpp
48 *
49 * Created on: 09.02.2014
50 * Author: tobias
51 */
52
53#ifndef MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_
54#define MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_
55
56#include "MueLu_ConfigDefs.hpp"
57
58#include <Teuchos_ParameterList.hpp>
59
60#include <Xpetra_MapExtractor_fwd.hpp>
61
63#include "MueLu_SmootherPrototype.hpp"
70
71namespace MueLu {
72
81 template <class Scalar = SmootherPrototype<>::scalar_type,
85 class BlockedDirectSolver : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
86 {
87 typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
88
89#undef MUELU_BLOCKEDDIRECTSOLVER_SHORT
91
92 public:
93
95
96
100
104
106
107 RCP<const ParameterList> GetValidParameterList() const;
108
109 void DeclareInput(Level &currentLevel) const;
111
113
114
118 void Setup(Level &currentLevel);
119
126 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
128
129 RCP<SmootherPrototype> Copy() const;
130
132
133
135 std::string description() const;
136
138 //using MueLu::Describable::describe; // overloading, not hiding
139 void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
140
142 size_t getNodeSmootherComplexity() const;
143
145
146 private:
147
149 std::string type_;
150
152 RCP<MergedBlockedMatrixFactory> MergedAFact_;
153
155 RCP<DirectSolver> s_; // solver object
156
158 RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
159
160 }; // class BlockedDirectSolver
161
162} // namespace MueLu
163
164#define MUELU_BLOCKEDDIRECTSOLVER_SHORT
165
166#endif /* MUELU_BLOCKEDDIRECTSOLVER_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
direct solver for nxn blocked matrices
void Setup(Level &currentLevel)
Setup routine Call the underlaying Setup routine of the nested direct solver once the input block mat...
RCP< const ParameterList > GetValidParameterList() const
Input.
void DeclareInput(Level &currentLevel) const
Input.
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
RCP< DirectSolver > s_
Direct solver.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the direct solver. Solves the linear system AX=B using the constructed solver.
std::string description() const
Return a simple one-line description of this object.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
RCP< MergedBlockedMatrixFactory > MergedAFact_
Factory to generate merged block matrix.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< SmootherPrototype > Copy() const
Class that holds all level-specific information.
Base class for smoother prototypes.
Namespace for MueLu classes and methods.