MueLu  Version of the Day
MueLu_AggregateQualityEstimateFactory_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 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_AGGREGATEQUALITYESTIMATEFACTORY_DECL_HPP
47 #define MUELU_AGGREGATEQUALITYESTIMATEFACTORY_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
52 
53 #include <Xpetra_CrsMatrix_fwd.hpp>
54 #include <Xpetra_Matrix_fwd.hpp>
55 #include <Xpetra_MultiVector_fwd.hpp>
56 #include <Xpetra_MapFactory_fwd.hpp>
57 #include <Xpetra_Map_fwd.hpp>
58 #include <Xpetra_Matrix_fwd.hpp>
59 #include <Xpetra_MultiVector_fwd.hpp>
60 #include <Xpetra_MultiVectorFactory_fwd.hpp>
61 #include <Xpetra_Vector_fwd.hpp>
62 #include <Xpetra_VectorFactory_fwd.hpp>
63 
64 #include <Xpetra_Import_fwd.hpp>
65 #include <Xpetra_ImportFactory_fwd.hpp>
66 #include <Xpetra_CrsMatrixWrap_fwd.hpp>
67 
68 #include "MueLu_Aggregates_fwd.hpp"
69 #include "MueLu_Level_fwd.hpp"
70 
71 namespace MueLu {
72 
88  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
90 #undef MUELU_AGGREGATEQUALITYESTIMATEFACTORY_SHORT
91 #include "MueLu_UseShortNames.hpp"
92 
93  public:
95 
96 
97  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
98 
101 
104 
106 
107  RCP<const ParameterList> GetValidParameterList() const;
108 
110 
111 
117  void DeclareInput(Level &currentLevel) const;
118 
120 
122 
123 
125  void Build(Level & currentLevel) const;
126 
128 
130 
131 
133  static void ConvertAggregatesData(RCP<const Aggregates> aggs, ArrayRCP<LO>& aggSortedVertices, ArrayRCP<LO>& aggsToIndices, ArrayRCP<LO>& aggSizes);
134 
136 
137  private:
138 
140 
141 
142  void ComputeAggregateQualities(RCP<const Matrix> A, RCP<const Aggregates> aggs, RCP<Xpetra::MultiVector<magnitudeType,LO,GO,Node>> agg_qualities) const;
143 
144  void ComputeAggregateSizes(RCP<const Matrix> A, RCP<const Aggregates> aggs, RCP<LocalOrdinalVector> agg_sizes) const;
145 
147 
149 
150 
151  void OutputAggQualities(const Level& level, RCP<const Xpetra::MultiVector<magnitudeType,LO,GO,Node>> agg_qualities) const;
152 
153 
154  void OutputAggSizes(const Level& level, RCP<const LocalOrdinalVector> agg_sizes) const;
155 
156 
157 
159 
160 
161  }; // class AggregateQualityEsimateFactory();
162 
163 } // namespace MueLu
164 
165 #define MUELU_AGGREGATEQUALITYESTIMATEFACTORY_SHORT
166 #endif // MUELU_DEMOFACTORY_DECL_HPP
void OutputAggQualities(const Level &level, RCP< const Xpetra::MultiVector< magnitudeType, LO, GO, Node >> agg_qualities) const
Namespace for MueLu classes and methods.
void OutputAggSizes(const Level &level, RCP< const LocalOrdinalVector > agg_sizes) const
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void ComputeAggregateSizes(RCP< const Matrix > A, RCP< const Aggregates > aggs, RCP< LocalOrdinalVector > agg_sizes) const
void ComputeAggregateQualities(RCP< const Matrix > A, RCP< const Aggregates > aggs, RCP< Xpetra::MultiVector< magnitudeType, LO, GO, Node >> agg_qualities) const
void Build(Level &currentLevel) const
Build aggregate quality esimates with this factory.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
static void ConvertAggregatesData(RCP< const Aggregates > aggs, ArrayRCP< LO > &aggSortedVertices, ArrayRCP< LO > &aggsToIndices, ArrayRCP< LO > &aggSizes)
Build aggregate quality esimates with this factory.
An factory which assigns each aggregate a quality estimate. Originally developed by Napov and Notay i...
Teuchos::ScalarTraits< Scalar >::magnitudeType magnitudeType
Base class for factories that use one level (currentLevel).