MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AggregationStructuredAlgorithm_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_AGGREGATIONSTRUCTUREDALGORITHM_DECL_HPP_
47#define MUELU_AGGREGATIONSTRUCTUREDALGORITHM_DECL_HPP_
48
49#include "MueLu_ConfigDefs.hpp"
52
56#include "MueLu_GraphBase.hpp"
57
58namespace MueLu {
77 template<class LocalOrdinal = DefaultLocalOrdinal,
79 class Node = DefaultNode>
81 public MueLu::AggregationAlgorithmBase<LocalOrdinal,GlobalOrdinal,Node> {
82#undef MUELU_AGGREGATIONSTRUCTUREDALGORITHM_SHORT
84
85 public:
87
88
90 AggregationStructuredAlgorithm(const RCP<const FactoryBase>& /* graphFact */ = Teuchos::null) { }
91
94
96
97
99
100
103 void BuildAggregates(const Teuchos::ParameterList& params, const GraphBase& graph,
104 Aggregates& aggregates, std::vector<unsigned>& aggStat,
105 LO& numNonAggregatedNodes) const;
106
109 void BuildGraph(const GraphBase& graph, RCP<IndexManager>& geoData, const LO dofsPerNode,
110 RCP<CrsGraph>& myGraph, RCP<const Map>& coarseCoordinatesFineMap,
111 RCP<const Map>& coarseCoordinatesMap) const;
113
114 std::string description() const { return "Aggretation: structured algorithm"; }
115
116 private:
117
118 void ComputeGraphDataConstant(const GraphBase& graph, RCP<IndexManager>& geoData,
119 const LO dofsPerNode, const int numInterpolationPoints,
120 ArrayRCP<size_t>& nnzOnRow, Array<size_t>& rowPtr,
121 Array<LO>& colIndex) const;
122
123 void ComputeGraphDataLinear(const GraphBase& graph, RCP<IndexManager>& geoData,
124 const LO dofsPerNode, const int numInterpolationPoints,
125 ArrayRCP<size_t>& nnzOnRow, Array<size_t>& rowPtr,
126 Array<LO>& colIndex) const;
127
128 };
129
130} //namespace MueLu
131
132#define MUELU_AGGREGATIONSTRUCTUREDALGORITHM_SHORT
133#endif /* MUELU_AGGREGATIONSTRUCTUREDALGORITHM_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Container class for aggregation information.
Pure virtual base class for all MueLu aggregation algorithms.
Algorithm for coarsening a graph with structured aggregation.
std::string description() const
Return a simple one-line description of this object.
void BuildGraph(const GraphBase &graph, RCP< IndexManager > &geoData, const LO dofsPerNode, RCP< CrsGraph > &myGraph, RCP< const Map > &coarseCoordinatesFineMap, RCP< const Map > &coarseCoordinatesMap) const
Local aggregation.
void ComputeGraphDataConstant(const GraphBase &graph, RCP< IndexManager > &geoData, const LO dofsPerNode, const int numInterpolationPoints, ArrayRCP< size_t > &nnzOnRow, Array< size_t > &rowPtr, Array< LO > &colIndex) const
AggregationStructuredAlgorithm(const RCP< const FactoryBase > &=Teuchos::null)
Constructor.
void BuildAggregates(const Teuchos::ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
Local aggregation.
void ComputeGraphDataLinear(const GraphBase &graph, RCP< IndexManager > &geoData, const LO dofsPerNode, const int numInterpolationPoints, ArrayRCP< size_t > &nnzOnRow, Array< size_t > &rowPtr, Array< LO > &colIndex) const
MueLu representation of a graph.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode