1 #ifndef MUELU_CREATE_TPETRA_PRECONDITIONER_HPP 2 #define MUELU_CREATE_TPETRA_PRECONDITIONER_HPP 7 #include <Teuchos_XMLParameterListHelpers.hpp> 8 #include <Tpetra_Operator.hpp> 9 #include <Tpetra_RowMatrix.hpp> 10 #include <Xpetra_TpetraBlockCrsMatrix.hpp> 11 #include <Tpetra_Experimental_BlockCrsMatrix.hpp> 12 #include <Xpetra_CrsMatrix.hpp> 13 #include <Xpetra_MultiVector.hpp> 14 #include <Xpetra_MultiVectorFactory.hpp> 19 #include <MueLu_Hierarchy.hpp> 21 #include <MueLu_MLParameterListInterpreter.hpp> 22 #include <MueLu_ParameterListInterpreter.hpp> 23 #include <MueLu_TpetraOperator.hpp> 25 #include <MueLu_Utilities.hpp> 26 #include <MueLu_HierarchyUtils.hpp> 29 #if defined(HAVE_MUELU_AMGX) 32 #include "cuda_runtime.h" 46 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
47 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
49 Teuchos::ParameterList& inParamList,
50 Teuchos::ParameterList& dummyList)
53 typedef LocalOrdinal LO;
54 typedef GlobalOrdinal GO;
57 using Teuchos::ParameterList;
59 typedef Xpetra::MultiVector<SC,LO,GO,NO> MultiVector;
60 typedef Xpetra::Matrix<SC,LO,GO,NO> Matrix;
62 typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> crs_matrix_type;
63 typedef Tpetra::Experimental::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> block_crs_matrix_type;
65 #if defined(HAVE_MUELU_AMGX) 66 std::string externalMG =
"use external multigrid package";
67 if (inParamList.isParameter(externalMG) && inParamList.get<std::string>(externalMG) ==
"amgx"){
68 const RCP<crs_matrix_type> constCrsA = rcp_dynamic_cast<crs_matrix_type>(inA);
69 TEUCHOS_TEST_FOR_EXCEPTION(constCrsA == Teuchos::null,
Exceptions::RuntimeError,
"CreateTpetraPreconditioner: failed to dynamic cast to Tpetra::CrsMatrix, which is required to be able to use AmgX.");
76 RCP<block_crs_matrix_type> bcrsA = rcp_dynamic_cast<block_crs_matrix_type>(inA);
77 RCP<crs_matrix_type> crsA = rcp_dynamic_cast<crs_matrix_type>(inA);
78 if (crsA != Teuchos::null)
79 A = TpetraCrs_To_XpetraMatrix<SC,LO,GO,NO>(crsA);
80 else if (bcrsA != Teuchos::null) {
81 RCP<Xpetra::CrsMatrix<SC,LO,GO,NO> > temp = rcp(
new Xpetra::TpetraBlockCrsMatrix<SC,LO,GO,NO>(bcrsA));
82 TEUCHOS_TEST_FOR_EXCEPTION(temp==Teuchos::null,
Exceptions::RuntimeError,
"CreateTpetraPreconditioner: cast from Tpetra::Experimental::BlockCrsMatrix to Xpetra::TpetraBlockCrsMatrix failed.");
83 A = rcp(
new Xpetra::CrsMatrixWrap<SC,LO,GO,NO>(temp));
86 TEUCHOS_TEST_FOR_EXCEPTION(
true,
Exceptions::RuntimeError,
"CreateTpetraPreconditioner: only Tpetra CrsMatrix and BlockCrsMatrix types are supported.");
89 Teuchos::ParameterList& userList = inParamList.sublist(
"user data");
90 if (userList.isParameter(
"Coordinates")) {
91 RCP<Xpetra::MultiVector<double,LO,GO,NO> > coordinates = Teuchos::null;
93 coordinates = TpetraMultiVector_To_XpetraMultiVector<double,LO,GO,NO>(userList.get<RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node> > >(
"Coordinates"));
94 }
catch(Teuchos::Exceptions::InvalidParameterType) {
95 coordinates = userList.get<RCP<Xpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node> > >(
"Coordinates");
97 userList.set<RCP<Xpetra::MultiVector<double,LO,GO,NO> > >(
"Coordinates", coordinates);
100 if (userList.isParameter(
"Nullspace")) {
101 RCP<MultiVector> nullspace = Teuchos::null;
103 nullspace = TpetraMultiVector_To_XpetraMultiVector<SC,LO,GO,NO>(userList.get<RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> > >(
"Nullspace"));
104 }
catch(Teuchos::Exceptions::InvalidParameterType) {
105 nullspace = userList.get<RCP<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> > >(
"Nullspace");
107 userList.set<RCP<MultiVector> >(
"Nullspace", nullspace);
110 RCP<Hierarchy> H = MueLu::CreateXpetraPreconditioner<SC,LO,GO,NO>(A,inParamList,inParamList);
124 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
125 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
127 Teuchos::ParameterList& inParamList,
128 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
129 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
132 typedef LocalOrdinal LO;
133 typedef GlobalOrdinal GO;
136 using Teuchos::ParameterList;
142 Teuchos::ParameterList& userList = inParamList.sublist(
"user data");
143 if (inCoords != Teuchos::null) {
144 userList.set<RCP<Tpetra::MultiVector<double,LO,GO,NO> > >(
"Coordinates", inCoords);
146 if (inNullspace != Teuchos::null) {
147 userList.set<RCP<Tpetra::MultiVector<SC,LO,GO,NO> > >(
"Nullspace", inNullspace);
150 return CreateTpetraPreconditioner<SC,LO,GO,NO>(inA,inParamList,inParamList);
166 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
168 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
170 Teuchos::ParameterList& inParamList,
171 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
172 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
174 RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>> opMat(inA);
175 return CreateTpetraPreconditioner<Scalar, LocalOrdinal, GlobalOrdinal, Node>(opMat, inParamList, inCoords, inNullspace);
190 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
192 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
194 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
195 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
197 Teuchos::ParameterList paramList;
198 RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>> opMat(inA);
199 return CreateTpetraPreconditioner<Scalar, LocalOrdinal, GlobalOrdinal, Node>(opMat, paramList, inCoords, inNullspace);
215 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
217 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
219 const std::string& xmlFileName,
220 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
221 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
223 Teuchos::ParameterList paramList;
224 Teuchos::updateParametersFromXmlFileAndBroadcast(xmlFileName, Teuchos::Ptr<Teuchos::ParameterList>(¶mList), *inA->getComm());
226 RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>> opMat(inA);
227 return CreateTpetraPreconditioner<Scalar, LocalOrdinal, GlobalOrdinal, Node>(opMat, paramList, inCoords, inNullspace);
241 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
242 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
244 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
245 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
247 Teuchos::ParameterList paramList;
248 return CreateTpetraPreconditioner<Scalar, LocalOrdinal, GlobalOrdinal, Node>(inA, paramList, inCoords, inNullspace);
263 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
264 Teuchos::RCP<MueLu::TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
266 const std::string& xmlFileName,
267 const Teuchos::RCP<Tpetra::MultiVector<double, LocalOrdinal, GlobalOrdinal, Node>>& inCoords = Teuchos::null,
268 const Teuchos::RCP<Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& inNullspace = Teuchos::null)
270 Teuchos::ParameterList paramList;
271 Teuchos::updateParametersFromXmlFileAndBroadcast(xmlFileName, Teuchos::Ptr<Teuchos::ParameterList>(¶mList), *inA->getDomainMap()->getComm());
272 return CreateTpetraPreconditioner<Scalar, LocalOrdinal, GlobalOrdinal, Node>(inA, paramList, inCoords, inNullspace);
283 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
287 typedef LocalOrdinal LO;
288 typedef GlobalOrdinal GO;
291 typedef Xpetra::Matrix<SC,LO,GO,NO> Matrix;
292 typedef MueLu ::Hierarchy<SC,LO,GO,NO>
Hierarchy;
295 RCP<Matrix> A = TpetraCrs_To_XpetraMatrix<SC,LO,GO,NO>(inA);
297 MueLu::ReuseXpetraPreconditioner<SC,LO,GO,NO>(A, H);
302 #endif //ifndef MUELU_CREATE_TPETRA_PRECONDITIONER_HPP Various adapters that will create a MueLu preconditioner that is an Xpetra::Matrix.
Namespace for MueLu classes and methods.
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetHierarchy() const
Direct access to the underlying MueLu::Hierarchy.
Teuchos::RCP< MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > CreateTpetraPreconditioner(const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA, Teuchos::ParameterList &inParamList, Teuchos::ParameterList &dummyList)
Helper function to create a MueLu or AMGX preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner.
Wraps an existing MueLu::Hierarchy as a Tpetra::Operator.
void ReuseTpetraPreconditioner(const Teuchos::RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA, MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op)
Helper function to reuse an existing MueLu preconditioner.
Exception throws to report errors in the internal logical of the program.
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
Adapter for AmgX library from Nvidia.