MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AggregateQualityEstimateFactory_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_AGGREGATEQUALITYESTIMATEFACTORY_DECL_HPP
11#define MUELU_AGGREGATEQUALITYESTIMATEFACTORY_DECL_HPP
12
13#include "MueLu_ConfigDefs.hpp"
16
17#include <Xpetra_Matrix_fwd.hpp>
18#include <Xpetra_MultiVector_fwd.hpp>
19#include <Xpetra_Map_fwd.hpp>
20#include <Xpetra_MultiVectorFactory_fwd.hpp>
21#include <Xpetra_Vector_fwd.hpp>
22#include <Xpetra_VectorFactory_fwd.hpp>
23
25#include "MueLu_Level_fwd.hpp"
26
27namespace MueLu {
28
44template <class Scalar = DefaultScalar,
47 class Node = DefaultNode>
49#undef MUELU_AGGREGATEQUALITYESTIMATEFACTORY_SHORT
51
52 public:
54
55
56 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
57
60
63
65
66 RCP<const ParameterList> GetValidParameterList() const;
67
69
70
76 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
77
79
81
82
84 void Build(Level& fineLevel, Level& coarseLevel) const;
85
87
89
90
92 static void ConvertAggregatesData(RCP<const Aggregates> aggs, ArrayRCP<LO>& aggSortedVertices, ArrayRCP<LO>& aggsToIndices, ArrayRCP<LO>& aggSizes);
93
95
96 private:
98
99
100 void ComputeAggregateQualities(RCP<const Matrix> A, RCP<const Aggregates> aggs, RCP<Xpetra::MultiVector<magnitudeType, LO, GO, Node>> agg_qualities) const;
101
102 void ComputeAggregateSizes(RCP<const Matrix> A, RCP<const Aggregates> aggs, RCP<LocalOrdinalVector> agg_sizes) const;
103
105
107
108
109 void OutputAggQualities(const Level& level, RCP<const Xpetra::MultiVector<magnitudeType, LO, GO, Node>> agg_qualities) const;
110
111 void OutputAggSizes(const Level& level, RCP<const LocalOrdinalVector> agg_sizes) const;
112
114
115}; // class AggregateQualityEsimateFactory();
116
117} // namespace MueLu
118
119#define MUELU_AGGREGATEQUALITYESTIMATEFACTORY_SHORT
120#endif // MUELU_DEMOFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
An factory which assigns each aggregate a quality estimate. Originally developed by Napov and Notay i...
void OutputAggQualities(const Level &level, RCP< const Xpetra::MultiVector< magnitudeType, LO, GO, Node > > agg_qualities) const
void OutputAggSizes(const Level &level, RCP< const LocalOrdinalVector > agg_sizes) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void ComputeAggregateQualities(RCP< const Matrix > A, RCP< const Aggregates > aggs, RCP< Xpetra::MultiVector< magnitudeType, LO, GO, Node > > agg_qualities) const
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
static void ConvertAggregatesData(RCP< const Aggregates > aggs, ArrayRCP< LO > &aggSortedVertices, ArrayRCP< LO > &aggsToIndices, ArrayRCP< LO > &aggSizes)
Build aggregate quality esimates with this factory.
Teuchos::ScalarTraits< Scalar >::magnitudeType magnitudeType
void Build(Level &fineLevel, Level &coarseLevel) const
Build aggregate quality esimates with this factory.
void ComputeAggregateSizes(RCP< const Matrix > A, RCP< const Aggregates > aggs, RCP< LocalOrdinalVector > agg_sizes) const
Class that holds all level-specific information.
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar