MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_SchurComplementFactory_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_SchurComplementFactory_decl.hpp
48 *
49 * Created on: Jun 18, 2012
50 * Author: wiesner
51 */
52
53#ifndef MUELU_SCHURCOMPLEMENTFACTORY_DECL_HPP_
54#define MUELU_SCHURCOMPLEMENTFACTORY_DECL_HPP_
55
56#include "MueLu_ConfigDefs.hpp"
57
58#include <Teuchos_ParameterList.hpp>
59
60#include <Xpetra_CrsMatrix_fwd.hpp>
61#include <Xpetra_CrsMatrixWrap_fwd.hpp>
62#include <Xpetra_MapExtractor_fwd.hpp>
63#include <Xpetra_Map_fwd.hpp>
64#include <Xpetra_StridedMap_fwd.hpp>
65
66
71#include "MueLu_SmootherPrototype.hpp"
73
74
75namespace MueLu {
76
111 template <class Scalar = DefaultScalar,
114 class Node = DefaultNode>
116#undef MUELU_SCHURCOMPLEMENTFACTORY_SHORT
117 #include "MueLu_UseShortNames.hpp"
118
119 public:
121
122
125
127
128
129 void DeclareInput(Level& currentLevel) const;
130
131 RCP<const ParameterList> GetValidParameterList() const;
132
134
136
137
139 void Build(Level& currentLevel) const;
140
142
143
144 private:
146 RCP<Matrix> ComputeSchurComplement(RCP<BlockedCrsMatrix>& bA, RCP<Matrix>& Ainv) const;
147
148 }; // class SchurComplementFactory
149
150} // namespace MueLu
151
152#define MUELU_SCHURCOMPLEMENTFACTORY_SHORT
153#endif /* MUELU_SCHURCOMPLEMENTFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Factory for building the Schur Complement for a 2x2 block matrix.
SchurComplementFactory()=default
Constructor.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Input.
void Build(Level &currentLevel) const
Build an object with this factory.
RCP< Matrix > ComputeSchurComplement(RCP< BlockedCrsMatrix > &bA, RCP< Matrix > &Ainv) const
Schur complement calculation method.
Base class for factories that use one level (currentLevel).
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar