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 27


#include <map>
28
#include <set>
29
#include <vector>
Thomas Witkowski's avatar
Thomas Witkowski committed
30
#include <mpi.h>
31

32
#include "parallel/MeshPartitioner.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
33
#include "parallel/InteriorBoundary.h"
34
#include "AMDiS_fwd.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
35
#include "Global.h"
36 37
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
38
#include "FiniteElemSpace.h"
39
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
40
#include "BoundaryManager.h"
41
#include "ElementObjectData.h"
42
#include "SystemVector.h"
43

44
namespace AMDiS {
45 46

  using namespace std;
47
  
48
  class MeshDistributor
49
  {
50
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
51
    /// Defines a mapping type from DOFs to rank numbers.
52
    typedef map<const DegreeOfFreedom*, int> DofToRank;
Thomas Witkowski's avatar
Thomas Witkowski committed
53 54

    /// Defines a mapping type from DOFs to a set of rank numbers.
55
    typedef map<const DegreeOfFreedom*, std::set<int> > DofToPartitions;
Thomas Witkowski's avatar
Thomas Witkowski committed
56 57

    /// Defines a mapping type from rank numbers to sets of DOFs.
58
    typedef map<int, DofContainer> RankToDofContainer;
Thomas Witkowski's avatar
Thomas Witkowski committed
59 60

    /// Defines a mapping type from DOF indices to DOF indices.
61
    typedef map<DegreeOfFreedom, DegreeOfFreedom> DofMapping;
Thomas Witkowski's avatar
Thomas Witkowski committed
62

63
    /// Defines a mapping type from DOFs to boolean values.
64
    typedef map<const DegreeOfFreedom*, bool> DofToBool;
65

Thomas Witkowski's avatar
Thomas Witkowski committed
66
    /// Defines a mapping type from DOF indices to boolean values.
67
    typedef map<DegreeOfFreedom, bool> DofIndexToBool;
Thomas Witkowski's avatar
Thomas Witkowski committed
68

Thomas Witkowski's avatar
Thomas Witkowski committed
69 70 71
    /// Forward type (it maps rank numbers to the interior boundary objects).
    typedef InteriorBoundary::RankToBoundMap RankToBoundMap;

72
    typedef map<const DegreeOfFreedom*, DegreeOfFreedom> DofIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
73

74
    /// Mapps a boundar type, i.e., a boundary identifier index, to a periodic 
75
    /// DOF mapping.
76 77 78
    typedef map<BoundaryType, DofMapping> PeriodicDofMap;

    typedef vector<MeshStructure> MeshCodeVec;
79

80
  public:
81
    MeshDistributor();
82 83
		          
    virtual ~MeshDistributor() {}
84

85
    void initParallelization();
86

87
    void exitParallelization();
88 89

    void addProblemStat(ProblemVec *probVec);
90

91 92 93 94 95 96 97
    /// 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);
    }

98 99 100 101 102 103 104
    /// 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));
    }
    
105 106 107 108
    /** \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
109
     * to update the DOF numberings and mappings on all rank due to the new mesh
110
     * structure.
111 112 113 114 115
     *
     * \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.
116
     */
117
    void checkMeshChange(bool tryRepartition = true);
118

119 120 121 122 123 124 125
    /** \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();
126 127

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

130
    inline virtual string getName() 
131 132 133
    { 
      return name; 
    }
134

Thomas Witkowski's avatar
Thomas Witkowski committed
135 136 137 138 139
    inline Mesh* getMesh()
    {
      return mesh;
    }

140 141 142 143 144
    /// Returns \ref feSpace.
    inline const FiniteElemSpace* getFeSpace()
    {
      return feSpace;
    }
145 146 147
    
    /// Returns \ref nRankDOFs, the number of DOFs in the rank mesh.
    inline int getNumberRankDofs() 
148
    {
149
      return nRankDofs;
150
    }
151

152
    /// Returns \ref nOverallDofs, the global number of DOFs.
153
    inline int getNumberOverallDofs()
154
    {
155
      return nOverallDofs;
156
    }
157

Thomas Witkowski's avatar
Thomas Witkowski committed
158 159 160 161 162
    inline DofMapping& getMapLocalGlobalDofs()
    {
      return mapLocalGlobalDofs;
    }

163
    /// Maps a local DOF to its global index.
164
    inline DegreeOfFreedom mapLocalToGlobal(DegreeOfFreedom dof)
165
    {
166
      return mapLocalGlobalDofs[dof];
167
    }
168

169 170
    DegreeOfFreedom mapGlobalToLocal(DegreeOfFreedom dof);

171
    /// Maps a local DOF to its local index.
172 173 174 175 176
    inline DegreeOfFreedom mapLocalToDofIndex(DegreeOfFreedom dof)
    {
      return mapLocalDofIndex[dof];
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
177 178 179 180 181 182
    /// Returns the periodic mapping for all boundary DOFs in rank.
    inline PeriodicDofMap& getPeriodicMapping()
    {
      return periodicDof;
    }

183
    /// Returns for a global dof index its periodic mapping for a given boundary type.
184
    inline int getPeriodicMapping(int globalDofIndex, BoundaryType type)
185
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
186 187
      FUNCNAME("MeshDistributor::getPeriodicMapping()");

188
      TEST_EXIT_DBG(periodicDof[type].count(globalDofIndex) == 1)
Thomas Witkowski's avatar
Thomas Witkowski committed
189 190
	("There is no periodic association for global DOF %d for boundary type %d!\n",
	 globalDofIndex, type);
191 192 193 194

      return periodicDof[type][globalDofIndex];
    }

195 196 197
    /// 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)
198
    {      
199 200 201
      TEST_EXIT_DBG(periodicDofAssociations.count(globalDofIndex)) 
 	("Should not happen!\n"); 

202
      return periodicDofAssociations[globalDofIndex];
203
    }
204

205
    /// Returns true, if the DOF (global index) is a periodic DOF.
206
    inline bool isPeriodicDof(int globalDofIndex)
207
    {
208 209
      return (periodicDofAssociations.count(globalDofIndex) > 0 &&
	       periodicDofAssociations[globalDofIndex].size() > 0);
210 211
    }

212 213 214
    /// Returns true, if the DOF (global index) is a periodic DOF for the given
    /// boundary type.
    inline bool isPeriodicDof(int globalDofIndex, BoundaryType type)
215 216
    {
      return (periodicDof[type].count(globalDofIndex) > 0);
217 218
    }

219 220
    /// 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.
221 222
    inline bool getIsRankDof(DegreeOfFreedom dof)
    {
223 224 225 226
      if (isRankDof.count(dof))
	return isRankDof[dof];

      return false;
227
    }
228

229 230 231 232 233
    inline DofIndexToBool& getIsRankDof()
    {
      return isRankDof;
    }

234
    inline long getLastMeshChangeIndex()
235
    {
236
      return lastMeshChangeIndex;
237
    }
238

239 240 241 242
    inline int getRstart()
    {
      return rstart;
    }
243

244
    inline int getMpiRank()
245
    {
246
      return mpiRank;
247
    }
248

Thomas Witkowski's avatar
Thomas Witkowski committed
249 250 251 252 253
    inline int getMpiSize()
    {
      return mpiSize;
    }

254 255 256
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
257 258
    }

259
    inline RankToDofContainer& getSendDofs()
260
    {
261
      return sendDofs;
262 263
    }

264
    inline RankToDofContainer& getRecvDofs()
265
    {
266
      return recvDofs;
267
    }
268

269
    // Writes all data of this object to an output stream.
270
    void serialize(ostream &out);
271

272
    // Reads the object data from an input stream.
273
    void deserialize(istream &in);
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

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

294 295
    void check3dValidMesh();

296
  protected:
297
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
298
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
299 300
     * all information about them in \ref interiorBoundary.
     */
301
    void createInteriorBoundaryInfo();
302

Thomas Witkowski's avatar
Thomas Witkowski committed
303 304 305 306 307
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

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

312
    /// Updates the local and global DOF numbering after the mesh has been changed.
313
    void updateLocalGlobalNumbering();
314

315 316 317 318 319
    /** \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.
     */
320 321
    void createPeriodicMap();

322 323
    void createMacroElementInfo();

324 325
    void updateMacroElementInfo();

326 327 328 329 330 331 332 333 334
    /** \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.
335 336 337 338
     *
     * \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.
339 340
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
341 342 343 344 345 346 347 348
  
    /** \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();

349 350 351 352
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
    void setRankDofs(ProblemVec *probVec);

353 354 355
    /// Sets \ref isRankDof to all matrices and rhs vectors in all stationary problems.
    void setRankDofs();

356 357 358 359
    /// 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
360
    // Removes all periodic boundaries from a given boundary map.
361
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
362

363
    /// Writes a vector of dof pointers to an output stream.
364
    void serialize(ostream &out, DofContainer &data);
365 366

    /// Reads a vector of dof pointers from an input stream.
367 368
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
369 370

    /// Writes a \ref RankToDofContainer to an output stream.
371
    void serialize(ostream &out, RankToDofContainer &data);
372 373

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

377
    /// Writes a periodic dof mapping to an output stream.
378
    void serialize(ostream &out, PeriodicDofMap &data);
379

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

382
    /// Reads a periodic dof mapping from an input stream.
383
    void deserialize(istream &in, PeriodicDofMap &data);
384

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

387 388
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
389
    void serialize(ostream &out, map<const DegreeOfFreedom*, T> &data)
390
    {
391 392
      FUNCNAME("ParallelDomainBase::serialize()");

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

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

411
      int mapSize = 0;
412
      SerUtil::deserialize(in, mapSize);
413 414 415
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
416 417
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
418 419 420

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

421 422 423
	data[dofMap[v1]] = v2;
      }
    }
424

425
  protected:
426
    /// List of all stationary problems that are managed by this mesh distributor.
427
    vector<ProblemVec*> probStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
428

429 430 431
    /// If true, the mesh distributor is already initialized;
    bool initialized;

432 433 434 435 436 437 438 439 440 441 442 443 444 445
    /// 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)
446
    string name;
447

448 449 450
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

451 452 453
    /// Mesh of the problem.
    Mesh *mesh;

454 455 456 457 458 459 460
    /** \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;

461 462 463
    /// Info level.
    int info;

464 465
    /// Pointer to a mesh partitioner that is used to partition the mesh to the ranks.
    MeshPartitioner *partitioner;
466 467

    /// Weights for the elements, i.e., the number of leaf elements within this element.
468
    map<int, double> elemWeights;
469 470

    /** \brief
471 472
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
473
     */
474
    map<int, int> partitionMap;
475

476
    /// Number of DOFs in the rank mesh.
477
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
478

479
    /// Number of DOFs in the whole domain.
480 481
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
482 483 484 485
    // 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.
486
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
487 488
    
    // Maps to each macro element index the type of this element.
489
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
490

Thomas Witkowski's avatar
Thomas Witkowski committed
491
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
492 493 494 495 496 497 498 499 500 501 502 503
     * 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
504
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
505
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
506

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

513
    /** \brief
514 515
     * This map contains for each rank the list of DOFs the current rank must send
     * to exchange solution DOFs at the interior boundaries.
516
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
517
    RankToDofContainer sendDofs;
518 519

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

    /// Maps local to global dof indices.
527
    DofMapping mapLocalGlobalDofs;
528

Thomas Witkowski's avatar
Thomas Witkowski committed
529
    /// Maps local dof indices to real dof indices.
530
    DofMapping mapLocalDofIndex;  
531 532 533 534 535 536

    /** \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.
     */
537 538
    DofIndexToBool isRankDof;

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

555 556 557 558 559
    
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
560
    /// 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
561
    int rstart;
562

563 564 565 566 567 568 569
    /** \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;
570

571 572 573
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

574 575 576
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

577
    /// Stores the number of mesh changes that must lie in between to repartitionings.
578 579
    int repartitionIthChange;

580 581
    /// Counts the number of mesh changes after the last mesh repartitioning was done.
    int nMeshChangesAfterLastRepartitioning;
582

583 584 585
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
586

587
    /// Directory name where all debug output files should be written to.
588
    string debugOutputDir;
589

590 591 592 593 594
    /** \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;
595

596
    map<int, vector<int> > macroElementNeighbours;
597

598 599
    /// Store all macro elements of the overall mesh, i.e., before the macro mesh is
    /// redistributed for the first time.
600
    vector<MacroElement*> allMacroElements;
601

602
    friend class ParallelDebug;
603 604 605
  };
}

606
#endif // AMDIS_MESHDISTRIBUTOR_H