MeshDistributor.h 19.7 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/ParallelTypes.h"
29
#include "parallel/MeshPartitioner.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
30
#include "parallel/InteriorBoundary.h"
31
#include "AMDiS_fwd.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
32
#include "Global.h"
33 34
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
35
#include "FiniteElemSpace.h"
36
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
37
#include "BoundaryManager.h"
38
#include "ElementObjectData.h"
39
#include "SystemVector.h"
40

41
namespace AMDiS {
42 43

  using namespace std;
Thomas Witkowski's avatar
Thomas Witkowski committed
44 45 46 47


  struct BoundaryDofInfo
  {
48
    map<GeoIndex, DofContainerSet> geoDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
49
  };
50
  
Thomas Witkowski's avatar
Thomas Witkowski committed
51

52
  class MeshDistributor
53
  {
54
  private:
55
    MeshDistributor();
56
	          
57
    virtual ~MeshDistributor() {}
58

59
  public:
60
    void initParallelization();
61

62
    void exitParallelization();
63

64 65 66 67 68 69 70
    /// Adds a DOFVector to the set of \ref interchangeVecs. Thus, this vector will
    /// be automatically interchanged between ranks when mesh is repartitioned.
    void addInterchangeVector(DOFVector<double> *vec)
    {
      interchangeVectors.push_back(vec);
    }

71 72 73 74 75 76 77
    /// 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));
    }
    
78 79 80 81
    /** \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
82
     * to update the DOF numberings and mappings on all rank due to the new mesh
83
     * structure.
84 85 86 87 88
     *
     * \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.
89
     */
90
    void checkMeshChange(bool tryRepartition = true);
91

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

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

103
    inline virtual string getName() 
104 105 106
    { 
      return name; 
    }
107

Thomas Witkowski's avatar
Thomas Witkowski committed
108 109 110 111 112
    inline Mesh* getMesh()
    {
      return mesh;
    }

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

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

Thomas Witkowski's avatar
Thomas Witkowski committed
131 132 133 134 135
    inline DofMapping& getMapLocalGlobalDofs()
    {
      return mapLocalGlobalDofs;
    }

136
    /// Maps a local DOF to its global index.
137
    inline DegreeOfFreedom mapLocalToGlobal(DegreeOfFreedom dof)
138
    {
139
      return mapLocalGlobalDofs[dof];
140
    }
141

142 143
    DegreeOfFreedom mapGlobalToLocal(DegreeOfFreedom dof);

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

Thomas Witkowski's avatar
Thomas Witkowski committed
150 151 152 153 154 155
    /// Returns the periodic mapping for all boundary DOFs in rank.
    inline PeriodicDofMap& getPeriodicMapping()
    {
      return periodicDof;
    }

156
    /// Returns for a global dof index its periodic mapping for a given boundary type.
157
    inline int getPeriodicMapping(int globalDofIndex, BoundaryType type)
158
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
159 160
      FUNCNAME("MeshDistributor::getPeriodicMapping()");

161
      TEST_EXIT_DBG(periodicDof[type].count(globalDofIndex) == 1)
Thomas Witkowski's avatar
Thomas Witkowski committed
162 163
	("There is no periodic association for global DOF %d for boundary type %d!\n",
	 globalDofIndex, type);
164 165 166 167

      return periodicDof[type][globalDofIndex];
    }

168 169 170
    /// 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)
171
    {      
172 173 174
      TEST_EXIT_DBG(periodicDofAssociations.count(globalDofIndex)) 
 	("Should not happen!\n"); 

175
      return periodicDofAssociations[globalDofIndex];
176
    }
177

178
    /// Returns true, if the DOF (global index) is a periodic DOF.
179
    inline bool isPeriodicDof(int globalDofIndex)
180
    {
181 182
      return (periodicDofAssociations.count(globalDofIndex) > 0 &&
	       periodicDofAssociations[globalDofIndex].size() > 0);
183 184
    }

185 186 187
    /// Returns true, if the DOF (global index) is a periodic DOF for the given
    /// boundary type.
    inline bool isPeriodicDof(int globalDofIndex, BoundaryType type)
188 189
    {
      return (periodicDof[type].count(globalDofIndex) > 0);
190 191
    }

192 193
    /// 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.
194 195
    inline bool getIsRankDof(DegreeOfFreedom dof)
    {
196 197 198 199
      if (isRankDof.count(dof))
	return isRankDof[dof];

      return false;
200
    }
201

202 203 204 205 206
    inline DofIndexToBool& getIsRankDof()
    {
      return isRankDof;
    }

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 268
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
269 270 271 272 273
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

274 275 276 277 278
    BoundaryDofInfo& getBoundaryDofInfo()
    {
      return boundaryDofInfo;
    }

279 280
    void getAllBoundaryDofs(DofContainer& dofs);

281 282 283 284 285 286

  public:
    /// Adds a stationary problem to the global mesh distributor objects.
    static void addProblemStatGlobal(ProblemStatSeq *probStat);

    
287
  protected:
288 289
    void addProblemStat(ProblemStatSeq *probStat);

290
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
291
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
292 293
     * all information about them in \ref interiorBoundary.
     */
294
    void createInteriorBoundaryInfo();
