MeshDistributor.h 20.6 KB
Newer Older
1
2
3
4
5
6
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
7
// ==  TU Dresden                                                            ==
8
// ==                                                                        ==
9
10
11
// ==  Institut fr Wissenschaftliches Rechnen                               ==
// ==  Zellescher Weg 12-14                                                  ==
// ==  01069 Dresden                                                         ==
12
13
14
15
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
16
// ==  https://gforge.zih.tu-dresden.de/projects/amdis/                      ==
17
18
19
// ==                                                                        ==
// ============================================================================

20
/** \file MeshDistributor.h */
21

22
23
#ifndef AMDIS_MESHDISTRIBUTOR_H
#define AMDIS_MESHDISTRIBUTOR_H
24
25
26


#include <map>
27
#include <set>
28
#include <vector>
Thomas Witkowski's avatar
Thomas Witkowski committed
29
#include <mpi.h>
30

Thomas Witkowski's avatar
Thomas Witkowski committed
31
#include "parallel/InteriorBoundary.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
32
#include "Global.h"
33
34
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
35
#include "FiniteElemSpace.h"
36
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
37
#include "BoundaryManager.h"
38
#include "ElementObjectData.h"
39
40
#include "AMDiS_fwd.h"

41
namespace AMDiS {
42
  
43
44
  class ParMetisPartitioner;

45
  class MeshDistributor
46
  {
47
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
48
49
50
51
52
53
54
55
56
57
58
59
    /// Defines a mapping type from DOFs to rank numbers.
    typedef std::map<const DegreeOfFreedom*, int> DofToRank;

    /// Defines a mapping type from DOFs to a set of rank numbers.
    typedef std::map<const DegreeOfFreedom*, std::set<int> > DofToPartitions;

    /// Defines a mapping type from rank numbers to sets of DOFs.
    typedef std::map<int, DofContainer> RankToDofContainer;

    /// Defines a mapping type from DOF indices to DOF indices.
    typedef std::map<DegreeOfFreedom, DegreeOfFreedom> DofMapping;

60
61
62
    /// Defines a mapping type from DOFs to boolean values.
    typedef std::map<const DegreeOfFreedom*, bool> DofToBool;

Thomas Witkowski's avatar
Thomas Witkowski committed
63
    /// Defines a mapping type from DOF indices to boolean values.
64
    typedef std::map<DegreeOfFreedom, bool> DofIndexToBool;
Thomas Witkowski's avatar
Thomas Witkowski committed
65

Thomas Witkowski's avatar
Thomas Witkowski committed
66
67
68
    /// Forward type (it maps rank numbers to the interior boundary objects).
    typedef InteriorBoundary::RankToBoundMap RankToBoundMap;

Thomas Witkowski's avatar
Thomas Witkowski committed
69
70
    typedef std::map<const DegreeOfFreedom*, DegreeOfFreedom> DofIndexMap;

71
72
73
    /// Mapps a boundar type, i.e., a boundary identifier index, to a periodic 
    /// dof mapping.
    typedef std::map<BoundaryType, DofMapping> PeriodicDofMap;
74
75
    
    typedef std::vector<MeshStructure> MeshCodeVec;
76

77
  public:
78
79
80
    MeshDistributor(std::string str);
		          
    virtual ~MeshDistributor() {}
81

82
    void initParallelization();
83

84
    void exitParallelization();
85
86

    void addProblemStat(ProblemVec *probVec);
87

88
89
90
91
92
93
94
95
96
    /** \brief
     * This function checks if the mesh has changed on at least on rank. In this case,
     * the interior boundaries are adapted on all ranks such that they fit together on
     * all ranks. Furthermore the function \ref updateLocalGlobalNumbering() is called
     * to update the dof numberings and mappings on all rank due to the new mesh
     * structure.
     */
    void checkMeshChange();

97
98
99
100
101
102
103
    /** \brief
     * Test, if the mesh consists of macro elements only. The mesh partitioning of
     * the parallelization works for macro meshes only and would fail, if the mesh
     * is already refined in some way. Therefore, this function will exit the program
     * if it finds a non macro element in the mesh.
     */
    void testForMacroMesh();
104
105

    /// Set for each element on the partitioning level the number of leaf elements.
106
    void setInitialElementWeights();
107

108
109
110
111
    inline virtual std::string getName() 
    { 
      return name; 
    }
112
113
114
115
116
117

    /// Returns \ref feSpace.
    inline const FiniteElemSpace* getFeSpace()
    {
      return feSpace;
    }
118
119
120
    
    /// Returns \ref nRankDOFs, the number of DOFs in the rank mesh.
    inline int getNumberRankDofs() 
121
    {
122
      return nRankDofs;
123
    }
124

125
    /// Returns \ref nOverallDofs, the global number of DOFs.
126
    inline int getNumberOverallDofs()
127
    {
128
      return nOverallDofs;
129
    }
130

131
    /// Maps a local dof to its global index.
132
    inline DegreeOfFreedom mapLocalToGlobal(DegreeOfFreedom dof)
133
    {
134
      return mapLocalGlobalDofs[dof];
135
    }
136

137
    /// Maps a local dof to its local index.
138
139
140
141
142
    inline DegreeOfFreedom mapLocalToDofIndex(DegreeOfFreedom dof)
    {
      return mapLocalDofIndex[dof];
    }

143
144
    /// Returns for a global dof index its periodic mapping for a given boundary type.
    inline int getPeriodicMapping(BoundaryType type, int globalDofIndex)
145
    {
146
147
148
149
150
151
      TEST_EXIT_DBG(periodicDof[type].count(globalDofIndex) == 1)
	("Should not happen!\n");

      return periodicDof[type][globalDofIndex];
    }

152
153
154
    /// For a given global DOF index, this function returns the set of periodic
    /// associations, i.e., the boundary types the DOF is associated to, for this DOF.
    inline std::set<BoundaryType>& getPerDofAssociations(int globalDofIndex)
155
    {      
156
      return periodicDofAssociations[globalDofIndex];
157
    }
158

159
    /// Returns true, if the DOF (global index) is a periodic DOF.
160
    inline bool isPeriodicDof(int globalDofIndex)
161
    {
162
      return (periodicDofAssociations.count(globalDofIndex) > 0);
163
164
    }

165
166
167
    /// Returns true, if the DOF (global index) is a periodic DOF for the given
    /// boundary type.
    inline bool isPeriodicDof(int globalDofIndex, BoundaryType type)
168
169
    {
      return (periodicDof[type].count(globalDofIndex) > 0);
170
171
    }

172
173
    /// Return true, if the given DOF is owned by the rank. If false, the DOF is in
    /// rank's partition, but is owned by some other rank.
174
175
176
177
    inline bool getIsRankDof(DegreeOfFreedom dof)
    {
      return isRankDof[dof];
    }
178

179
    inline long getLastMeshChangeIndex()
180
    {
181
      return lastMeshChangeIndex;
182
    }
183

184
185
186
187
    inline int getRstart()
    {
      return rstart;
    }
188

189
    inline int getMpiRank()
190
    {
191
      return mpiRank;
192
    }
193

194
195
196
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
197
198
    }

199
    inline RankToDofContainer& getSendDofs()
200
    {
201
      return sendDofs;
202
203
    }

204
    inline RankToDofContainer& getRecvDofs()
205
    {
206
      return recvDofs;
207
    }
208

209
    // Writes all data of this object to an output stream.
210
    void serialize(std::ostream &out);
211

212
    // Reads the object data from an input stream.
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
    void deserialize(std::istream &in);

