MueLu  Version of the Day
Thyra_MueLuPreconditionerFactory_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 // Tobias Wiesner (tawiesn@sandia.gov)
43 //
44 // ***********************************************************************
45 //
46 // @HEADER
47 #ifndef THYRA_MUELU_PRECONDITIONER_FACTORY_DECL_HPP
48 #define THYRA_MUELU_PRECONDITIONER_FACTORY_DECL_HPP
49 
50 #include <MueLu_ConfigDefs.hpp>
51 
52 #if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
53 
54 // Stratimikos needs Thyra, so we don't need special guards for Thyra here
55 #include "Thyra_DefaultPreconditioner.hpp"
56 #include "Thyra_BlockedLinearOpBase.hpp"
57 #include "Thyra_DiagonalLinearOpBase.hpp"
58 #include "Thyra_XpetraLinearOp.hpp"
59 #ifdef HAVE_MUELU_TPETRA
60 #include "Thyra_TpetraLinearOp.hpp"
61 #include "Thyra_TpetraThyraWrappers.hpp"
62 #endif
63 #ifdef HAVE_MUELU_EPETRA
64 #include "Thyra_EpetraLinearOp.hpp"
65 #endif
66 
67 #include "Teuchos_Ptr.hpp"
68 #include "Teuchos_TestForException.hpp"
69 #include "Teuchos_Assert.hpp"
70 #include "Teuchos_Time.hpp"
71 
72 #include <Xpetra_CrsMatrixWrap.hpp>
73 #include <Xpetra_CrsMatrix.hpp>
74 #include <Xpetra_Matrix.hpp>
75 #include <Xpetra_ThyraUtils.hpp>
76 
77 #include <MueLu_Hierarchy.hpp>
79 #include <MueLu_HierarchyUtils.hpp>
80 #include <MueLu_Utilities.hpp>
81 #include <MueLu_ParameterListInterpreter.hpp>
82 #include <MueLu_MLParameterListInterpreter.hpp>
83 #include <MueLu_MasterList.hpp>
84 #include <MueLu_XpetraOperator_decl.hpp> // todo fix me
86 #ifdef HAVE_MUELU_TPETRA
87 #include <MueLu_TpetraOperator.hpp>
88 #include <Xpetra_TpetraHalfPrecisionOperator.hpp>
89 #endif
90 #ifdef HAVE_MUELU_EPETRA
91 #include <MueLu_EpetraOperator.hpp>
92 #endif
93 
94 #include "Thyra_PreconditionerFactoryBase.hpp"
95 
96 #include "Kokkos_DefaultNode.hpp"
97 
98 #include <list>
99 
100 namespace Thyra {
101 
102  using Teuchos::RCP;
103  using Teuchos::rcp;
104 
105  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
106  static bool replaceWithXpetra(ParameterList& paramList, std::string parameterName);
107 
113  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
114  class MueLuPreconditionerFactory : public PreconditionerFactoryBase<Scalar> {
115  public:
116 
119 
121  MueLuPreconditionerFactory();
123 
126 
128  bool isCompatible(const LinearOpSourceBase<Scalar>& fwdOp) const;
130  Teuchos::RCP<PreconditionerBase<Scalar> > createPrec() const;
132  void initializePrec(const Teuchos::RCP<const LinearOpSourceBase<Scalar> >& fwdOp,
133  PreconditionerBase<Scalar>* prec,
134  const ESupportSolveUse supportSolveUse
135  ) const;
137  void uninitializePrec(PreconditionerBase<Scalar>* prec,
138  Teuchos::RCP<const LinearOpSourceBase<Scalar> >* fwdOp,
139  ESupportSolveUse* supportSolveUse
140  ) const;
141 
143 
146 
148  void setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& paramList);
150  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
152  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
154  Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
156  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
158 
161 
163  std::string description() const;
164 
165  // ToDo: Add an override of describe(...) to give more detail!
166 
168 
169  private:
170 
171  //Teuchos::RCP<MueLu::Hierarchy<Scalar,LocalOrdinal,GlobalOrdinal,Node> > CreateXpetraPreconditioner(Teuchos::RCP<Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > op, const Teuchos::ParameterList& paramList, Teuchos::RCP<Xpetra::MultiVector<typename Teuchos::ScalarTraits<Scalar>::magnitudeType, LocalOrdinal, GlobalOrdinal, Node> > coords, Teuchos::RCP<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> > nullspace) const;
172 
173  Teuchos::RCP<Teuchos::ParameterList> paramList_;
174 
175  };
176 
177 } // namespace Thyra
178 
179 #endif // #ifdef HAVE_MUELU_STRATIMIKOS
180 
181 #endif // THYRA_MUELU_PRECONDITIONER_FACTORY_DECL_HPP
Various adapters that will create a MueLu preconditioner that is an Xpetra::Matrix.
void getValidParameters(Teuchos::ParameterList &params)