295

Thomas Witkowski's avatar
Thomas Witkowski committed
296 297 298 299 300
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
302 303
    void createBoundaryDofs();

304 305 306
    /// Removes all macro elements from the mesh that are not part of ranks partition.
    void removeMacroElements();

307
    /// Updates the local and global DOF numbering after the mesh has been changed.
308
    void updateLocalGlobalNumbering();
309

310 311 312 313 314
    /** \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.
     */
315 316
    void createPeriodicMap();

317 318
    void createMacroElementInfo();

319 320
    void updateMacroElementInfo();

321 322 323 324 325 326 327 328 329
    /** \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.
     *
     * \param[in] allBound   Defines a map from rank to interior boundaries which 
     *                       should be checked.
330 331 332 333
     *
     * \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.
334 335
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
336 337 338 339 340 341 342 343
  
    /** \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();

344 345
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
346
    void setRankDofs(ProblemStatSeq *probStat);
347

348 349 350
    /// Sets \ref isRankDof to all matrices and rhs vectors in all stationary problems.
    void setRankDofs();

351 352 353 354
    /// 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
355
    // Removes all periodic boundaries from a given boundary map.
356
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
357

358
    /// Writes a vector of dof pointers to an output stream.
359
    void serialize(ostream &out, DofContainer &data);
360 361

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

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

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

372
    /// Writes a periodic dof mapping to an output stream.
373
    void serialize(ostream &out, PeriodicDofMap &data);
374

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

377
    /// Reads a periodic dof mapping from an input stream.
378
    void deserialize(istream &in, PeriodicDofMap &data);
379

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

382 383
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
384
    void serialize(ostream &out, map<const DegreeOfFreedom*, T> &data)
385
    {
386 387
      FUNCNAME("ParallelDomainBase::serialize()");

388
      int mapSize = data.size();
389
      SerUtil::serialize(out, mapSize);
390
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
391 392 393
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
394 395
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
396 397 398 399 400
      }
    }

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

406
      int mapSize = 0;
407
      SerUtil::deserialize(in, mapSize);
408 409 410
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
411 412
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
413 414 415

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

416 417 418
	data[dofMap[v1]] = v2;
      }
    }
419

420
  protected:
421
    /// List of all stationary problems that are managed by this mesh distributor.
422
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
423

424 425 426
    /// If true, the mesh distributor is already initialized;
    bool initialized;

427 428 429 430 431 432 433 434 435 436 437 438 439 440
    /// 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)
441
    string name;
442

443 444 445
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

446 447 448
    /// Mesh of the problem.
    Mesh *mesh;

449 450 451 452 453 454 455
    /** \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;

456 457 458
    /// Info level.
    int info;

459 460
    /// Pointer to a mesh partitioner that is used to partition the mesh to the ranks.
    MeshPartitioner *partitioner;
461 462

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

    /** \brief
466 467
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
468
     */
469
    map<int, int> partitionMap;
470

471
    /// Number of DOFs in the rank mesh.
472
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
473

474
    /// Number of DOFs in the whole domain.
475 476
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
477 478 479 480
    // 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.
481
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
482 483
    
    // Maps to each macro element index the type of this element.
484
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
485

Thomas Witkowski's avatar
Thomas Witkowski committed
486
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
487 488 489 490 491 492 493 494 495 496 497 498
     * 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
499
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
500
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
501

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

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

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

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

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

    /** \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.
     */
532 533
    DofIndexToBool isRankDof;

534
    /** \brief
535 536 537 538
     * 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.
539
     */
540
    PeriodicDofMap periodicDof;
541 542 543 544 545
    
    /** \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
546
     * being periodic, the four corners are associated by two different boundaries.
547
     */
548
    map<int, std::set<BoundaryType> > periodicDofAssociations;
549

550 551 552 553 554
    
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
555
    /// 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
556
    int rstart;
557

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

566 567 568
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

569 570 571
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

572
    /// Stores the number of mesh changes that must lie in between to repartitionings.
573 574
    int repartitionIthChange;

575 576
    /// Counts the number of mesh changes after the last mesh repartitioning was done.
    int nMeshChangesAfterLastRepartitioning;
577

578 579 580
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
581

582
    /// Directory name where all debug output files should be written to.
583
    string debugOutputDir;
584

585 586 587 588 589
    /** \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;
590

591
    map<int, vector<int> > macroElementNeighbours;
592

593 594
    /// Store all macro elements of the overall mesh, i.e., before the macro mesh is
    /// redistributed for the first time.
595
    vector<MacroElement*> allMacroElements;
596

Thomas Witkowski's avatar
Thomas Witkowski committed
597 598 599
    Flag createBoundaryDofFlag;

    BoundaryDofInfo boundaryDofInfo;
600

Thomas Witkowski's avatar
Thomas Witkowski committed
601
  public:
602 603 604
    /// 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
605 606
    static const Flag BOUNDARY_SUBOBJ_SORTED;

607 608 609 610 611 612 613 614 615
    /// 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
616

617 618
    static MeshDistributor *globalMeshDistributor;

619
    friend class ParallelDebug;
620 621 622
  };
}

623
#endif // AMDIS_MESHDISTRIBUTOR_H