    /** \brief
     * This function must be used if the values of a DOFVector must be synchronised
     * over all ranks. That means, that each rank sends the values of the DOFs, which
     * are owned by the rank and lie on an interior bounday, to all other ranks also
     * having these DOFs.
     *
     * This function must be used, for example, after the lineary system is solved, or
     * after the DOFVector is set by some user defined functions, e.g., initial
     * solution functions.
     */    
    void synchVector(DOFVector<double> &vec);

    /** \brief
     * Works in the same way as the function above defined for DOFVectors. Due to
     * performance, this function does not call \ref synchVector for each DOFVector,
     * but instead sends all values of all DOFVectors all at once.
     */
    void synchVector(SystemVector &vec);

234
  protected:
235
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
236
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
237
238
     * all information about them in \ref interiorBoundary.
     */
239
    void createInteriorBoundaryInfo();
240

Thomas Witkowski's avatar
Thomas Witkowski committed
241
242
243
244
245
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

    void createBoundaryData();
Thomas Witkowski's avatar
Thomas Witkowski committed
246

247
248
249
    /// Removes all macro elements from the mesh that are not part of ranks partition.
    void removeMacroElements();

250
    /// Updates the local and global DOF numbering after the mesh has been changed.
251
    void updateLocalGlobalNumbering();
252

253
254
255
256
257
    /** \brief
     * Creates to all dofs in rank's partition that are on a periodic boundary the
     * mapping from dof index to the other periodic dof indices. This information
     * is stored in \ref periodicDof.
     */
258
259
    void createPeriodicMap();

260
261
    void createMacroElementInfo();

262
263
264
265
266
267
268
269
270
271
272
273
274
    /** \brief
     * Checks for all given interior boundaries if the elements fit together on both
     * sides of the boundaries. If this is not the case, the mesh is adapted. Because
     * refinement of a certain element may forces the refinement of other elements,
     * it is not guaranteed that all rank's meshes fit together after this function
     * terminates. Hence, it must be called until a stable mesh refinement is reached.
     * If the mesh has  been changed by this function, it returns true. Otherwise, it
     * returns false, i.e., the given interior boundaries fit together on both sides.
     *
     * \param[in] allBound   Defines a map from rank to interior boundaries which 
     *                       should be checked.
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
275
276
277
278
279
280
281
282
  
    /** \brief
     * Checks if is required to repartition the mesh. If this is the case, a new
     * partition will be created and the mesh will be redistributed between the
     * ranks.
     */
    void repartitionMesh();

283
284
285
286
287
288
289
    /** \brief
     * This functions create a Paraview file with the macro mesh where the elements
     * are colored by the partition they are part of. This function can be used for
     * debugging.
     */
    void writePartitioningMesh(std::string filename);

290
291
292
    /// Sets \ref isRankDof to all matrices and rhs vectors in all stationary problems.
    void setRankDofs();

293
294
295
296
    /// Removes all periodic boundary condition information from all matrices and
    /// vectors of all stationary problems and from the mesh itself.
    void removePeriodicBoundaryConditions();

Thomas Witkowski's avatar
Thomas Witkowski committed
297
    // Removes all periodic boundaries from a given boundary map.
298
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
299

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    /** \brief
     * Starts the procedure to fit a given edge/face of an element with a mesh
     * structure code. This functions prepares some data structures and call
     * then \ref fitElementToMeshCode, that mainly refines the element such that
     * it fits to the mesh structure code.
     *
     * \param[in] code         The mesh structure code to which the edge/face of
     *                         an element must be fitted.
     * \param[in] el           Pointer to the element.
     * \param[in] subObj       Defines whether an edge or a face must be fitted.
     * \param[in] ithObj       Defines which edge/face must be fitted.
     * \param[in] elType       Element type of the element (only important in 3D).
     * \param[in] reverseMode  Defines, whether the mesh structure code is given
     *                         in reverse mode, i.e., left and right children where
     *                         changed when the code was created.
     */
    bool startFitElementToMeshCode(MeshStructure &code, 
				   Element *el, 
				   GeoIndex subObj,
				   int ithObj, 
				   int elType,
				   bool reverseMode);
    
