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

Thomas Witkowski's avatar
Thomas Witkowski committed
100 101 102
    /// 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.
103 104
    void repartitionMesh();
    
Thomas Witkowski's avatar
Thomas Witkowski committed
105 106 107 108 109 110 111
    void getImbalanceFactor(double &imbalance, 
			    int &minDofs, 
			    int &maxDofs,
			    int &sumDofs);

    double getImbalanceFactor();

112 113 114
    /// Calculates the imbalancing factor and prints it to screen.
    void printImbalanceFactor();

Thomas Witkowski's avatar
Thomas Witkowski committed
115 116 117 118
    /// 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.
119
    void testForMacroMesh();
120

121 122
    /// Set for each element on the partitioning level the number of 
    /// leaf elements.
123
    void setInitialElementWeights();
124

Thomas Witkowski's avatar
Thomas Witkowski committed
125
    inline string getName() 
126 127 128
    { 
      return name; 
    }
129

Thomas Witkowski's avatar
Thomas Witkowski committed
130 131 132 133 134
    inline Mesh* getMesh()
    {
      return mesh;
    }

135
#if 0
136 137
    /// Returns an FE space from \ref feSpaces.
    inline const FiniteElemSpace* getFeSpace(unsigned int i = 0)
138
    {
139 140 141 142 143
      FUNCNAME("MeshDistributor::getFeSpace()");

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

      return feSpaces[i];
144
    }
145 146 147 148 149 150

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

153 154
    /// Returns the DOF mapping object, \ref dofMap.
    inline ParallelDofMapping& getDofMap()
Thomas Witkowski's avatar
Thomas Witkowski committed
155
    {
156
      return dofMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
157 158
    }

159 160 161 162 163
    inline ParallelDofMapping& getDofMapSd()
    {
      return dofMapSd;
    }

164 165
    /// Returns the periodic mapping handler, \ref periodicMap.
    inline PeriodicMap& getPeriodicMap()
166
    {
167
      return periodicMap;
168
    }
169

170
    DofComm& getDofComm()
171
    {
172
      return dofComm;
173 174
    }

175 176 177 178 179
    DofComm& getDofCommSd()
    {
      return dofCommSd;
    }

180 181 182 183 184
    InteriorBoundary& getIntBoundary()
    {
      return intBoundary;
    }

185 186 187 188 189
    InteriorBoundary& getIntBoundarySd()
    {
      return intBoundarySd;
    }

190
    inline long getLastMeshChangeIndex()
191
    {
192
      return lastMeshChangeIndex;
193
    }
194

195
    inline int getMpiRank()
196
    {
197
      return mpiRank;
198
    }
199

Thomas Witkowski's avatar
Thomas Witkowski committed
200 201 202 203 204
    inline int getMpiSize()
    {
      return mpiSize;
    }

205 206 207
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
208 209
    }

210 211 212 213 214
    inline bool isInitialized()
    {
      return initialized;
    }

215
    // Writes all data of this object to an output stream.
216
    void serialize(ostream &out);
217

218
    // Reads the object data from an input stream.
219
    void deserialize(istream &in);
220 221

    /** \brief
222 223 224 225
     * 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.
226
     *
227 228 229
     * 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.
230
     */    
231 232 233 234 235
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

236 237
      const FiniteElemSpace *fe = vec.getFeSpace();

238 239
      for (DofComm::Iterator it(dofComm.getSendDofs(), fe); 
	   !it.end(); it.nextRank()) {
240
	vector<T> dofs;
241
	dofs.reserve(it.getDofs().size());
242
	
243 244
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
245
	
246
	stdMpi.send(it.getRank(), dofs);
247
      }
248
	     
249 250
      for (DofComm::Iterator it(dofComm.getRecvDofs()); 
	   !it.end(); it.nextRank())
251 252
        stdMpi.recv(it.getRank());
	     
253
      stdMpi.startCommunication();
254

255 256
      for (DofComm::Iterator it(dofComm.getRecvDofs(), fe); 
	   !it.end(); it.nextRank())
257 258 259
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
260
    }
Thomas Witkowski's avatar
Thomas Witkowski committed
261
   
Thomas Witkowski's avatar
Blub  
Thomas Witkowski committed
262 263 264 265
    /// 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);
266

Thomas Witkowski's avatar
Thomas Witkowski committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
    /// 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);
    }

302 303 304 305 306 307
    /// 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.
308 309
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
310 311 312 313 314
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

315 316
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace,
					int level)
317
    {
318 319 320 321 322 323 324
      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];
325 326
    }

327 328
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace, 
			    int level,
329
			    DofContainer& dofs);
330

331 332 333 334
    const ElementObjectDatabase& getElementObjectDb() 
    {
      return elObjDb;
    }
335 336 337

    /// Adds a stationary problem to the global mesh distributor objects.
    static void addProblemStatGlobal(ProblemStatSeq *probStat);
Thomas Witkowski's avatar
Thomas Witkowski committed
338 339 340 341 342 343

    MeshLevelData& getMeshLevelData() 
    {
      return levelData;
    }

344 345 346 347 348 349 350 351
    void updateLocalGlobalNumbering();

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

352
  protected:
353 354
    void addProblemStat(ProblemStatSeq *probStat);

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

Thomas Witkowski's avatar
Thomas Witkowski committed
359 360
    void createBoundaryDofs();

361 362
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
363 364
    void removeMacroElements();

365 366 367 368
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

369 370 371
    /// 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.  
372
    void createPeriodicMap(const FiniteElemSpace *feSpace);
373

374 375 376 377 378 379
    /// 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.
380 381
    void createMacroElementInfo();

382 383
    void updateMacroElementInfo();

384
    /** \brief
385 386 387 388 389 390
     * 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.
391
     *
392 393
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
394
     *
395 396 397
     * \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.
398 399
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
400
  
401 402 403 404
    /// Removes all periodic boundary condition information from all matrices and
    /// vectors of all stationary problems and from the mesh itself.
    void removePeriodicBoundaryConditions();

405 406 407 408
    /// 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
409
    // Removes all periodic boundaries from a given boundary map.
410
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
411

412 413
    void createMeshLevelStructure();

414
    /// Writes a vector of dof pointers to an output stream.
415
    void serialize(ostream &out, DofContainer &data);
416

417 418 419 420
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

421
    /// Reads a vector of dof pointers from an input stream.
422
    void deserialize(istream &in, DofContainer &data,
423
		     map<int, const DegreeOfFreedom*> &dofIndexMap);
424 425

    /// Reads a \ref RankToDofContainer from an input stream.
426 427
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
428
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofIndexMap);
429 430 431

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

436
      int mapSize = data.size();
437
      SerUtil::serialize(out, mapSize);
438
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
439 440 441
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
442 443
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
444 445 446 447 448
      }
    }

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

454
      int mapSize = 0;
455
      SerUtil::deserialize(in, mapSize);
456 457 458
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
459 460
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
461

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

465
	data[dofIndexMap[v1]] = v2;
466 467
      }
    }
468

469
  protected:
470 471
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
472
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
473

474 475 476
    /// If true, the mesh distributor is already initialized;
    bool initialized;

477 478 479 480 481 482
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

483 484
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
485 486 487
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
488
    string name;
489

490
    /// Finite element spaces of the problem.
491 492 493 494
    //vector<const FiniteElemSpace*> feSpaces;
    vector<const FiniteElemSpace*> componentSpaces;
    vector<const FiniteElemSpace*> uniqueFeSpaces;
    
495

496 497 498
    /// Mesh of the problem.
    Mesh *mesh;

499 500 501
    /// 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.    
502 503
    RefinementManager *refineManager;

504 505 506
    /// Info level.
    int info;

507 508
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
509
    MeshPartitioner *partitioner;
510

511 512
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
513
    map<int, double> elemWeights;
514

515 516
    /// Stores to every macro element index the number of the rank that owns this
    /// macro element.
517
    map<int, int> partitionMap;
518

519
    /// Mapping object to map from local DOF indices to global ones.
520 521
    ParallelDofMapping dofMap;

522 523
    ParallelDofMapping dofMapSd;

524
    /// Database to store and query all sub-objects of all elements of the 
525
    /// macro mesh.
526
    ElementObjectDatabase elObjDb;
Thomas Witkowski's avatar
Thomas Witkowski committed
527

528
    /// Defines the interior boundaries of the domain that result from 
529 530
    /// partitioning the whole mesh. 
    InteriorBoundary intBoundary;
531

532 533
    InteriorBoundary intBoundarySd;

534
    DofComm dofComm;
535

536 537
    DofComm dofCommSd;

538
    PeriodicMap periodicMap;
539

540 541 542 543
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
544 545 546 547
    /// 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.
548
    bool deserialized;
549

550 551 552
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

553 554 555
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

556 557
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
558 559
    int repartitionIthChange;

560 561
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
562
    int nMeshChangesAfterLastRepartitioning;
563

564 565 566
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
567

568 569 570 571 572
    /// 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;

573
    /// Directory name where all debug output files should be written to.
574
    string debugOutputDir;
575

576 577
    /// Stores the mesh change index. This is used to recognize changes in the
    /// mesh structure (e.g. through refinement or coarsening managers).
578
    long lastMeshChangeIndex;
579

580 581 582 583
    /// 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.
584
    map<int, vector<int> > macroElementNeighbours;
585

586 587
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
588
    vector<MacroElement*> allMacroElements;
589

Thomas Witkowski's avatar
Thomas Witkowski committed
590 591
    Flag createBoundaryDofFlag;

592 593 594
    /// Stores on each mesh level for all FE spaces the information about
    /// all boundary DOFs.
    vector<map<const FiniteElemSpace*, BoundaryDofInfo> > boundaryDofInfo;
595

596 597
    MeshLevelData levelData;

Thomas Witkowski's avatar
bla  
Thomas Witkowski committed
598 599 600 601 602 603
    /// 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;

Thomas Witkowski's avatar
Thomas Witkowski committed
604
  public:
605 606
    static bool sebastianMode;

607 608 609
    /// 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
610 611
    static const Flag BOUNDARY_SUBOBJ_SORTED;

612 613 614 615 616 617 618 619 620
    /// 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
621

622 623
    static MeshDistributor *globalMeshDistributor;

624
    friend class ParallelDebug;
625 626 627
  };
}

628
#endif // AMDIS_MESHDISTRIBUTOR_H