MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AmalgamationInfo_kokkos_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/*
47 * MueLu_AmalgamationInfo_decl.hpp
48 *
49 * Created on: Mar 28, 2012
50 * Author: wiesner
51 */
52
53#ifndef MUELU_AMALGAMATIONINFO_KOKKOS_DECL_HPP_
54#define MUELU_AMALGAMATIONINFO_KOKKOS_DECL_HPP_
55
56#include <Xpetra_ConfigDefs.hpp> // global_size_t
57#include <Xpetra_Map_fwd.hpp>
58#include <Xpetra_MapFactory_fwd.hpp>
59#include <Xpetra_Vector_fwd.hpp>
60
61#include "MueLu_ConfigDefs.hpp"
62
63#include "MueLu_BaseClass.hpp"
64
67
68namespace MueLu {
69
78 template<class LocalOrdinal = DefaultLocalOrdinal,
80 class Node = DefaultNode>
82 : public BaseClass {
83#undef MUELU_AMALGAMATIONINFO_KOKKOS_SHORT
85
86 public:
87
88 AmalgamationInfo_kokkos(RCP<Array<LO> > rowTranslation,
89 RCP<Array<LO> > colTranslation,
90 RCP<const Map> nodeRowMap,
91 RCP<const Map> nodeColMap,
92 RCP< const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > const &columnMap,
93 LO fullblocksize, GO offset, LO blockid, LO nStridedOffset, LO stridedblocksize) :
94 rowTranslation_(rowTranslation),
95 colTranslation_(colTranslation),
96 nodeRowMap_(nodeRowMap),
97 nodeColMap_(nodeColMap),
98 columnMap_(columnMap),
99 fullblocksize_(fullblocksize),
100 offset_(offset),
101 blockid_(blockid),
102 nStridedOffset_(nStridedOffset),
103 stridedblocksize_(stridedblocksize),
104 indexBase_(columnMap->getIndexBase())
105 {}
106
108
110 std::string description() const { return "AmalgamationInfo"; }
111
113 //using MueLu::Describable::describe; // overloading, not hiding
114 //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;;
115 void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
116
117 RCP<const Map> getNodeRowMap() const { return nodeRowMap_; }
118 RCP<const Map> getNodeColMap() const { return nodeColMap_; }
119
120 /* @brief Translation arrays
121 *
122 * Returns translation arrays providing local node ids given local dof ids built from either
123 * the non-overlapping (unique) row map or the overlapping (non-unique) column map.
124 * The getColTranslation routine, e.g., is used for the MergeRows routine in CoalesceDropFactory.
125 */
127 RCP<Array<LO> > getRowTranslation() const { return rowTranslation_; }
128 RCP<Array<LO> > getColTranslation() const { return colTranslation_; }
130
135 void UnamalgamateAggregates(const Aggregates_kokkos& aggregates, Teuchos::ArrayRCP<LocalOrdinal>& aggStart, Teuchos::ArrayRCP<GlobalOrdinal>& aggToRowMap) const;
136 void UnamalgamateAggregatesLO(const Aggregates_kokkos& aggregates, Teuchos::ArrayRCP<LocalOrdinal>& aggStart, Teuchos::ArrayRCP<LO>& aggToRowMap) const;
137
141 Teuchos::RCP< Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > ComputeUnamalgamatedImportDofMap(const Aggregates_kokkos& aggregates) const;
142
150 GO ComputeGlobalDOF(GO const &gNodeID, LO const &k=0) const;
151
155 GO GlobalOffset() { return offset_; }
156
158 void GetStridingInformation(LO& fullBlockSize, LO& blockID, LO& stridingOffset, LO& stridedBlockSize, GO& indexBase) {
159 fullBlockSize = fullblocksize_;
160 blockID = blockid_;
161 stridingOffset = nStridedOffset_;
162 stridedBlockSize = stridedblocksize_;
163 indexBase = indexBase_;
164 }
165
166 private:
167
169
170
171 // arrays containing local node ids given local dof ids
172 RCP<Array<LO> > rowTranslation_;
173 RCP<Array<LO> > colTranslation_;
174
175 // node row and column map of graph (built from row and column map of A)
176 RCP<const Map> nodeRowMap_;
177 RCP<const Map> nodeColMap_;
178
180 // keep an RCP on the column map to make sure that the map is still valid when it is used
181 Teuchos::RCP< const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > columnMap_;
182
184
186
194
195 };
196
197} // namespace MueLu
198
199#define MUELU_AMALGAMATIONINFO_KOKKOS_SHORT
200#endif /* MUELU_AMALGAMATIONINFO_KOKKOS_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
minimal container class for storing amalgamation information
GO GlobalOffset()
returns offset of global dof ids
void GetStridingInformation(LO &fullBlockSize, LO &blockID, LO &stridingOffset, LO &stridedBlockSize, GO &indexBase)
returns striding information
void UnamalgamateAggregatesLO(const Aggregates_kokkos &aggregates, Teuchos::ArrayRCP< LocalOrdinal > &aggStart, Teuchos::ArrayRCP< LO > &aggToRowMap) const
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > columnMap_
DOF map (really column map of A)
AmalgamationInfo_kokkos(RCP< Array< LO > > rowTranslation, RCP< Array< LO > > colTranslation, RCP< const Map > nodeRowMap, RCP< const Map > nodeColMap, RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > const &columnMap, LO fullblocksize, GO offset, LO blockid, LO nStridedOffset, LO stridedblocksize)
void UnamalgamateAggregates(const Aggregates_kokkos &aggregates, Teuchos::ArrayRCP< LocalOrdinal > &aggStart, Teuchos::ArrayRCP< GlobalOrdinal > &aggToRowMap) const
UnamalgamateAggregates.
GO ComputeGlobalDOF(GO const &gNodeID, LO const &k=0) const
ComputeGlobalDOF return global dof id associated with global node id gNodeID and dof index k.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
Teuchos::RCP< Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > ComputeUnamalgamatedImportDofMap(const Aggregates_kokkos &aggregates) const
ComputeUnamalgamatedImportDofMap build overlapping dof row map from aggregates needed for overlapping...
RCP< const Map > getNodeColMap() const
< returns the node row map for the graph
RCP< Array< LO > > getRowTranslation() const
< returns the node column map for the graph
std::string description() const
Return a simple one-line description of this object.
Base class for MueLu classes.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode