MueLu Version of the Day
Loading...
Searching...
No Matches
Thyra_MueLuMaxwell1PreconditionerFactory_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_MAXWELL1_PRECONDITIONER_FACTORY_DECL_HPP
48#define THYRA_MUELU_MAXWELL1_PRECONDITIONER_FACTORY_DECL_HPP
49
50#include <MueLu_ConfigDefs.hpp>
51
52#if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
53
54#include "KokkosCompat_DefaultNode.hpp"
55#include "Thyra_DefaultPreconditioner.hpp"
56#include "Thyra_PreconditionerFactoryBase.hpp"
59
60
61namespace Thyra {
62
67 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
68 class MueLuMaxwell1PreconditionerFactory : public PreconditionerFactoryBase<Scalar> {
69 public:
70
73
75 MueLuMaxwell1PreconditionerFactory();
77
80
82 bool isCompatible(const LinearOpSourceBase<Scalar>& fwdOp) const;
84 Teuchos::RCP<PreconditionerBase<Scalar> > createPrec() const;
86 void initializePrec(const Teuchos::RCP<const LinearOpSourceBase<Scalar> >& fwdOp,
87 PreconditionerBase<Scalar>* prec,
88 const ESupportSolveUse supportSolveUse
89 ) const;
91 void uninitializePrec(PreconditionerBase<Scalar>* prec,
92 Teuchos::RCP<const LinearOpSourceBase<Scalar> >* fwdOp,
93 ESupportSolveUse* supportSolveUse
94 ) const;
95
97
100
102 void setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& paramList);
104 Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
106 Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
108 Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
110 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
112
115
117 std::string description() const;
118
119 // ToDo: Add an override of describe(...) to give more detail!
120
122
123 private:
124
125 Teuchos::RCP<Teuchos::ParameterList> paramList_;
126
127 };
128
129} // namespace Thyra
130
131#endif // #ifdef HAVE_MUELU_STRATIMIKOS
132
133#endif // THYRA_MUELU_MAXWELL1_PRECONDITIONER_FACTORY_DECL_HPP
void getValidParameters(Teuchos::ParameterList &params)