MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_CoupledRBMFactory_decl.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// MueLu: A package for multigrid based preconditioning
6// Copyright 2013 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_COUPLEDRBMFACTORY_DECL_HPP
47#define MUELU_COUPLEDRBMFACTORY_DECL_HPP
48
49#include <Xpetra_Matrix_fwd.hpp>
50#include <Xpetra_MultiVectorFactory_fwd.hpp>
51#include <Xpetra_VectorFactory_fwd.hpp>
52
53#include "MueLu_ConfigDefs.hpp"
56
57#include "MueLu_Level_fwd.hpp"
58
59namespace MueLu {
60
70 template <class Scalar = DefaultScalar,
73 class Node = DefaultNode>
75#undef MUELU_COUPLEDRBMFACTORY_SHORT
77
78 public:
80
81
82 CoupledRBMFactory(const int numPDEs)
83 : nspName_("Nullspace"),
84 numPDEs_(numPDEs)
85 { }
87 CoupledRBMFactory(const std::string & nspName = "Nullspace")
88 : nspName_(nspName),
89 numPDEs_(3)
90 { }
91
93 virtual ~CoupledRBMFactory();
94
96
98
99
105 void DeclareInput(Level &currentLevel) const;
106
108
110
111
113 void Build(Level &currentLevel) const;
114
115 void BuildRBM(RCP<Matrix>& A, RCP<MultiVector>& Coords, RCP<MultiVector>& nullspace) const;
116
118 void setNumPDEs(int numPDEs) {
119 numPDEs_=numPDEs;
120 }
121
122 void setLastAcousticDOF(int lastDOF) {
123 lastAcousticDOF_=lastDOF;
124 }
125
126 private:
127
129 std::string nspName_;
130
132
134
135 }; // class CoupledRBMFactory
136
137} // namespace MueLu
138
139#define MUELU_COUPLEDRBMFACTORY_SHORT
140#endif // MUELU_COUPLEDRBMFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Nullspace Factory for coupled acoustic-elastic problems.
std::string nspName_
name of nullspace vector on finest level
void BuildRBM(RCP< Matrix > &A, RCP< MultiVector > &Coords, RCP< MultiVector > &nullspace) const
CoupledRBMFactory(const int numPDEs)
Constructor.
void Build(Level &currentLevel) const
Build an object with this factory.
CoupledRBMFactory(const std::string &nspName="Nullspace")
Constructor.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
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