MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_GeneralGeometricPFactory_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_GENERALGEOMETRICPFACTORY_DECL_HPP
47#define MUELU_GENERALGEOMETRICPFACTORY_DECL_HPP
48
49#include <Teuchos_SerialDenseVector.hpp>
50
51#include <Xpetra_MultiVector.hpp>
52#include <Xpetra_Matrix_fwd.hpp>
53
54#include "MueLu_ConfigDefs.hpp"
55#include "MueLu_PFactory.hpp"
57
58#include "MueLu_Level_fwd.hpp"
59
60namespace MueLuTests {
61 // Forward declaration of friend tester class used to UnitTest GeneralGeometricPFactory
62 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
64}
65
66namespace MueLu {
67
115 template <class Scalar = DefaultScalar,
118 class Node = DefaultNode>
120#undef MUELU_GENERALGEOMETRICPFACTORY_SHORT
122
123 public:
124
126
128
129
132
136
137 RCP<const ParameterList> GetValidParameterList() const;
138
140
141
142 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
143
145
147
148
149 void Build (Level& fineLevel, Level& coarseLevel) const;
150 void BuildP(Level& fineLevel, Level& coarseLevel) const;
151
153
154 private:
156 // Geometric algorithm require a copious amount of data to be passed around so this struct
157 // will reduce the amount of input/output parameters of methods in the class. Additionally
158 // the struct can be rewritten to accomodate constraints of Kokkos/CUDA data types
159
160 std::string meshLayout = "Global Lexicographic";
163 LO myBlock = -1, numBlocks = -1, lNumFineNodes10 = -1;
165 Array<int> coarseRate, endRate;
168 std::vector<std::vector<GO> > meshData; // These are sorted later so they are in std::vector
169 bool ghostInterface[6] = {false};
170
172 coarseRate.resize(3);
173 endRate.resize(3);
174 lFineNodesPerDir.resize(3);
175 lCoarseNodesPerDir.resize(3);
176 offsets.resize(6);
177 ghostedCoarseNodesPerDir.resize(3);
178 startIndices.resize(6);
179 gFineNodesPerDir.resize(3);
180 gCoarseNodesPerDir.resize(3);
181 startGhostedCoarseNode.resize(3);
182 }
183 };
184
185 struct NodesIDs {
186 // This small struct just carries basic data associated with coarse nodes that is needed
187 // to compute colMapP and to fillComplete P,
188
189 Array<GO> GIDs, coarseGIDs;
190 Array<int> PIDs;
191 Array<LO> LIDs;
192 std::vector<GO> colInds;
193 };
194
195 struct NodeID {
196 // This small struct is similar to the one above but only for one node.
197 // It is used to create a vector of NodeID that can easily be sorted
198
199 GO GID;
200 int PID;
202 };
203
204 void MeshLayoutInterface(const int interpolationOrder, const LO blkSize,
205 RCP<const Map> fineCoordsMap, RCP<GeometricData> myGeometry,
206 RCP<NodesIDs> ghostedCoarseNodes,
207 Array<Array<GO> >& lCoarseNodesGIDs) const;
208
209 void GetCoarsePoints(const int interpolationOrder, const LO blkSize,
210 RCP<const Map> fineCoordsMap, RCP<GeometricData> myGeometry,
211 RCP<NodesIDs> ghostedCoarseNodes,
212 Array<Array<GO> >& lCoarseNodesGIDs) const;
213
214 void MakeGeneralGeometricP(RCP<GeometricData> myGeo,
215 const RCP<Xpetra::MultiVector<typename Teuchos::ScalarTraits<Scalar>::coordinateType,LO,GO,NO> >& fCoords,
216 const LO nnzP, const LO dofsPerNode,
217 RCP<const Map>& stridedDomainMapP,
218 RCP<Matrix> & Amat, RCP<Matrix>& P,
219 RCP<Xpetra::MultiVector<typename Teuchos::ScalarTraits<Scalar>::coordinateType,LO,GO,NO> >& cCoords,
220 RCP<NodesIDs> ghostedCoarseNodes, Array<Array<GO> > coarseNodesGIDs,
221 int interpolationOrder) const;
222
223 void ComputeStencil(const LO numDimension, const Array<GO> currentNodeIndices,
224 const Array<GO> coarseNodeIndices, const LO rate[3],
225 const Array<Array<typename Teuchos::ScalarTraits<Scalar>::coordinateType> > coord, const int interpolationOrder,
226 std::vector<double>& stencil) const;
227
228 void ComputeConstantInterpolationStencil(const LO numDimension,
229 const Array<GO> currentNodeIndices,
230 const Array<GO> coarseNodeIndices,
231 const LO rate[3], std::vector<double>& stencil) const;
232
233 void ComputeLinearInterpolationStencil(const LO numDimension, const Array<Array<typename Teuchos::ScalarTraits<Scalar>::coordinateType> > coord,
234 std::vector<double>& stencil) const;
235 void GetInterpolationFunctions(const LO numDimension,
236 const Teuchos::SerialDenseVector<LO,double> parameters,
237 double functions[4][8]) const;
238
239 void sh_sort_permute(
240 const typename Teuchos::Array<LocalOrdinal>::iterator& first1,
241 const typename Teuchos::Array<LocalOrdinal>::iterator& last1,
242 const typename Teuchos::Array<LocalOrdinal>::iterator& first2,
243 const typename Teuchos::Array<LocalOrdinal>::iterator& last2) const;
244
245 void sh_sort2(
246 const typename Teuchos::Array<LocalOrdinal>::iterator& first1,
247 const typename Teuchos::Array<LocalOrdinal>::iterator& last1,
248 const typename Teuchos::Array<LocalOrdinal>::iterator& first2,
249 const typename Teuchos::Array<LocalOrdinal>::iterator& last2) const;
250
251 void GetGIDLocalLexicographic(const GO i, const GO j, const GO k,
252 const Array<LO> coarseNodeFineIndices,
253 const RCP<GeometricData> myGeo, const LO myRankIndex, const LO pi,
254 const LO pj, const LO pk,
255 const typename std::vector<std::vector<GO> >::iterator blockStart,
256 const typename std::vector<std::vector<GO> >::iterator blockEnd,
257 GO& myGID, LO& myPID, LO& myLID) const;
258
259 }; //class GeneralGeometricPFactory
260
261} //namespace MueLu
262
263#define MUELU_GENERALGEOMETRICPFACTORY_SHORT
264#endif // MUELU_GENERALGEOMETRICPFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Prolongator factory performing geometric coarsening.
void MakeGeneralGeometricP(RCP< GeometricData > myGeo, const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::coordinateType, LO, GO, NO > > &fCoords, const LO nnzP, const LO dofsPerNode, RCP< const Map > &stridedDomainMapP, RCP< Matrix > &Amat, RCP< Matrix > &P, RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::coordinateType, LO, GO, NO > > &cCoords, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > coarseNodesGIDs, int interpolationOrder) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void sh_sort_permute(const typename Teuchos::Array< LocalOrdinal >::iterator &first1, const typename Teuchos::Array< LocalOrdinal >::iterator &last1, const typename Teuchos::Array< LocalOrdinal >::iterator &first2, const typename Teuchos::Array< LocalOrdinal >::iterator &last2) const
void ComputeLinearInterpolationStencil(const LO numDimension, const Array< Array< typename Teuchos::ScalarTraits< Scalar >::coordinateType > > coord, std::vector< double > &stencil) const
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
void ComputeStencil(const LO numDimension, const Array< GO > currentNodeIndices, const Array< GO > coarseNodeIndices, const LO rate[3], const Array< Array< typename Teuchos::ScalarTraits< Scalar >::coordinateType > > coord, const int interpolationOrder, std::vector< double > &stencil) const
void GetCoarsePoints(const int interpolationOrder, const LO blkSize, RCP< const Map > fineCoordsMap, RCP< GeometricData > myGeometry, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > &lCoarseNodesGIDs) const
void GetInterpolationFunctions(const LO numDimension, const Teuchos::SerialDenseVector< LO, double > parameters, double functions[4][8]) const
void GetGIDLocalLexicographic(const GO i, const GO j, const GO k, const Array< LO > coarseNodeFineIndices, const RCP< GeometricData > myGeo, const LO myRankIndex, const LO pi, const LO pj, const LO pk, const typename std::vector< std::vector< GO > >::iterator blockStart, const typename std::vector< std::vector< GO > >::iterator blockEnd, GO &myGID, LO &myPID, LO &myLID) const
void MeshLayoutInterface(const int interpolationOrder, const LO blkSize, RCP< const Map > fineCoordsMap, RCP< GeometricData > myGeometry, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > &lCoarseNodesGIDs) const
void sh_sort2(const typename Teuchos::Array< LocalOrdinal >::iterator &first1, const typename Teuchos::Array< LocalOrdinal >::iterator &last1, const typename Teuchos::Array< LocalOrdinal >::iterator &first2, const typename Teuchos::Array< LocalOrdinal >::iterator &last2) const
void ComputeConstantInterpolationStencil(const LO numDimension, const Array< GO > currentNodeIndices, const Array< GO > coarseNodeIndices, const LO rate[3], std::vector< double > &stencil) const
Class that holds all level-specific information.
Factory that provides an interface for a concrete implementation of a prolongation operator.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar