MueLu Version of the Day
Loading...
Searching...
No Matches
Thyra_MueLuRefMaxwellPreconditionerFactory_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_REFMAXWELL_PRECONDITIONER_FACTORY_DECL_HPP
48#define THYRA_MUELU_REFMAXWELL_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"
60#ifdef HAVE_MUELU_TPETRA
61#include "Thyra_TpetraLinearOp.hpp"
62#include "Thyra_TpetraThyraWrappers.hpp"
63#endif
64#ifdef HAVE_MUELU_EPETRA
65#include "Thyra_EpetraLinearOp.hpp"
66#include "Thyra_EpetraThyraWrappers.hpp"
67#endif
68
69#include "Teuchos_Ptr.hpp"
70#include "Teuchos_TestForException.hpp"
71#include "Teuchos_Assert.hpp"
72#include "Teuchos_Time.hpp"
73
74#include <Xpetra_CrsMatrixWrap.hpp>
75#include <Xpetra_CrsMatrix.hpp>
76#include <Xpetra_Matrix.hpp>
77#include <Xpetra_ThyraUtils.hpp>
78
79#include <MueLu_XpetraOperator_decl.hpp> // todo fix me
80#include <MueLu_RefMaxwell.hpp>
81#ifdef HAVE_MUELU_TPETRA
82#include <MueLu_TpetraOperator.hpp>
83#include <Xpetra_TpetraOperator.hpp>
84#include <Xpetra_TpetraHalfPrecisionOperator.hpp>
85#endif
86#ifdef HAVE_MUELU_EPETRA
88#include <Xpetra_EpetraOperator.hpp>
89#endif
90
91#include "Thyra_PreconditionerFactoryBase.hpp"
92
93#include "KokkosCompat_DefaultNode.hpp"
94
95#include <list>
96
97namespace Thyra {
98
107 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
108 class MueLuRefMaxwellPreconditionerFactory : public PreconditionerFactoryBase<Scalar> {
109 public:
110
113
115 MueLuRefMaxwellPreconditionerFactory();
117
120
122 bool isCompatible(const LinearOpSourceBase<Scalar>& fwdOp) const;
124 Teuchos::RCP<PreconditionerBase<Scalar> > createPrec() const;
126 void initializePrec(const Teuchos::RCP<const LinearOpSourceBase<Scalar> >& fwdOp,
127 PreconditionerBase<Scalar>* prec,
128 const ESupportSolveUse supportSolveUse
129 ) const;
131 void uninitializePrec(PreconditionerBase<Scalar>* prec,
132 Teuchos::RCP<const LinearOpSourceBase<Scalar> >* fwdOp,
133 ESupportSolveUse* supportSolveUse
134 ) const;
135
137
140
142 void setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& paramList);
144 Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
146 Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
148 Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
150 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
152
155
157 std::string description() const;
158
159 // ToDo: Add an override of describe(...) to give more detail!
160
162
163 private:
164
165 Teuchos::RCP<Teuchos::ParameterList> paramList_;
166
167 };
168
169} // namespace Thyra
170
171#endif // #ifdef HAVE_MUELU_STRATIMIKOS
172
173#endif // THYRA_MUELU_REFMAXWELL_PRECONDITIONER_FACTORY_DECL_HPP
void getValidParameters(Teuchos::ParameterList &params)