MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_PermutationFactory_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/*
11 * MueLu_PermutationFactory_decl.hpp
12 *
13 * Created on: Nov 28, 2012
14 * Author: wiesner
15 */
16
17#ifndef MUELU_PERMUTATIONFACTORY_DECL_HPP_
18#define MUELU_PERMUTATIONFACTORY_DECL_HPP_
19
20#include <Xpetra_Map_fwd.hpp>
21#include <Xpetra_Matrix_fwd.hpp>
22
23#include "MueLu_ConfigDefs.hpp"
25
28
29namespace MueLu {
30
38template <class Scalar = DefaultScalar,
41 class Node = DefaultNode>
43#undef MUELU_PERMUTATIONFACTORY_SHORT
45
46 public:
48
49
52
54 virtual ~PermutationFactory();
55
57
58 RCP<const ParameterList> GetValidParameterList() const;
59
61
62
68 void DeclareInput(Level &currentLevel) const;
69
71
73
74
76 void Build(Level &currentLevel) const;
77
79
80 private:
81}; // class PermutationFactory
82
83} // namespace MueLu
84
85#define MUELU_PERMUTATIONFACTORY_SHORT
86
87#endif /* MUELU_PERMUTATIONFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
factory generates a row- and column permutation operators P and Q such that P*A*Q^T is a (hopefully) ...
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &currentLevel) const
Build an object with this factory.
Base class for factories that use one level (currentLevel).
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar