MeshDistributor.h 19.8 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


Thomas Witkowski's avatar
Thomas Witkowski committed
27
#include <mpi.h>
28
#include "parallel/DofComm.h"
29
#include "parallel/ElementObjectDatabase.h"
30
#include "parallel/ParallelTypes.h"
31
#include "parallel/MeshLevelData.h"
32
#include "parallel/MeshPartitioner.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
33
#include "parallel/InteriorBoundary.h"
34
#include "parallel/ParallelDofMapping.h"
35
#include "parallel/PeriodicMap.h"
36
#include "parallel/StdMpi.h"
37
#include "AMDiS_fwd.h"
38
#include "Containers.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
39
#include "Global.h"
40 41
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
42
#include "FiniteElemSpace.h"
43
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
44
#include "BoundaryManager.h"
45
#include "SystemVector.h"
46

47
namespace AMDiS {
48 49

  using namespace std;
Thomas Witkowski's avatar
Thomas Witkowski committed
50 51 52 53


  struct BoundaryDofInfo
  {
54
    map<GeoIndex, DofContainerSet> geoDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
55 56
  };

57

58
  class MeshDistributor
59
  {
60
  private:
61
    MeshDistributor();
62
	          
63
    virtual ~MeshDistributor() {}
64

65
  public:
66
    void initParallelization();
67

68
    void exitParallelization();
69

70 71 72
    /// Adds a DOFVector to the set of \ref interchangeVecs. Thus, this vector 
    /// will be automatically interchanged between ranks when mesh is 
    /// repartitioned.
73 74 75 76 77
    void addInterchangeVector(DOFVector<double> *vec)
    {
      interchangeVectors.push_back(vec);
    }

78 79 80 81 82 83 84
    /// Adds all DOFVectors of a SystemVector to \ref interchangeVecs.
    void addInterchangeVector(SystemVector *vec)
    {
      for (int i = 0; i < vec->getSize(); i++)
	interchangeVectors.push_back(vec->getDOFVector(i));
    }
    
85
    /** \brief
86 87 88 89 90
     * 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.
91
     *
92 93 94 95 96
     * \param[in]  tryRepartition   If this parameter is true, repartitioning 
     *                              may be done. This depends on several other 
     *                              parameters. If the parameter is false, the 
     *                              mesh is only checked and adapted but never 
     *                              repartitioned.
97
     */
98
    void checkMeshChange(bool tryRepartition = true);
99

100 101 102 103 104 105 106 107 108 109
    /** \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();
    
    /// Calculates the imbalancing factor and prints it to screen.
    void printImbalanceFactor();

110
    /** \brief
111 112 113 114
     * 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.
115 116
     */
    void testForMacroMesh();
117

118 119
    /// Set for each element on the partitioning level the number of 
    /// leaf elements.
120
    void setInitialElementWeights();
121

122
    inline virtual string getName() 
123 124 125
    { 
      return name; 
    }
126

Thomas Witkowski's avatar
Thomas Witkowski committed
127 128 129 130 131
    inline Mesh* getMesh()
    {
      return mesh;
    }

132 133
    /// Returns an FE space from \ref feSpaces.
    inline const FiniteElemSpace* getFeSpace(unsigned int i = 0)
134
    {
135 136 137 138 139
      FUNCNAME("MeshDistributor::getFeSpace()");

      TEST_EXIT_DBG(i < feSpaces.size())("Should not happen!\n");

      return feSpaces[i];
140
    }
141 142 143 144 145 146 147

    /// Returns all FE spaces, thus \ref feSpaces.
    inline vector<const FiniteElemSpace*>& getFeSpaces()
    {
      return feSpaces;
    }

148 149
    /// Returns the DOF mapping object, \ref dofMap.
    inline ParallelDofMapping& getDofMap()
Thomas Witkowski's avatar
Thomas Witkowski committed
150
    {
151
      return dofMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
152 153
    }

154 155
    /// Returns the periodic mapping handler, \ref periodicMap.
    inline PeriodicMap& getPeriodicMap()
156
    {
157
      return periodicMap;
158
    }
159

160 161
    /// Returns for a global index the DOF index in rank's subdomain. As there
    /// is no direct data structure that stores this information, we have to
Thomas Witkowski's avatar
Thomas Witkowski committed
162 163
    /// search for it in \ref dofMap. This is not very efficient and this 
    /// function should thus be used for debugging only.
164 165
    DegreeOfFreedom mapGlobalToLocal(const FiniteElemSpace *feSpace,
				     DegreeOfFreedom dof);
166

167
    DofComm& getSendDofs()
168 169 170 171
    {
      return sendDofs;
    }

172
    DofComm& getRecvDofs()
173 174 175 176
    {
      return recvDofs;
    }

177 178 179 180 181
    DofComm& getPeriodicDofs()
    {
      return periodicDofs;
    }

182
    inline long getLastMeshChangeIndex()
183
    {
184
      return lastMeshChangeIndex;
185
    }
186

187
    inline int getMpiRank()
188
    {
189
      return mpiRank;
190
    }
191

Thomas Witkowski's avatar
Thomas Witkowski committed
192 193 194 195 196
    inline int getMpiSize()
    {
      return mpiSize;
    }

197 198 199
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
200 201
    }

202 203 204 205 206
    inline bool isInitialized()
    {
      return initialized;
    }

207
    // Writes all data of this object to an output stream.
208
    void serialize(ostream &out);
209

210
    // Reads the object data from an input stream.
211
    void deserialize(istream &in);
212 213

    /** \brief
214 215 216 217
     * 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.
218
     *
219 220 221
     * 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.
222
     */    
223 224 225 226 227
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

228 229
      const FiniteElemSpace *fe = vec.getFeSpace();

230
      for (DofComm::Iterator it(sendDofs, fe); !it.end(); it.nextRank()) {
231
	vector<T> dofs;
232
	dofs.reserve(it.getDofs().size());
233
	
234 235
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
236
	
237
	stdMpi.send(it.getRank(), dofs);
238
      }
239 240 241 242
	     
      for (DofComm::Iterator it(recvDofs); !it.end(); it.nextRank())
        stdMpi.recv(it.getRank());
	     
243
      stdMpi.startCommunication();
244 245 246 247 248

      for (DofComm::Iterator it(recvDofs, fe); !it.end(); it.nextRank())
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
249 250
    }
    
251
    /** \brief
252 253 254
     * 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.
255 256 257
     */
    void synchVector(SystemVector &vec);

258 259
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
260 261 262 263 264
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

265 266
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace, 
					int level = 0)
267
    {
268 269 270 271 272 273 274
      FUNCNAME("MeshDistributor::getBoundaryDofInfo()");

      TEST_EXIT_DBG(level < static_cast<int>(boundaryDofInfo.size()))
	("Wrong level number: %d, whereas array size is %d!\n", 
	 level, boundaryDofInfo.size());

      return boundaryDofInfo[level][feSpace];
275 276
    }

277 278
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace, 
			    int level,
279
			    DofContainer& dofs);
280

281 282 283 284
    const ElementObjectDatabase& getElementObjectDb() 
    {
      return elObjDb;
    }
285 286 287

    /// Adds a stationary problem to the global mesh distributor objects.
    static void addProblemStatGlobal(ProblemStatSeq *probStat);
Thomas Witkowski's avatar
Thomas Witkowski committed
288 289 290 291 292 293

    MeshLevelData& getMeshLevelData() 
    {
      return levelData;
    }

294
  protected:
295 296
    void addProblemStat(ProblemStatSeq *probStat);

297 298
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
299
    void createInteriorBoundaryInfo();
300

Thomas Witkowski's avatar
Thomas Witkowski committed
301 302 303 304 305
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
307 308
    void createBoundaryDofs();

309
    void createBoundaryDofs(const FiniteElemSpace *feSpace, int level);
310

311 312
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
313 314
    void removeMacroElements();

315 316
    void updateLocalGlobalNumbering();

317 318
    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
319
    void updateLocalGlobalNumbering(const FiniteElemSpace *feSpace);
320

321 322 323 324
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

325
    /** \brief
326 327 328 329
     * Creates, for a specific FE space, 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 periodicDofMap.
     */    
330
    void createPeriodicMap(const FiniteElemSpace *feSpace);
331

332 333 334 335 336 337 338 339
    /** \brief
     * This function is called only once during the initialization when the
     * whole macro mesh is available on all cores. It copies the pointers of all
     * macro elements to \ref allMacroElements and stores all neighbour 
     * information based on macro element indices (and not pointer based) in 
     * \ref macroElementNeighbours. These information are then used to 
     * reconstruct macro elements during mesh redistribution.
     */
340 341
    void createMacroElementInfo();

342 343
    void updateMacroElementInfo();

344
    /** \brief
345 346 347 348 349 350
     * 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.
351
     *
352 353
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
354
     *
355 356 357
     * \return    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.
358 359
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
360
  
361 362
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
363
    void setRankDofs(ProblemStatSeq *probStat);
364

365 366
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
367 368
    void setRankDofs();

369 370 371 372
    /// Removes all periodic boundary condition information from all matrices and
    /// vectors of all stationary problems and from the mesh itself.
    void removePeriodicBoundaryConditions();

373 374 375 376
    /// Removes all periodic boundary condition information from all matrices and
    /// vector of a given stationary problem.
    void removePeriodicBoundaryConditions(ProblemStatSeq *probStat);

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

380 381
    void createMeshLevelStructure();

382
    /// Writes a vector of dof pointers to an output stream.
383
    void serialize(ostream &out, DofContainer &data);
384

385 386 387 388
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

389
    /// Reads a vector of dof pointers from an input stream.
390
    void deserialize(istream &in, DofContainer &data,
391
		     map<int, const DegreeOfFreedom*> &dofIndexMap);
392 393

    /// Reads a \ref RankToDofContainer from an input stream.
394 395
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
396
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofIndexMap);
397 398 399

    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
400
    void serialize(ostream &out, map<const DegreeOfFreedom*, T> &data)
401
    {
402 403
      FUNCNAME("ParallelDomainBase::serialize()");

404
      int mapSize = data.size();
405
      SerUtil::serialize(out, mapSize);
406
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
407 408 409
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
410 411
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
412 413 414 415 416
      }
    }

    /// Reads a mapping from dof pointer to some values from an input stream.
    template<typename T>
417
    void deserialize(istream &in, map<const DegreeOfFreedom*, T> &data,
418
		     map<int, const DegreeOfFreedom*> &dofIndexMap)
419
    {
420 421
      FUNCNAME("ParallelDomainBase::deserialize()");

422
      int mapSize = 0;
423
      SerUtil::deserialize(in, mapSize);
424 425 426
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
427 428
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
429

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

433
	data[dofIndexMap[v1]] = v2;
434 435
      }
    }
436

437
  protected:
438 439
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
440
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
441

442 443 444
    /// If true, the mesh distributor is already initialized;
    bool initialized;

445 446 447 448 449 450
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

451 452
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
453 454 455
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
456
    string name;
457

458 459
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
460

461 462 463
    /// Mesh of the problem.
    Mesh *mesh;

464 465 466
    /// 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.    
467 468
    RefinementManager *refineManager;

469 470 471
    /// Info level.
    int info;

472 473
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
474
    MeshPartitioner *partitioner;
475

476 477
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
478
    map<int, double> elemWeights;
479

480 481
    /// Stores to every macro element index the number of the rank that owns this
    /// macro element.
482
    map<int, int> partitionMap;
483

484
    /// Mapping object to map from local DOF indices to global ones.
485 486
    ParallelDofMapping dofMap;

487
    /// Database to store and query all sub-objects of all elements of the 
488
    /// macro mesh.
489
    ElementObjectDatabase elObjDb;
Thomas Witkowski's avatar
Thomas Witkowski committed
490

491
    /// Maps to each macro element index a pointer to the corresponding element.
492
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
493
    
494
    /// Maps to each macro element index the type of this element.
495
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
496

497 498 499 500
    /// 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.
501
    InteriorBoundary rankIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
502
    
503 504 505 506
    /// 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
507
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
508

509 510
    /// Defines the periodic boundaries with other ranks. Periodic boundaries
    /// have no owner, as it is the case of interior boundaries.
511 512
    InteriorBoundary periodicBoundary;

513 514
    /// This map contains for each rank the list of DOFs the current rank must 
    /// end to exchange solution DOFs at the interior boundaries.
515
    DofComm sendDofs;
516

517 518 519
    /// This map contains on 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.
520
    DofComm recvDofs;
521

522 523 524 525
    /// This map contains on each rank a list of DOFs along the interior bound-
    /// aries to communicate with other ranks. The DOF indices are given in rank's
    /// local numbering. Periodic boundaries within one subdomain are not 
    /// considered here. 
526 527
    DofComm periodicDofs;

528
    PeriodicMap periodicMap;
529

530 531 532 533
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
534 535 536 537
    /// 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.
538
    bool deserialized;
539

540 541 542
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

543 544 545
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

546 547
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
548 549
    int repartitionIthChange;

550 551
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
552
    int nMeshChangesAfterLastRepartitioning;
553

554 555 556
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
557

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

561 562
    /// Stores the mesh change index. This is used to recognize changes in the
    /// mesh structure (e.g. through refinement or coarsening managers).
563
    long lastMeshChangeIndex;
564

565 566 567 568
    /// Stores for all macro elements of the original macro mesh the
    /// neighbourhood information based on element indices. Thus, each macro
    /// element index is mapped to a vector containing all indices of 
    /// neighbouring macro elements.
569
    map<int, vector<int> > macroElementNeighbours;
570

571 572
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
573
    vector<MacroElement*> allMacroElements;
574

Thomas Witkowski's avatar
Thomas Witkowski committed
575 576
    Flag createBoundaryDofFlag;

577 578 579
    /// Stores on each mesh level for all FE spaces the information about
    /// all boundary DOFs.
    vector<map<const FiniteElemSpace*, BoundaryDofInfo> > boundaryDofInfo;
580

581 582
    MeshLevelData levelData;

Thomas Witkowski's avatar
Thomas Witkowski committed
583
  public:
584 585
    bool sebastianMode;

586 587 588
    /// The boundary DOFs are sorted by subobject entities, i.e., first all
    /// face DOFs, edge DOFs and to the last vertex DOFs will be set to
    /// communication structure vectors, \ref sendDofs and \ref recvDofs.
Thomas Witkowski's avatar
Thomas Witkowski committed
589 590
    static const Flag BOUNDARY_SUBOBJ_SORTED;

591 592 593 594 595 596 597 598 599
    /// When boundary DOFs are created, \ref boundaryDofInfo is filled for
    /// all DOFs that this rank will send to other ranks (thus, rank 
    /// owned DOFs.
    static const Flag BOUNDARY_FILL_INFO_SEND_DOFS;

    /// When boundary DOFs are created, \ref boundaryDofInfo is filled for
    /// all DOFs that this rank will receive from other ranks (thus, DOFs
    /// that are owned by another rank).
    static const Flag BOUNDARY_FILL_INFO_RECV_DOFS;
Thomas Witkowski's avatar
Thomas Witkowski committed
600

601 602
    static MeshDistributor *globalMeshDistributor;

603
    friend class ParallelDebug;
604 605 606
  };
}

607
#endif // AMDIS_MESHDISTRIBUTOR_H