MueLu Version of the Day
Loading...
Searching...
No Matches
Thyra_MueLuMaxwell1PreconditionerFactory_def.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// MueLu: A package for multigrid based preconditioning
4//
5// Copyright 2012 NTESS and the MueLu contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef THYRA_MUELU_MAXWELL1_PRECONDITIONER_FACTORY_DEF_HPP
11#define THYRA_MUELU_MAXWELL1_PRECONDITIONER_FACTORY_DEF_HPP
12
13#include <list>
14#include "Thyra_MueLuMaxwell1PreconditionerFactory_decl.hpp"
15#include <Xpetra_CrsMatrixWrap.hpp>
16#include <Xpetra_CrsMatrix.hpp>
17#include <Xpetra_Matrix.hpp>
18#include <Xpetra_ThyraUtils.hpp>
19#include <MueLu_Maxwell1.hpp>
20#include <Xpetra_TpetraHalfPrecisionOperator.hpp>
21
22#if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
23
24// This is not as general as possible, but should be good enough for most builds.
25#if ((defined(HAVE_TPETRA_INST_DOUBLE) && defined(HAVE_TPETRA_INST_FLOAT) && !defined(HAVE_TPETRA_INST_COMPLEX_DOUBLE) && !defined(HAVE_TPETRA_INST_COMPLEX_FLOAT)) || \
26 (!defined(HAVE_TPETRA_INST_DOUBLE) && !defined(HAVE_TPETRA_INST_FLOAT) && defined(HAVE_TPETRA_INST_COMPLEX_DOUBLE) && defined(HAVE_TPETRA_INST_COMPLEX_FLOAT)) || \
27 (defined(HAVE_TPETRA_INST_DOUBLE) && defined(HAVE_TPETRA_INST_FLOAT) && defined(HAVE_TPETRA_INST_COMPLEX_DOUBLE) && defined(HAVE_TPETRA_INST_COMPLEX_FLOAT)))
28#define MUELU_CAN_USE_MIXED_PRECISION
29#endif
30
31namespace Thyra {
32
33using Teuchos::ParameterList;
34using Teuchos::RCP;
35using Teuchos::rcp;
36using Teuchos::rcp_const_cast;
37using Teuchos::rcp_dynamic_cast;
38
39// Constructors/initializers/accessors
40
41template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
42MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::MueLuMaxwell1PreconditionerFactory()
43 : paramList_(rcp(new ParameterList())) {}
44
45// Overridden from PreconditionerFactoryBase
46
47template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
48bool MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::isCompatible(const LinearOpSourceBase<Scalar>& fwdOpSrc) const {
49 const RCP<const LinearOpBase<Scalar>> fwdOp = fwdOpSrc.getOp();
50
51 if (Xpetra::ThyraUtils<Scalar, LocalOrdinal, GlobalOrdinal, Node>::isTpetra(fwdOp)) return true;
52
53 return false;
54}
55
56template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
57RCP<PreconditionerBase<Scalar>> MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::createPrec() const {
58 return Teuchos::rcp(new DefaultPreconditioner<Scalar>);
59}
60
61template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
62void MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::
63 initializePrec(const RCP<const LinearOpSourceBase<Scalar>>& fwdOpSrc, PreconditionerBase<Scalar>* prec, const ESupportSolveUse supportSolveUse) const {
64 // we are using typedefs here, since we are using objects from different packages (Xpetra, Thyra,...)
65 typedef Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> XpOp;
66 typedef Xpetra::ThyraUtils<Scalar, LocalOrdinal, GlobalOrdinal, Node> XpThyUtils;
67 typedef Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> XpMat;
68 typedef Thyra::LinearOpBase<Scalar> ThyLinOpBase;
69 typedef Thyra::XpetraLinearOp<Scalar, LocalOrdinal, GlobalOrdinal, Node> ThyXpOp;
70#if defined(MUELU_CAN_USE_MIXED_PRECISION)
71 typedef Xpetra::TpetraHalfPrecisionOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> XpHalfPrecOp;
72 typedef Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> XpMV;
73 typedef typename XpHalfPrecOp::HalfScalar HalfScalar;
74 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType Magnitude;
75 typedef typename Teuchos::ScalarTraits<Magnitude>::halfPrecision HalfMagnitude;
76 typedef Xpetra::MultiVector<HalfScalar, LocalOrdinal, GlobalOrdinal, Node> XphMV;
77 typedef Xpetra::MultiVector<Magnitude, LocalOrdinal, GlobalOrdinal, Node> XpmMV;
78 typedef Xpetra::MultiVector<HalfMagnitude, LocalOrdinal, GlobalOrdinal, Node> XphmMV;
79 typedef Xpetra::Matrix<HalfScalar, LocalOrdinal, GlobalOrdinal, Node> XphMat;
80#endif
81 Teuchos::TimeMonitor tM(*Teuchos::TimeMonitor::getNewTimer(std::string("ThyraMueLuMaxwell1::initializePrec")));
82
83 // Check precondition
84 TEUCHOS_ASSERT(Teuchos::nonnull(fwdOpSrc));
85 TEUCHOS_ASSERT(this->isCompatible(*fwdOpSrc));
86 TEUCHOS_ASSERT(prec);
87
88 // Create a copy, as we may remove some things from the list
89 ParameterList paramList = *paramList_;
90
91 // Retrieve wrapped concrete Xpetra matrix from FwdOp
92 const RCP<const ThyLinOpBase> fwdOp = fwdOpSrc->getOp();
93 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(fwdOp));
94
95 // Check whether it is Epetra/Tpetra
96 bool bIsTpetra = XpThyUtils::isTpetra(fwdOp);
97 TEUCHOS_TEST_FOR_EXCEPT((bIsTpetra == false));
98
99 // wrap the forward operator as an Xpetra::Matrix that MueLu can work with
100 // MueLu needs a non-const object as input
101 RCP<XpMat> A = XpThyUtils::toXpetra(Teuchos::rcp_const_cast<ThyLinOpBase>(fwdOp));
102 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(A));
103
104 // Retrieve concrete preconditioner object
105 const Teuchos::Ptr<DefaultPreconditioner<Scalar>> defaultPrec = Teuchos::ptr(dynamic_cast<DefaultPreconditioner<Scalar>*>(prec));
106 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(defaultPrec));
107
108 // extract preconditioner operator
109 RCP<ThyLinOpBase> thyra_precOp = Teuchos::null;
110 thyra_precOp = rcp_dynamic_cast<Thyra::LinearOpBase<Scalar>>(defaultPrec->getNonconstUnspecifiedPrecOp(), true);
111
112 // make a decision whether to (re)build the multigrid preconditioner or reuse the old one
113 // rebuild preconditioner if startingOver == true
114 // reuse preconditioner if startingOver == false
115 const bool startingOver = (thyra_precOp.is_null() || !paramList.isParameter("Maxwell1: enable reuse") || !paramList.get<bool>("Maxwell1: enable reuse"));
116 const bool useHalfPrecision = paramList.get<bool>("half precision", false) && bIsTpetra;
117
118 RCP<XpOp> xpPrecOp;
119 if (startingOver == true) {
120 // Convert to Xpetra
121 std::list<std::string> convertXpetra = {"Coordinates", "Nullspace", "Kn", "D0"};
122 for (auto it = convertXpetra.begin(); it != convertXpetra.end(); ++it)
123 Converters<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceWithXpetra(paramList, *it);
124
125 std::list<std::string> sublists = {"maxwell1: 11list", "maxwell1: 22list"};
126 for (auto itSublist = sublists.begin(); itSublist != sublists.end(); ++itSublist)
127 if (paramList.isSublist(*itSublist)) {
128 ParameterList& sublist = paramList.sublist(*itSublist);
129 for (int lvlNo = 0; lvlNo < 10; ++lvlNo) {
130 if (sublist.isSublist("level " + std::to_string(lvlNo) + " user data")) {
131 ParameterList& lvlList = sublist.sublist("level " + std::to_string(lvlNo) + " user data");
132 std::list<std::string> convertKeys;
133 for (auto it = lvlList.begin(); it != lvlList.end(); ++it)
134 convertKeys.push_back(lvlList.name(it));
135 for (auto it = convertKeys.begin(); it != convertKeys.end(); ++it)
136 Converters<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceWithXpetra(lvlList, *it);
137 }
138 }
139 }
140
141 ParameterList& sublist = paramList.sublist("maxwell1: 11list");
142 if (sublist.isParameter("D0")) {
143 Converters<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceWithXpetra(sublist, "D0");
144 }
145
146 paramList.set<bool>("Maxwell1: use as preconditioner", true);
147 if (useHalfPrecision) {
148#if defined(MUELU_CAN_USE_MIXED_PRECISION)
149
150 // convert to half precision
151 RCP<XphMat> halfA = Xpetra::convertToHalfPrecision(A);
152 if (paramList.isType<RCP<XpmMV>>("Coordinates")) {
153 RCP<XpmMV> coords = paramList.get<RCP<XpmMV>>("Coordinates");
154 paramList.remove("Coordinates");
155 RCP<XphmMV> halfCoords = Xpetra::convertToHalfPrecision(coords);
156 paramList.set("Coordinates", halfCoords);
157 }
158 if (paramList.isType<RCP<XpMV>>("Nullspace")) {
159 RCP<XpMV> nullspace = paramList.get<RCP<XpMV>>("Nullspace");
160 paramList.remove("Nullspace");
161 RCP<XphMV> halfNullspace = Xpetra::convertToHalfPrecision(nullspace);
162 paramList.set("Nullspace", halfNullspace);
163 }
164 std::list<std::string> convertMat = {"Kn", "D0"};
165 for (auto it = convertMat.begin(); it != convertMat.end(); ++it) {
166 if (paramList.isType<RCP<XpMat>>(*it)) {
167 RCP<XpMat> M = paramList.get<RCP<XpMat>>(*it);
168 paramList.remove(*it);
169 RCP<XphMat> halfM = Xpetra::convertToHalfPrecision(M);
170 paramList.set(*it, halfM);
171 }
172 }
173
174 // build a new half-precision MueLu Maxwell1 preconditioner
175 RCP<MueLu::Maxwell1<HalfScalar, LocalOrdinal, GlobalOrdinal, Node>> halfPrec = rcp(new MueLu::Maxwell1<HalfScalar, LocalOrdinal, GlobalOrdinal, Node>(halfA, paramList, true));
176 xpPrecOp = rcp(new XpHalfPrecOp(halfPrec));
177#else
178 TEUCHOS_TEST_FOR_EXCEPT(true);
179#endif
180 } else {
181 // build a new MueLu Maxwell1 preconditioner
182 RCP<MueLu::Maxwell1<Scalar, LocalOrdinal, GlobalOrdinal, Node>> preconditioner = rcp(new MueLu::Maxwell1<Scalar, LocalOrdinal, GlobalOrdinal, Node>(A, paramList, true));
183 xpPrecOp = rcp_dynamic_cast<XpOp>(preconditioner);
184 }
185 } else {
186 // reuse old MueLu preconditioner stored in MueLu Xpetra operator and put in new matrix
187
188 RCP<ThyXpOp> thyXpOp = rcp_dynamic_cast<ThyXpOp>(thyra_precOp, true);
189 RCP<XpOp> xpOp = thyXpOp->getXpetraOperator();
190#if defined(MUELU_CAN_USE_MIXED_PRECISION)
191 RCP<XpHalfPrecOp> xpHalfPrecOp = rcp_dynamic_cast<XpHalfPrecOp>(xpOp);
192 if (!xpHalfPrecOp.is_null()) {
193 RCP<MueLu::Maxwell1<HalfScalar, LocalOrdinal, GlobalOrdinal, Node>> preconditioner = rcp_dynamic_cast<MueLu::Maxwell1<HalfScalar, LocalOrdinal, GlobalOrdinal, Node>>(xpHalfPrecOp->GetHalfPrecisionOperator(), true);
194 RCP<XphMat> halfA = Xpetra::convertToHalfPrecision(A);
195 preconditioner->resetMatrix(halfA);
196 xpPrecOp = rcp_dynamic_cast<XpOp>(preconditioner);
197 } else
198#endif
199 {
200 RCP<MueLu::Maxwell1<Scalar, LocalOrdinal, GlobalOrdinal, Node>> preconditioner = rcp_dynamic_cast<MueLu::Maxwell1<Scalar, LocalOrdinal, GlobalOrdinal, Node>>(xpOp, true);
201 preconditioner->resetMatrix(A);
202 xpPrecOp = rcp_dynamic_cast<XpOp>(preconditioner);
203 }
204 }
205
206 // wrap preconditioner in thyraPrecOp
207 RCP<const VectorSpaceBase<Scalar>> thyraRangeSpace = Xpetra::ThyraUtils<Scalar, LocalOrdinal, GlobalOrdinal, Node>::toThyra(xpPrecOp->getRangeMap());
208 RCP<const VectorSpaceBase<Scalar>> thyraDomainSpace = Xpetra::ThyraUtils<Scalar, LocalOrdinal, GlobalOrdinal, Node>::toThyra(xpPrecOp->getDomainMap());
209
210 RCP<ThyLinOpBase> thyraPrecOp = Thyra::xpetraLinearOp<Scalar, LocalOrdinal, GlobalOrdinal, Node>(thyraRangeSpace, thyraDomainSpace, xpPrecOp);
211 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(thyraPrecOp));
212
213 defaultPrec->initializeUnspecified(thyraPrecOp);
214}
215
216template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
217void MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::
218 uninitializePrec(PreconditionerBase<Scalar>* prec, RCP<const LinearOpSourceBase<Scalar>>* fwdOp, ESupportSolveUse* supportSolveUse) const {
219 TEUCHOS_ASSERT(prec);
220
221 // Retrieve concrete preconditioner object
222 const Teuchos::Ptr<DefaultPreconditioner<Scalar>> defaultPrec = Teuchos::ptr(dynamic_cast<DefaultPreconditioner<Scalar>*>(prec));
223 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(defaultPrec));
224
225 if (fwdOp) {
226 // TODO: Implement properly instead of returning default value
227 *fwdOp = Teuchos::null;
228 }
229
230 if (supportSolveUse) {
231 // TODO: Implement properly instead of returning default value
232 *supportSolveUse = Thyra::SUPPORT_SOLVE_UNSPECIFIED;
233 }
234
235 defaultPrec->uninitialize();
236}
237
238// Overridden from ParameterListAcceptor
239template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
240void MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::setParameterList(RCP<ParameterList> const& paramList) {
241 TEUCHOS_TEST_FOR_EXCEPT(Teuchos::is_null(paramList));
242 paramList_ = paramList;
243}
244
245template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
246RCP<ParameterList> MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getNonconstParameterList() {
247 return paramList_;
248}
249
250template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
251RCP<ParameterList> MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::unsetParameterList() {
252 RCP<ParameterList> savedParamList = paramList_;
253 paramList_ = Teuchos::null;
254 return savedParamList;
255}
256
257template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
258RCP<const ParameterList> MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getParameterList() const {
259 return paramList_;
260}
261
262template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
263RCP<const ParameterList> MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getValidParameters() const {
264 static RCP<const ParameterList> validPL;
265
266 if (Teuchos::is_null(validPL))
267 validPL = rcp(new ParameterList());
268
269 return validPL;
270}
271
272// Public functions overridden from Teuchos::Describable
273template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
274std::string MueLuMaxwell1PreconditionerFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::description() const {
275 return "Thyra::MueLuMaxwell1PreconditionerFactory";
276}
277} // namespace Thyra
278
279#endif // HAVE_MUELU_STRATIMIKOS
280
281#endif // ifdef THYRA_MUELU_MAXWELL1_PRECONDITIONER_FACTORY_DEF_HPP
Thyra_MueLuMaxwell1PreconditionerFactory_decl.hpp
MueLu::Maxwell1
Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form.
Definition MueLu_Maxwell1_decl.hpp:46
Thyra::XpetraLinearOp
Concrete Thyra::LinearOpBase subclass for Xpetra::Operator.
Definition Thyra_XpetraLinearOp_decl.hpp:28