MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_UncoupledIndexManager_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// Ray Tuminaro (rstumin@sandia.gov)
41// Luc Berger-Vergiat (lberge@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef MUELU_UNCOUPLEDINDEXMANAGER_DECL_HPP
47#define MUELU_UNCOUPLEDINDEXMANAGER_DECL_HPP
48
49// use for Teuchos:Comm<T>
50#include "Teuchos_CommHelpers.hpp"
51
52#include <Xpetra_Map_fwd.hpp>
53#include <Xpetra_Vector_fwd.hpp>
54#include <Xpetra_VectorFactory_fwd.hpp>
55
56#include "MueLu_ConfigDefs.hpp"
57#include "MueLu_IndexManager.hpp"
59
60/*****************************************************************************
61
62****************************************************************************/
63
64namespace MueLu {
65
82 template <class LocalOrdinal, class GlobalOrdinal, class Node>
83 class UncoupledIndexManager : public IndexManager<LocalOrdinal, GlobalOrdinal, Node> {
84#undef MUELU_UNCOUPLEDINDEXMANAGER_SHORT
86
87 public:
88
89 //LBV: I doubt that it makes sense to have
90 // this particular constructor since it is
91 // not used anywhere and parameters cannot
92 // all accessible after construction.
94
95 UncoupledIndexManager(const RCP<const Teuchos::Comm<int> > comm, const bool coupled,
96 const int NumDimensions, const int interpolationOrder,
97 const int MyRank, const int NumRanks,
98 const Array<GO> GFineNodesPerDir,
99 const Array<LO> LFineNodesPerDir,
100 const Array<LO> CoarseRate,
101 const bool singleCoarsePoint);
102
104
106
107 std::vector<std::vector<GO> > getCoarseMeshData() const;
108
109 void getGhostedNodesData(const RCP<const Map> fineMap,
110 Array<LO>& ghostedNodeCoarseLIDs,
111 Array<int>& ghostedNodeCoarsePIDs,
112 Array<GO>& ghostedNodeCoarseGIDs) const;
113
114 void getCoarseNodesData(const RCP<const Map> fineCoordinatesMap,
115 Array<GO>& coarseNodeCoarseGIDs,
116 Array<GO>& coarseNodeFineGIDs) const;
117
118 void getFineNodeGlobalTuple(const GO myGID, GO& i, GO& j, GO& k) const;
119
120 void getFineNodeLocalTuple(const LO myLID, LO& i, LO& j, LO& k) const;
121
122 void getFineNodeGhostedTuple(const LO myLID, LO& i, LO& j, LO& k) const;
123
124 void getFineNodeGID(const GO i, const GO j, const GO k, GO& myGID) const;
125
126 void getFineNodeLID(const LO i, const LO j, const LO k, LO& myLID) const;
127
128 void getCoarseNodeGlobalTuple(const GO myGID, GO& i, GO& j, GO& k) const;
129
130 void getCoarseNodeLocalTuple(const LO myLID, LO& i, LO& j, LO& k) const;
131
132 void getCoarseNodeGID(const GO i, const GO j, const GO k, GO& myGID) const;
133
134 void getCoarseNodeLID(const LO i, const LO j, const LO k, LO& myLID) const;
135
136 void getCoarseNodeGhostedLID(const LO i, const LO j, const LO k, LO& myLID) const;
137
138 void getCoarseNodeFineLID(const LO i, const LO j, const LO k, LO& myLID) const;
139
140 void getGhostedNodeFineLID(const LO i, const LO j, const LO k, LO& myLID) const;
141
142 void getGhostedNodeCoarseLID(const LO i, const LO j, const LO k, LO& myLID) const;
143
144 private:
145
146 const int myRank;
147 const int numRanks;
148
149 };
150
151} //namespace MueLu
152
153#define MUELU_UNCOUPLEDINDEXMANAGER_SHORT
154#endif // MUELU_UNCOUPLEDINDEXMANAGER_DECL_HPP
Container class for mesh layout and indices calculation.
void getCoarseNodeGID(const GO i, const GO j, const GO k, GO &myGID) const
void getFineNodeGID(const GO i, const GO j, const GO k, GO &myGID) const
void getCoarseNodesData(const RCP< const Map > fineCoordinatesMap, Array< GO > &coarseNodeCoarseGIDs, Array< GO > &coarseNodeFineGIDs) const
const int numRanks
Number of ranks used to decompose the problem.
void getGhostedNodeFineLID(const LO i, const LO j, const LO k, LO &myLID) const
void getCoarseNodeFineLID(const LO i, const LO j, const LO k, LO &myLID) const
void getGhostedNodesData(const RCP< const Map > fineMap, Array< LO > &ghostedNodeCoarseLIDs, Array< int > &ghostedNodeCoarsePIDs, Array< GO > &ghostedNodeCoarseGIDs) const
void getGhostedNodeCoarseLID(const LO i, const LO j, const LO k, LO &myLID) const
void getCoarseNodeLID(const LO i, const LO j, const LO k, LO &myLID) const
void getFineNodeLID(const LO i, const LO j, const LO k, LO &myLID) const
void getCoarseNodeGhostedLID(const LO i, const LO j, const LO k, LO &myLID) const
std::vector< std::vector< GO > > getCoarseMeshData() const
void getFineNodeLocalTuple(const LO myLID, LO &i, LO &j, LO &k) const
void getCoarseNodeGlobalTuple(const GO myGID, GO &i, GO &j, GO &k) const
void getCoarseNodeLocalTuple(const LO myLID, LO &i, LO &j, LO &k) const
void getFineNodeGhostedTuple(const LO myLID, LO &i, LO &j, LO &k) const
void getFineNodeGlobalTuple(const GO myGID, GO &i, GO &j, GO &k) const
Namespace for MueLu classes and methods.