    /** \brief
     * Recursively fits a given mesh structure code to an edge/face of an element.
     * This function is always initialy called from \ref startFitElementToMeshCode.
     *
     * \param[in] code         The mesh structure code which is used to fit an
     *                         edge/face of an element.
     * \param[in] stack        A traverse stack object. The upper most element in this
     *                         stack must be used for fitting the mesh structure code
     *                         at the current position.
     * \param[in] subObj       Defines whether an edge or a face must be fitted.
     * \param[in] ithObj       Defines which edge/face must be fitted.
     * \param[in] reverseMode  Defines, whether the mesh structure code is given
     *                         in reverse mode, i.e., left and right children where
     *                         changed when the code was created.
     */
338
    bool fitElementToMeshCode(MeshStructure &code, 
339
			      TraverseStack &stack,
340
			      GeoIndex subObj,
341
			      int ithObj,
342
			      bool reverseMode);
343

344
345
346
347
348
349
350
351
352
353
354
355
356
    /// Writes a vector of dof pointers to an output stream.
    void serialize(std::ostream &out, DofContainer &data);

    /// Reads a vector of dof pointers from an input stream.
    void deserialize(std::istream &in, DofContainer &data,
		     std::map<int, const DegreeOfFreedom*> &dofMap);

    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(std::ostream &out, RankToDofContainer &data);

    /// Reads a \ref RankToDofContainer from an input stream.
    void deserialize(std::istream &in, RankToDofContainer &data,
		     std::map<int, const DegreeOfFreedom*> &dofMap);
357

358
359
360
    /// Writes a periodic dof mapping to an output stream.
    void serialize(std::ostream &out, PeriodicDofMap &data);

361
362
    void serialize(std::ostream &out, std::map<int, std::set<int> >& data);

363
364
365
    /// Reads a periodic dof mapping from an input stream.
    void deserialize(std::istream &in, PeriodicDofMap &data);

366
367
    void deserialize(std::istream &in, std::map<int, std::set<int> >& data);

368
369
370
371
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
    void serialize(std::ostream &out, std::map<const DegreeOfFreedom*, T> &data)
    {
372
373
      FUNCNAME("ParallelDomainBase::serialize()");

374
      int mapSize = data.size();
375
      SerUtil::serialize(out, mapSize);
376
377
378
379
      for (typename std::map<const DegreeOfFreedom*, T>::iterator it = data.begin();
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
380
381
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
382
383
384
385
386
387
388
389
      }
    }

    /// Reads a mapping from dof pointer to some values from an input stream.
    template<typename T>
    void deserialize(std::istream &in, std::map<const DegreeOfFreedom*, T> &data,
		     std::map<int, const DegreeOfFreedom*> &dofMap)
    {
390
391
      FUNCNAME("ParallelDomainBase::deserialize()");

392
      int mapSize = 0;
393
      SerUtil::deserialize(in, mapSize);
394
395
396
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
397
398
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
399
400
401

	TEST_EXIT_DBG(dofMap.count(v1) != 0)("Cannot find DOF %d in map!\n", v1);

402
403
404
	data[dofMap[v1]] = v2;
      }
    }
405
406

  public:
407
    std::vector<DOFVector<double>* > testVec;
408
		        
409
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
410
    ///
411
    std::vector<ProblemVec*> probStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
412

413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

    /** \brief
     * MPI communicator collected all processes, which should
     * be used for calculation. The Debug procces is not included
     * in this communicator.
     */
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
    std::string name;

429
430
431
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

432
433
434
    /// Mesh of the problem.
    Mesh *mesh;

435
436
437
438
439
440
441
    /** \brief
     * A refinement manager that should be used on the mesh. It is used to refine
     * elements at interior boundaries in order to fit together with elements on the
     * other side of the interior boundary.
     */    
    RefinementManager *refineManager;

442
443
444
    /// Info level.
    int info;

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
    /// Pointer to the paritioner which is used to devide a mesh into partitions.
    ParMetisPartitioner *partitioner;

    /// Weights for the elements, i.e., the number of leaf elements within this element.
    std::map<int, double> elemWeights;

    /** \brief
     * Stores to every coarse element index the number of the partition it 
     * corresponds to.
     */
    std::map<int, int> partitionVec;

    /** \brief
     * Stores an old partitioning of elements. To every element index the number
     * of the parition it corresponds to is stored.
     */
    std::map<int, int> oldPartitionVec;    
462
   
463
    /// Number of DOFs in the rank mesh.
464
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
465

466
    /// Number of DOFs in the whole domain.
467
468
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
    // Data structure to store all sub-objects of all elements of the macro mesh.
    ElementObjects elObjects;

    // Maps to each macro element index a pointer to the corresponding element.
    std::map<int, Element*> macroElIndexMap;
    
    // Maps to each macro element index the type of this element.
    std::map<int, int> macroElIndexTypeMap;

    // The following three data structures store periodic DOFs, edges and faces.
    std::map<std::pair<DegreeOfFreedom, DegreeOfFreedom>, BoundaryType> periodicDofs;
    std::map<std::pair<DofEdge, DofEdge>, BoundaryType> periodicEdges;
    std::map<std::pair<DofFace, DofFace>, BoundaryType> periodicFaces;

    // Stores to each DOF all its periodic associations.
    std::map<DegreeOfFreedom, std::set<BoundaryType> > periodicDofAssoc;


Thomas Witkowski's avatar
Thomas Witkowski committed
487
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
488
489
490
491
492
493
494
495
496
497
498
499
     * Defines the interior boundaries of the domain that result from partitioning
     * the whole mesh. Contains only the boundaries, which are owned by the rank, i.e.,
     * the object gives for every neighbour rank i the boundaries this rank owns and 
     * shares with rank i.
     */
    InteriorBoundary myIntBoundary;
    
    /** \brief
     * Defines the interior boundaries of the domain that result from partitioning
     * the whole mesh. Contains only the boundaries, which are not owned by the rank,
     * i.e., the object gives for every neighbour rank i the boundaries that are
     * owned by rank i and are shared with this rank.
Thomas Witkowski's avatar
Thomas Witkowski committed
500
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
501
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
502

503
    /** \brief
504
505
     * Defines the periodic boundaries with other ranks. Periodic boundaries have
     * no owner, as it is the case of interior boundaries.
506
507
508
     */
    InteriorBoundary periodicBoundary;

509
510
511
512
    /** \brief
     * This map contains for each rank the list of dofs the current rank must send
     * to exchange solution dofs at the interior boundaries.
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
513
    RankToDofContainer sendDofs;
514
515

    /** \brief
516
517
518
     * This map contains for each rank the list of DOFs from which the current rank 
     * will receive DOF values (i.e., this are all DOFs at an interior boundary). The
     * DOF indices are given in rank's local numbering.
519
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
520
    RankToDofContainer recvDofs;
521
522

    /// Maps local to global dof indices.
523
    DofMapping mapLocalGlobalDofs;
524

Thomas Witkowski's avatar
Thomas Witkowski committed
525
    /// Maps local dof indices to real dof indices.
526
    DofMapping mapLocalDofIndex;  
527
528
529
530
531
532

    /** \brief
     * Maps all DOFs in ranks partition to a bool value. If it is true, the DOF is
     * owned by the rank. Otherwise, its an interior boundary DOF that is owned by
     * another rank.
     */
533
534
    DofIndexToBool isRankDof;

535
    /** \brief
536
537
538
539
     * If periodic boundaries are used, this map stores, for each periodic boundary
     * type, for all DOFs in rank's partition (that are on periodic boundaries), the 
     * corresponding mapped periodic DOFs. The mapping is defined by using global 
     * dof indices.
540
     */
541
    PeriodicDofMap periodicDof;
542
543
544
545
546
547
548
549
    
    /** \brief
     * If periodic boundaries are used, this map stores to each periodic DOF in rank's
     * partition the set of periodic boundaries the DOF is associated to. In 2D, most
     * DOFs are only on one periodic boundary. Only, e.g., in a box with all boundaries
     * being periodic, the for corners are associated by two different boundaries.     
     */
    std::map<int, std::set<BoundaryType> > periodicDofAssociations;
550

551
    /// Is the index of the first row of the linear system, which is owned by the rank.
Thomas Witkowski's avatar
n    
Thomas Witkowski committed
552
    int rstart;
553

554
555
556
557
558
559
560
    /** \brief
     * If the problem definition has been read from a serialization file, this 
     * variable is true, otherwise it is false. This variable is used to stop the
     * initialization function, if the problem definition has already been read from
     * a serialization file.
     */
    bool deserialized;
561

562
563
564
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

565
566
567
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

568
569
    int nTimestepsAfterLastRepartitioning;

570
571
    int repartCounter;

572
573
574
575
576
    /** \brief
     * Stores the mesh change index. This is used to recognize changes in the mesh 
     * structure (e.g. through refinement or coarsening managers).
     */
    long lastMeshChangeIndex;
577

578
579
    std::map<int, std::vector<int> > macroElementNeighbours;

580
    friend class ParallelDebug;
581
582
583
  };
}

584
#endif // AMDIS_MESHDISTRIBUTOR_H