MeshDistributor.h 18.2 KB
Newer Older
1
2
3
4
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
5
// ==  http://www.amdis-fem.org                                              ==
6
7
// ==                                                                        ==
// ============================================================================
8
9
10
11
12
13
14
15
16
17
18
19
//
// Software License for AMDiS
//
// Copyright (c) 2010 Dresden University of Technology 
// All rights reserved.
// Authors: Simon Vey, Thomas Witkowski et al.
//
// This file is part of AMDiS
//
// See also license.opensource.txt in the distribution.


20

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

23
24
#ifndef AMDIS_MESHDISTRIBUTOR_H
#define AMDIS_MESHDISTRIBUTOR_H
25
26
27


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

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

42
namespace AMDiS {
43
44

  using namespace std;
45
  
46
47
  class ParMetisPartitioner;

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

    /// Defines a mapping type from DOFs to a set of rank numbers.
55
    typedef map<const DegreeOfFreedom*, std::set<int> > DofToPartitions;
Thomas Witkowski's avatar
Thomas Witkowski committed
56
57

    /// Defines a mapping type from rank numbers to sets of DOFs.
58
    typedef map<int, DofContainer> RankToDofContainer;
Thomas Witkowski's avatar
Thomas Witkowski committed
59
60

    /// Defines a mapping type from DOF indices to DOF indices.
61
    typedef map<DegreeOfFreedom, DegreeOfFreedom> DofMapping;
Thomas Witkowski's avatar
Thomas Witkowski committed
62

63
    /// Defines a mapping type from DOFs to boolean values.
64
    typedef map<const DegreeOfFreedom*, bool> DofToBool;
65

Thomas Witkowski's avatar
Thomas Witkowski committed
66
    /// Defines a mapping type from DOF indices to boolean values.
67
    typedef map<DegreeOfFreedom, bool> DofIndexToBool;
Thomas Witkowski's avatar
Thomas Witkowski committed
68

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

72
    typedef map<const DegreeOfFreedom*, DegreeOfFreedom> DofIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
73

74
75
    /// Mapps a boundar type, i.e., a boundary identifier index, to a periodic 
    /// dof mapping.
76
77
78
    typedef map<BoundaryType, DofMapping> PeriodicDofMap;

    typedef vector<MeshStructure> MeshCodeVec;
79

80
  public:
81
    MeshDistributor(string str);
82
83
		          
    virtual ~MeshDistributor() {}
84

85
    void initParallelization();
86

87
    void exitParallelization();
88
89

    void addProblemStat(ProblemVec *probVec);
90

91
92
93
94
95
96
97
98
99
    /** \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();

100
101
102
103
104
105
106
    /** \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();
107
108

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

111
    inline virtual string getName() 
112
113
114
    { 
      return name; 
    }
115

Thomas Witkowski's avatar
Thomas Witkowski committed
116
117
118
119
120
    inline Mesh* getMesh()
    {
      return mesh;
    }

121
122
123
124
125
    /// Returns \ref feSpace.
    inline const FiniteElemSpace* getFeSpace()
    {
      return feSpace;
    }
126
127
128
    
    /// Returns \ref nRankDOFs, the number of DOFs in the rank mesh.
    inline int getNumberRankDofs() 
129
    {
130
      return nRankDofs;
131
    }
132

133
    /// Returns \ref nOverallDofs, the global number of DOFs.
134
    inline int getNumberOverallDofs()
135
    {
136
      return nOverallDofs;
137
    }
138

Thomas Witkowski's avatar
Thomas Witkowski committed
139
140
141
142
143
    inline DofMapping& getMapLocalGlobalDofs()
    {
      return mapLocalGlobalDofs;
    }

144
    /// Maps a local dof to its global index.
145
    inline DegreeOfFreedom mapLocalToGlobal(DegreeOfFreedom dof)
146
    {
147
      return mapLocalGlobalDofs[dof];
148
    }
149

150
151
    DegreeOfFreedom mapGlobalToLocal(DegreeOfFreedom dof);

152
    /// Maps a local dof to its local index.
153
154
155
156
157
    inline DegreeOfFreedom mapLocalToDofIndex(DegreeOfFreedom dof)
    {
      return mapLocalDofIndex[dof];
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
158
159
160
161
162
163
    /// Returns the periodic mapping for all boundary DOFs in rank.
    inline PeriodicDofMap& getPeriodicMapping()
    {
      return periodicDof;
    }

164
    /// Returns for a global dof index its periodic mapping for a given boundary type.
165
    inline int getPeriodicMapping(int globalDofIndex, BoundaryType type)
166
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
167
168
      FUNCNAME("MeshDistributor::getPeriodicMapping()");

169
      TEST_EXIT_DBG(periodicDof[type].count(globalDofIndex) == 1)
Thomas Witkowski's avatar
Thomas Witkowski committed
170
171
	("There is no periodic association for global DOF %d for boundary type %d!\n",
	 globalDofIndex, type);
172
173
174
175

      return periodicDof[type][globalDofIndex];
    }

176
177
178
    /// 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)
179
    {      
180
181
182
      TEST_EXIT_DBG(periodicDofAssociations.count(globalDofIndex)) 
 	("Should not happen!\n"); 

183
      return periodicDofAssociations[globalDofIndex];
184
    }
185

186
    /// Returns true, if the DOF (global index) is a periodic DOF.
187
    inline bool isPeriodicDof(int globalDofIndex)
188
    {
189
190
      return (periodicDofAssociations.count(globalDofIndex) > 0 &&
	       periodicDofAssociations[globalDofIndex].size() > 0);
191
192
    }

193
194
195
    /// Returns true, if the DOF (global index) is a periodic DOF for the given
    /// boundary type.
    inline bool isPeriodicDof(int globalDofIndex, BoundaryType type)
196
197
    {
      return (periodicDof[type].count(globalDofIndex) > 0);
198
199
    }

200
201
    /// 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.
202
203
204
205
    inline bool getIsRankDof(DegreeOfFreedom dof)
    {
      return isRankDof[dof];
    }
206

207
    inline long getLastMeshChangeIndex()
208
    {
209
      return lastMeshChangeIndex;
210
    }
211

212
213
214
215
    inline int getRstart()
    {
      return rstart;
    }
216

217
    inline int getMpiRank()
218
    {
219
      return mpiRank;
220
    }
221

Thomas Witkowski's avatar
Thomas Witkowski committed
222
223
224
225
226
    inline int getMpiSize()
    {
      return mpiSize;
    }

227
228
229
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
230
231
    }

232
    inline RankToDofContainer& getSendDofs()
233
    {
234
      return sendDofs;
235
236
    }

237
    inline RankToDofContainer& getRecvDofs()
238
    {
239
      return recvDofs;
240
    }
241

242
    // Writes all data of this object to an output stream.
243
    void serialize(ostream &out);
244

245
    // Reads the object data from an input stream.
246
    void deserialize(istream &in);
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

    /** \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);

267
  protected:
268
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
269
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
270
271
     * all information about them in \ref interiorBoundary.
     */
272
    void createInteriorBoundaryInfo();
273

Thomas Witkowski's avatar
Thomas Witkowski committed
274
275
276
277
278
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

280
281
282
    /// Removes all macro elements from the mesh that are not part of ranks partition.
    void removeMacroElements();

283
    /// Updates the local and global DOF numbering after the mesh has been changed.
284
    void updateLocalGlobalNumbering();
285

286
287
288
289
290
    /** \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.
     */
291
292
    void createPeriodicMap();

293
294
    void createMacroElementInfo();

295
296
    void updateMacroElementInfo();

297
298
299
300
301
302
303
304
305
306
307
308
309
    /** \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);
310
311
312
313
314
315
316
317
  
    /** \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();

318
319
320
321
322
    /** \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.
     */
323
    void writePartitioningMesh(string filename);
324

325
326
327
    /// Sets \ref isRankDof to all matrices and rhs vectors in all stationary problems.
    void setRankDofs();

328
329
330
331
    /// 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
332
    // Removes all periodic boundaries from a given boundary map.
333
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
334

335
    /// Writes a vector of dof pointers to an output stream.
336
    void serialize(ostream &out, DofContainer &data);
337
338

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

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

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

349
    /// Writes a periodic dof mapping to an output stream.
350
    void serialize(ostream &out, PeriodicDofMap &data);
351

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

354
    /// Reads a periodic dof mapping from an input stream.
355
    void deserialize(istream &in, PeriodicDofMap &data);
356

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

359
360
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
361
    void serialize(ostream &out, map<const DegreeOfFreedom*, T> &data)
362
    {
363
364
      FUNCNAME("ParallelDomainBase::serialize()");

365
      int mapSize = data.size();
366
      SerUtil::serialize(out, mapSize);
367
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
368
369
370
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
371
372
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
373
374
375
376
377
      }
    }

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

383
      int mapSize = 0;
384
      SerUtil::deserialize(in, mapSize);
385
386
387
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
388
389
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
390
391
392

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

393
394
395
	data[dofMap[v1]] = v2;
      }
    }
396
397

  public:
398
    vector<DOFVector<double>* > testVec;
399
		        
400
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
401
    ///
402
    vector<ProblemVec*> probStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
403

404
405
406
407
408
409
410
411
412
413
414
415
416
417
    /// 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)
418
    string name;
419

420
421
422
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

423
424
425
    /// Mesh of the problem.
    Mesh *mesh;

426
427
428
429
430
431
432
    /** \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;

433
434
435
    /// Info level.
    int info;

436
437
438
439
    /// 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.
440
    map<int, double> elemWeights;
441
442

    /** \brief
443
444
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
445
     */
446
    map<int, int> partitionVec;
447
448

    /** \brief
449
450
     * Stores an old partitioning of elements. To every macro element index the
     * number of the rank it corresponds to is stored.
451
     */
452
    map<int, int> oldPartitionVec;    
453
   
454
    /// Number of DOFs in the rank mesh.
455
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
456

457
    /// Number of DOFs in the whole domain.
458
459
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
460
461
462
463
    // 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.
464
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
465
466
    
    // Maps to each macro element index the type of this element.
467
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
468

Thomas Witkowski's avatar
Thomas Witkowski committed
469
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
470
471
472
473
474
475
476
477
478
479
480
481
     * 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
482
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
483
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
484

485
    /** \brief
486
487
     * Defines the periodic boundaries with other ranks. Periodic boundaries have
     * no owner, as it is the case of interior boundaries.
488
489
490
     */
    InteriorBoundary periodicBoundary;

491
492
493
494
    /** \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
495
    RankToDofContainer sendDofs;
496
497

    /** \brief
498
499
500
     * 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.
501
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
502
    RankToDofContainer recvDofs;
503
504

    /// Maps local to global dof indices.
505
    DofMapping mapLocalGlobalDofs;
506

Thomas Witkowski's avatar
Thomas Witkowski committed
507
    /// Maps local dof indices to real dof indices.
508
    DofMapping mapLocalDofIndex;  
509
510
511
512
513
514

    /** \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.
     */
515
516
    DofIndexToBool isRankDof;

517
    /** \brief
518
519
520
521
     * 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.
522
     */
523
    PeriodicDofMap periodicDof;
524
525
526
527
528
529
530
    
    /** \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.     
     */
531
    map<int, std::set<BoundaryType> > periodicDofAssociations;
532

533
    /// 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
534
    int rstart;
535

536
537
538
539
540
541
542
    /** \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;
543

544
545
546
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

547
548
549
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

550
551
    int repartitionIthChange;

552
553
    int nTimestepsAfterLastRepartitioning;

554
555
    int repartCounter;

556
    /// Directory name where all debug output files should be written to.
557
    string debugOutputDir;
558

559
560
561
562
563
    /** \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;
564

565
    map<int, vector<int> > macroElementNeighbours;
566

567
568
    /// Store all macro elements of the overall mesh, i.e., before the macro mesh is
    /// redistributed for the first time.
569
    vector<MacroElement*> allMacroElements;
570

571
    friend class ParallelDebug;
572
573
574
  };
}

575
#endif // AMDIS_MESHDISTRIBUTOR_H