Nektar++
MeshPartitionPtScotch.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: MeshPartitionPtScotch.cpp
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: PtScotch partitioner interface
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
35 #include <boost/core/ignore_unused.hpp>
36 
39 
40 #include <ptscotch.h>
41 
42 #define SCOTCH_CALL(scotchFunc, args) \
43  { \
44  ASSERTL0(scotchFunc args == 0, \
45  std::string("Error in Scotch calling function ") + \
46  std::string(#scotchFunc)); \
47  }
48 
49 namespace Nektar
50 {
51 namespace SpatialDomains
52 {
53 
57  "Parallel partitioning using the PtScotch library.");
58 
61  "use-ptscotch", "", "Use PtScotch for parallel mesh partitioning.");
62 
65  LibUtilities::CommSharedPtr comm, int meshDim,
66  std::map<int, MeshEntity> element, CompositeDescriptor compMap)
67  : MeshPartition(session, comm, meshDim, element, compMap)
68 {
69  m_parallel = true;
70 }
71 
73 {
74 }
75 
77  int &nVerts, int &nVertConds, Array<OneD, int> &xadj,
78  Array<OneD, int> &adjcy, Array<OneD, int> &vertWgt,
79  Array<OneD, int> &vertSize, Array<OneD, int> &edgeWgt, int &nparts,
80  int &volume, Array<OneD, int> &part)
81 {
82  boost::ignore_unused(nVertConds, vertSize, edgeWgt, volume);
83 
85  std::dynamic_pointer_cast<LibUtilities::CommMpi>(m_comm);
86 
87  ASSERTL0(mpiComm, "PtScotch not supported in serial execution.");
88 
89  SCOTCH_Dgraph scGraph;
90  SCOTCH_CALL(SCOTCH_dgraphInit, (&scGraph, mpiComm->GetComm()));
91  SCOTCH_CALL(SCOTCH_dgraphBuild,
92  (&scGraph, 0, nVerts, nVerts, &xadj[0], &xadj[1], &vertWgt[0],
93  NULL, adjcy.size(), adjcy.size(), &adjcy[0], NULL, NULL));
94  SCOTCH_CALL(SCOTCH_dgraphCheck, (&scGraph));
95 
96  SCOTCH_Strat strat;
97  SCOTCH_CALL(SCOTCH_stratInit, (&strat));
98  SCOTCH_CALL(SCOTCH_stratDgraphMapBuild,
99  (&strat, SCOTCH_STRATQUALITY, nparts, nparts, 0.05));
100 
101  SCOTCH_CALL(SCOTCH_dgraphPart, (&scGraph, nparts, &strat, &part[0]));
102 }
103 
104 } // namespace SpatialDomains
105 } // namespace Nektar
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:215
#define SCOTCH_CALL(scotchFunc, args)
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
static std::string RegisterCmdLineFlag(const std::string &pName, const std::string &pShortName, const std::string &pDescription)
Registers a command-line flag with the session reader.
LibUtilities::CommSharedPtr m_comm
virtual void v_PartitionGraphImpl(int &nVerts, int &nVertConds, Nektar::Array< Nektar::OneD, int > &xadj, Nektar::Array< Nektar::OneD, int > &adjcy, Nektar::Array< Nektar::OneD, int > &vertWgt, Nektar::Array< Nektar::OneD, int > &vertSize, Nektar::Array< Nektar::OneD, int > &edgeWgt, int &nparts, int &volume, Nektar::Array< Nektar::OneD, int > &part) override final
static MeshPartitionSharedPtr create(const LibUtilities::SessionReaderSharedPtr session, LibUtilities::CommSharedPtr comm, int meshDim, std::map< int, MeshEntity > element, CompositeDescriptor compMap)
Creates an instance of this class.
MeshPartitionPtScotch(const LibUtilities::SessionReaderSharedPtr session, LibUtilities::CommSharedPtr comm, int meshDim, std::map< int, MeshEntity > element, CompositeDescriptor compMap)
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< CommMpi > CommMpiSharedPtr
Pointer to a Communicator object.
Definition: CommMpi.h:55
std::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:54
std::map< int, std::pair< LibUtilities::ShapeType, std::vector< int > > > CompositeDescriptor
Definition: MeshGraph.h:63
MeshPartitionFactory & GetMeshPartitionFactory()
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2