MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_EminPFactory_decl.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 MUELU_EMINPFACTORY_DECL_HPP
11#define MUELU_EMINPFACTORY_DECL_HPP
12
13#include "MueLu_ConfigDefs.hpp"
14
15#include <Xpetra_Matrix_fwd.hpp>
16#include <Xpetra_StridedMapFactory_fwd.hpp>
17
19
21#include "MueLu_Level_fwd.hpp"
23#include "MueLu_PFactory.hpp"
26
27namespace MueLu {
28
35template <class Scalar = DefaultScalar,
38 class Node = DefaultNode>
39class EminPFactory : public PFactory {
40#undef MUELU_EMINPFACTORY_SHORT
42
43 public:
45
46
49
51 virtual ~EminPFactory() {}
52
54
55 RCP<const ParameterList> GetValidParameterList() const;
56
58
59
60 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
61
63
65
66
72 void Build(Level& fineLevel, Level& coarseLevel) const;
73 void BuildP(Level& fineLevel, Level& coarseLevel) const;
74
76
77 static
78 typename Teuchos::ScalarTraits<Scalar>::magnitudeType
79 ComputeProlongatorEnergyNorm(RCP<Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& A,
80 RCP<Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>& P,
81 Teuchos::FancyOStream& out);
82
83}; // class EminPFactory
84
85} // namespace MueLu
86
87#define MUELU_EMINPFACTORY_SHORT
88#endif // MUELU_EMINPFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Factory for building Energy Minimization prolongators.
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
virtual ~EminPFactory()
Destructor.
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
static Teuchos::ScalarTraits< Scalar >::magnitudeType ComputeProlongatorEnergyNorm(RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A, RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &P, Teuchos::FancyOStream &out)
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Class that holds all level-specific information.
Factory that provides an interface for a concrete implementation of a prolongation operator.
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar