MeshDistributor.h 20.1 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
	          
  public:
Thomas Witkowski's avatar
Thomas Witkowski committed
64 65
    ~MeshDistributor();

66
    /// Initialization of mesh distributor.
67
    void initParallelization();
68

69
    /// Clean up procedure for the mesh distributor and attached objects.
70
    void exitParallelization();
71

72 73 74 75 76 77 78 79
    /** \brief
     * Register a parallel DOF mapping. This DOF mapping object will than 
     * automatically updated by the mesh distributer after mesh changes.
     *
     * \param[in]  dofMap   Parallel DOF mapping object.
     */
    void registerDofMap(ParallelDofMapping &dofMap);

80 81 82
    /// Adds a DOFVector to the set of \ref interchangeVecs. Thus, this vector 
    /// will be automatically interchanged between ranks when mesh is 
    /// repartitioned.
83 84 85 86 87
    void addInterchangeVector(DOFVector<double> *vec)
    {
      interchangeVectors.push_back(vec);
    }

88 89 90 91 92 93 94
    /// 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));
    }
    
95
    /** \brief
96 97 98 99 100
     * 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.
101
     *
102 103 104 105 106
     * \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.
107
     */
108
    void checkMeshChange(bool tryRepartition = true);
109

Thomas Witkowski's avatar
Thomas Witkowski committed
110 111 112
    /// 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.
113 114
    void repartitionMesh();
    
Thomas Witkowski's avatar
Thomas Witkowski committed
115 116 117 118 119 120 121
    void getImbalanceFactor(double &imbalance, 
			    int &minDofs, 
			    int &maxDofs,
			    int &sumDofs);

    double getImbalanceFactor();

122 123 124
    /// Calculates the imbalancing factor and prints it to screen.
    void printImbalanceFactor();

Thomas Witkowski's avatar
Thomas Witkowski committed
125 126 127 128
    /// 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.
129
    void testForMacroMesh();
130

131 132
    /// Set for each element on the partitioning level the number of 
    /// leaf elements.
133
    void setInitialElementWeights();
134

Thomas Witkowski's avatar
Thomas Witkowski committed
135
    inline string getName() 
136 137 138
    { 
      return name; 
    }
139

Thomas Witkowski's avatar
Thomas Witkowski committed
140 141 142 143 144
    inline Mesh* getMesh()
    {
      return mesh;
    }

145 146
    /// Returns the periodic mapping handler, \ref periodicMap.
    inline PeriodicMap& getPeriodicMap()
147
    {
148
      return periodicMap;
149
    }
150

151
    DofComm& getDofComm()
152
    {
153
      return dofComm;
154 155
    }

156 157 158 159 160
    DofComm& getDofCommSd()
    {
      return dofCommSd;
    }

161 162 163 164 165
    InteriorBoundary& getIntBoundary()
    {
      return intBoundary;
    }

166 167 168 169 170
    InteriorBoundary& getIntBoundarySd()
    {
      return intBoundarySd;
    }

171
    inline long getLastMeshChangeIndex()
172
    {
173
      return lastMeshChangeIndex;
174
    }
175

176
    inline int getMpiRank()
177
    {
178
      return mpiRank;
179
    }
180

Thomas Witkowski's avatar
Thomas Witkowski committed
181 182 183 184 185
    inline int getMpiSize()
    {
      return mpiSize;
    }

186 187 188
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
189 190
    }

191 192 193 194 195
    inline bool isInitialized()
    {
      return initialized;
    }

196
    // Writes all data of this object to an output stream.
197
    void serialize(ostream &out);
198

199
    // Reads the object data from an input stream.
200
    void deserialize(istream &in);
201 202

    /** \brief
203 204 205 206
     * 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.
207
     *
208 209 210
     * 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.
211
     */    
212 213 214 215 216
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

217 218
      const FiniteElemSpace *fe = vec.getFeSpace();

219 220
      for (DofComm::Iterator it(dofComm.getSendDofs(), fe); 
	   !it.end(); it.nextRank()) {
221
	vector<T> dofs;
222
	dofs.reserve(it.getDofs().size());
223
	
224 225
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
226
	
227
	stdMpi.send(it.getRank(), dofs);
228
      }
229
	     
230 231
      for (DofComm::Iterator it(dofComm.getRecvDofs()); 
	   !it.end(); it.nextRank())
232 233
        stdMpi.recv(it.getRank());
	     
234
      stdMpi.startCommunication();
235

236 237
      for (DofComm::Iterator it(dofComm.getRecvDofs(), fe); 
	   !it.end(); it.nextRank())
238 239 240
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
241
    }
Thomas Witkowski's avatar
Thomas Witkowski committed
242
   
Thomas Witkowski's avatar
Blub  
Thomas Witkowski committed
243 244 245 246
    /// 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, int level = 0);
247

Thomas Witkowski's avatar
Thomas Witkowski committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
    /// Works quite similar to the function \ref synchVector, but instead the 
    /// values of subdomain vectors are add along the boundaries.
    template<typename T>
    void synchAddVector(DOFVector<T> &vec)
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

      const FiniteElemSpace *fe = vec.getFeSpace();

      for (DofComm::Iterator it(dofComm.getRecvDofs(), fe);
	   !it.end(); it.nextRank()) {
	vector<T> dofs;
	dofs.reserve(it.getDofs().size());
	
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
	
	stdMpi.send(it.getRank(), dofs);
      }

      for (DofComm::Iterator it(dofComm.getSendDofs()); 
	   !it.end(); it.nextRank())
        stdMpi.recv(it.getRank());
	     
      stdMpi.startCommunication();

      for (DofComm::Iterator it(dofComm.getSendDofs(), fe); 
	   !it.end(); it.nextRank())
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] += 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];

      synchVector(vec);
    }

283 284 285 286 287 288
    /// In 3D, a subdomain may not be a valid AMDiS mesh if it contains two
    /// parts which are only connected by an edge. In this case, the standard
    /// refinement algorithm does not work correctly, as two elements connected
    /// only on one edge are not neighours by definition. This functions checks
    /// for this situation and fix the problem. For this, the mesh is search for
    /// all edges connecting two elements that are otherwise not connected.
289 290
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
291 292 293 294 295
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

296 297
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace,
					int level)
298
    {
299 300 301 302 303 304 305
      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];
306 307
    }

308 309
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace, 
			    int level,
310
			    DofContainer& dofs);
311

312 313 314 315
    const ElementObjectDatabase& getElementObjectDb() 
    {
      return elObjDb;
    }
316 317 318

    /// Adds a stationary problem to the global mesh distributor objects.
    static void addProblemStatGlobal(ProblemStatSeq *probStat);
Thomas Witkowski's avatar
Thomas Witkowski committed
319 320 321 322 323 324

    MeshLevelData& getMeshLevelData() 
    {
      return levelData;
    }

325 326 327 328 329 330 331
    void updateLocalGlobalNumbering();

    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
    void updateLocalGlobalNumbering(ParallelDofMapping &dmap,
				    const FiniteElemSpace *feSpace);

332
  protected:
333 334
    void addProblemStat(ProblemStatSeq *probStat);

335 336
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
337
    void createInteriorBoundary(bool firstCall);
Thomas Witkowski's avatar
Thomas Witkowski committed
338

Thomas Witkowski's avatar
Thomas Witkowski committed
339 340
    void createBoundaryDofs();

341 342
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
343 344
    void removeMacroElements();

345 346 347 348
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

349 350 351
    /// 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.  
352
    void createPeriodicMap(const FiniteElemSpace *feSpace);
353

354 355 356 357 358 359
    /// 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.
360 361
    void createMacroElementInfo();

362 363
    void updateMacroElementInfo();

364
    /** \brief
365 366 367 368 369 370
     * 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.
371
     *
372 373
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
374
     *
375 376 377
     * \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.
378 379
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
380
  
381 382 383 384
    /// Removes all periodic boundary condition information from all matrices and
    /// vectors of all stationary problems and from the mesh itself.
    void removePeriodicBoundaryConditions();

385 386 387 388
    /// 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
389
    // Removes all periodic boundaries from a given boundary map.
390
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
391

392 393
    void createMeshLevelStructure();

394
    /// Writes a vector of dof pointers to an output stream.
395
    void serialize(ostream &out, DofContainer &data);
396

397 398 399 400
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

401
    /// Reads a vector of dof pointers from an input stream.
402
    void deserialize(istream &in, DofContainer &data,
403
		     map<int, const DegreeOfFreedom*> &dofIndexMap);
404 405

    /// Reads a \ref RankToDofContainer from an input stream.
406 407
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
408
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofIndexMap);
409 410 411

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

416
      int mapSize = data.size();
417
      SerUtil::serialize(out, mapSize);
418
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
419 420 421
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
422 423
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
424 425 426 427 428
      }
    }

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

434
      int mapSize = 0;
435
      SerUtil::deserialize(in, mapSize);
436 437 438
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
439 440
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
441

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

445
	data[dofIndexMap[v1]] = v2;
446 447
      }
    }
448

449
  protected:
450 451
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
452
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
453

454 455 456
    /// If true, the mesh distributor is already initialized;
    bool initialized;

457 458 459 460 461 462
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

463 464
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
465 466 467
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
468
    string name;
469

470 471
    /// Set of all different FE spaces.
    vector<const FiniteElemSpace*> feSpaces;
472
    
473 474 475
    /// Pointer to the only mesh. Note that we do not yet support multi mesh
    /// method, thus even if we consider coupled problems, all problems must
    /// be defined on the same mesh.
476 477
    Mesh *mesh;

478 479 480
    /// 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.    
481 482
    RefinementManager *refineManager;

483 484
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
485
    MeshPartitioner *partitioner;
486

487 488
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
489
    map<int, double> elemWeights;
490

491 492
    /// Stores to every macro element index the number of the rank that owns this
    /// macro element.
493
    map<int, int> partitionMap;
494

495
    /// Database to store and query all sub-objects of all elements of the 
496
    /// macro mesh.
497
    ElementObjectDatabase elObjDb;
Thomas Witkowski's avatar
Thomas Witkowski committed
498

499
    /// Defines the interior boundaries of the domain that result from 
500 501
    /// partitioning the whole mesh. 
    InteriorBoundary intBoundary;
502

503 504
    InteriorBoundary intBoundarySd;

505
    DofComm dofComm;
506

507 508
    DofComm dofCommSd;

509
    PeriodicMap periodicMap;
510

511 512 513 514
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
515 516 517 518
    /// 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.
519
    bool deserialized;
520

521 522 523
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

524 525 526
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

527 528
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
529 530
    int repartitionIthChange;

531 532
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
533
    int nMeshChangesAfterLastRepartitioning;
534

535 536 537
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
538

539 540 541 542 543
    /// If repartitioning of the mesh fail, this variable has a positive value
    /// that gives the number of mesh changes the mesh distributer will wait
    /// before trying new mesh repartitioning.
    int repartitioningFailed;

544
    /// Directory name where all debug output files should be written to.
545
    string debugOutputDir;
546

547 548
    /// Stores the mesh change index. This is used to recognize changes in the
    /// mesh structure (e.g. through refinement or coarsening managers).
549
    long lastMeshChangeIndex;
550

551 552 553 554
    /// 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.
555
    map<int, vector<int> > macroElementNeighbours;
556

557 558
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
559
    vector<MacroElement*> allMacroElements;
560

Thomas Witkowski's avatar
Thomas Witkowski committed
561 562
    Flag createBoundaryDofFlag;

563 564 565
    /// Stores on each mesh level for all FE spaces the information about
    /// all boundary DOFs.
    vector<map<const FiniteElemSpace*, BoundaryDofInfo> > boundaryDofInfo;
566

567 568
    /// Stores information about hierarchical decomposition of the mesh levels.
    /// Is used to specify multi level solver methods.
569 570
    MeshLevelData levelData;

Thomas Witkowski's avatar
bla  
Thomas Witkowski committed
571 572 573 574 575 576
    /// If there is no mesh adaptivity, the mesh distributor can remove some
    /// data structures which are only used if mesh changes or it must be
    /// redistributed due to some local adaptivity. By default, this variable
    /// is set to true, and thus no special assumption are made.
    bool meshAdaptivity;

577 578 579 580 581
    /// Specifies whether the global domain has periodic boundaries. Thus, this
    /// variable is not related to rank's subdomain but to the global problem
    /// and therefore the value if the same on all ranks.
    bool hasPeriodicBoundary;

582 583 584 585
    /// Set of all parallel DOF mapping object that are registered by parallel
    /// solver objects and must be updated automatically after mesh change.
    vector<ParallelDofMapping*> dofMaps;

Thomas Witkowski's avatar
Thomas Witkowski committed
586
  public:
587 588
    static bool sebastianMode;

589 590 591
    /// 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
592 593
    static const Flag BOUNDARY_SUBOBJ_SORTED;

594 595 596 597 598 599 600 601 602
    /// 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
603

604 605
    static MeshDistributor *globalMeshDistributor;

606
    friend class ParallelDebug;
607 608 609
  };
}

610
#endif // AMDIS_MESHDISTRIBUTOR_H