MeshDistributor.h 19.5 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
  {
  public:
55
    MeshDistributor();
56 57
		          
    virtual ~MeshDistributor() {}
58

59
    void initParallelization();
60

61
    void exitParallelization();
62

63
    void addProblemStat(ProblemStatSeq *probStat);
64

65 66 67 68 69 70 71
    /// 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);
    }

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

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

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

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

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

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

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

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

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

143 144
    DegreeOfFreedom mapGlobalToLocal(DegreeOfFreedom dof);

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

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

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

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

      return periodicDof[type][globalDofIndex];
    }

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

176
      return periodicDofAssociations[globalDofIndex];
177
    }
178

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

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

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

      return false;
201
    }
202

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

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

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

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

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

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

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

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

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

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

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

268 269
    void check3dValidMesh();

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

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

280 281
    void getAllBoundaryDofs(DofContainer& dofs);

282
  protected:
283
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
284
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
285 286
     * all information about them in \ref interiorBoundary.
     */
287
    void createInteriorBoundaryInfo();
288

Thomas Witkowski's avatar
Thomas Witkowski committed
289 290 291 292 293
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
295 296
    void createBoundaryDofs();

297 298 299
    /// Removes all macro elements from the mesh that are not part of ranks partition.
    void removeMacroElements();

300
    /// Updates the local and global DOF numbering after the mesh has been changed.
301
    void updateLocalGlobalNumbering();
302

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

310 311
    void createMacroElementInfo();

312 313
    void updateMacroElementInfo();

314 315 316 317 318 319 320 321 322
    /** \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.
323 324 325 326
     *
     * \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.
327 328
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
329 330 331 332 333 334 335 336
  
    /** \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();

337 338
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
339
    void setRankDofs(ProblemStatSeq *probStat);
340

341 342 343
    /// Sets \ref isRankDof to all matrices and rhs vectors in all stationary problems.
    void setRankDofs();

344 345 346 347
    /// 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
348
    // Removes all periodic boundaries from a given boundary map.
349
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
350

351
    /// Writes a vector of dof pointers to an output stream.
352
    void serialize(ostream &out, DofContainer &data);
353 354

    /// Reads a vector of dof pointers from an input stream.
355 356
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
357 358

    /// Writes a \ref RankToDofContainer to an output stream.
359
    void serialize(ostream &out, RankToDofContainer &data);
360 361

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

365
    /// Writes a periodic dof mapping to an output stream.
366
    void serialize(ostream &out, PeriodicDofMap &data);
367

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

370
    /// Reads a periodic dof mapping from an input stream.
371
    void deserialize(istream &in, PeriodicDofMap &data);
372

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

375 376
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
377
    void serialize(ostream &out, map<const DegreeOfFreedom*, T> &data)
378
    {
379 380
      FUNCNAME("ParallelDomainBase::serialize()");

381
      int mapSize = data.size();
382
      SerUtil::serialize(out, mapSize);
383
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
384 385 386
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
387 388
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
389 390 391 392 393
      }
    }

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

399
      int mapSize = 0;
400
      SerUtil::deserialize(in, mapSize);
401 402 403
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
404 405
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
406 407 408

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

409 410 411
	data[dofMap[v1]] = v2;
      }
    }
412

413
  protected:
414
    /// List of all stationary problems that are managed by this mesh distributor.
415
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
416

417 418 419
    /// If true, the mesh distributor is already initialized;
    bool initialized;

420 421 422 423 424 425 426 427 428 429 430 431 432 433
    /// 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)
434
    string name;
435

436 437 438
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

439 440 441
    /// Mesh of the problem.
    Mesh *mesh;

442 443 444 445 446 447 448
    /** \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;

449 450 451
    /// Info level.
    int info;

452 453
    /// Pointer to a mesh partitioner that is used to partition the mesh to the ranks.
    MeshPartitioner *partitioner;
454 455

    /// Weights for the elements, i.e., the number of leaf elements within this element.
456
    map<int, double> elemWeights;
457 458

    /** \brief
459 460
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
461
     */
462
    map<int, int> partitionMap;
463

464
    /// Number of DOFs in the rank mesh.
465
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
466

467
    /// Number of DOFs in the whole domain.
468 469
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
470 471 472 473
    // 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.
474
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
475 476
    
    // Maps to each macro element index the type of this element.
477
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
478

Thomas Witkowski's avatar
Thomas Witkowski committed
479
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
480 481 482 483 484 485 486 487 488 489 490 491
     * 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
492
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
493
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
494

495
    /** \brief
496 497
     * Defines the periodic boundaries with other ranks. Periodic boundaries have
     * no owner, as it is the case of interior boundaries.
498 499 500
     */
    InteriorBoundary periodicBoundary;

501
    /** \brief
502 503
     * This map contains for each rank the list of DOFs the current rank must send
     * to exchange solution DOFs at the interior boundaries.
504
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
505
    RankToDofContainer sendDofs;
506 507

    /** \brief
508
     * This map contains on each rank the list of DOFs from which the current rank 
509 510
     * will receive DOF values (i.e., this are all DOFs at an interior boundary). The
     * DOF indices are given in rank's local numbering.
511
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
512
    RankToDofContainer recvDofs;
513 514

    /// Maps local to global dof indices.
515
    DofMapping mapLocalGlobalDofs;
516

Thomas Witkowski's avatar
Thomas Witkowski committed
517
    /// Maps local dof indices to real dof indices.
518
    DofMapping mapLocalDofIndex;  
519 520 521 522 523 524

    /** \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.
     */
525 526
    DofIndexToBool isRankDof;

527
    /** \brief
528 529 530 531
     * 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.
532
     */
533
    PeriodicDofMap periodicDof;
534 535 536 537 538
    
    /** \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
539
     * being periodic, the four corners are associated by two different boundaries.
540
     */
541
    map<int, std::set<BoundaryType> > periodicDofAssociations;
542

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

551 552 553 554 555 556 557
    /** \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;
558

559 560 561
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

562 563 564
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

565
    /// Stores the number of mesh changes that must lie in between to repartitionings.
566 567
    int repartitionIthChange;

568 569
    /// Counts the number of mesh changes after the last mesh repartitioning was done.
    int nMeshChangesAfterLastRepartitioning;
570

571 572 573
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
574

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

578 579 580 581 582
    /** \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;
583

584
    map<int, vector<int> > macroElementNeighbours;
585

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

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

    BoundaryDofInfo boundaryDofInfo;
  public:
594 595 596
    /// 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
597 598
    static const Flag BOUNDARY_SUBOBJ_SORTED;

599 600 601 602 603 604 605 606 607
    /// 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
608

609
    friend class ParallelDebug;
610 611 612
  };
}

613
#endif // AMDIS_MESHDISTRIBUTOR_H