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

44
namespace AMDiS {
45 46

  using namespace std;
Thomas Witkowski's avatar
Thomas Witkowski committed
47 48 49 50


  struct BoundaryDofInfo
  {
51
    map<GeoIndex, DofContainerSet> geoDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
52 53
  };

54 55 56 57 58 59 60 61 62 63 64 65

  struct DofData
  {
    /// Number of DOFs in the rank mesh.
    int nRankDofs;

    /// Is the index of the first global DOF index, which is owned by the rank.
    int rStartDofs;

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

66 67 68
    /// 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.
69 70 71
    DofIndexToBool isRankDof;

    /// Maps local to global dof indices.
72
    DofMapping mapDofToGlobal;
73 74

    /// Maps local dof indices to real dof indices.
75
    DofMapping mapLocalToDof;
76
  };
77 78


79
  class MeshDistributor
80
  {
81
  private:
82
    MeshDistributor();
83
	          
84
    virtual ~MeshDistributor() {}
85

86
  public:
87
    void initParallelization();
88

89
    void exitParallelization();
90

91 92 93
    /// Adds a DOFVector to the set of \ref interchangeVecs. Thus, this vector 
    /// will be automatically interchanged between ranks when mesh is 
    /// repartitioned.
94 95 96 97 98
    void addInterchangeVector(DOFVector<double> *vec)
    {
      interchangeVectors.push_back(vec);
    }

99 100 101 102 103 104 105
    /// 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));
    }
    
106
    /** \brief
107 108 109 110 111
     * 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.
112
     *
113 114 115 116 117
     * \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.
118
     */
119
    void checkMeshChange(bool tryRepartition = true);
120

121 122 123 124 125 126 127 128 129 130
    /** \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();
    
    /// Calculates the imbalancing factor and prints it to screen.
    void printImbalanceFactor();

131
    /** \brief
132 133 134 135
     * 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.
136 137
     */
    void testForMacroMesh();
138

139 140
    /// Set for each element on the partitioning level the number of 
    /// leaf elements.
141
    void setInitialElementWeights();
142

143
    inline virtual string getName() 
144 145 146
    { 
      return name; 
    }
147

Thomas Witkowski's avatar
Thomas Witkowski committed
148 149 150 151 152
    inline Mesh* getMesh()
    {
      return mesh;
    }

153 154
    /// Returns an FE space from \ref feSpaces.
    inline const FiniteElemSpace* getFeSpace(unsigned int i = 0)
155
    {
156 157 158 159 160
      FUNCNAME("MeshDistributor::getFeSpace()");

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

      return feSpaces[i];
161
    }
162 163 164 165 166 167 168

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

169 170 171 172 173 174 175 176 177 178
    /** \brief
     * Returns the number of DOFs in rank's domain for a given FE space.
     *
     * \param[in]  feSpace  If the FE space is defined, the function returns
     *                      the number of DOFs for this FE space. If this
     *                      parameter is not specified, the function assumes
     *                      that there is only one FE space and returns the
     *                      number of DOFs for this one.
     */
    inline int getNumberRankDofs(const FiniteElemSpace *feSpace = NULL) 
179
    {
180 181
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

182 183 184 185 186 187 188
      if (feSpace == NULL) {
	TEST_EXIT_DBG(dofFeData.size() == 1)
	  ("More than one FE space defined!\n");

	return dofFeData.begin()->second.nRankDofs;
      }

189 190
      TEST_EXIT_DBG(dofFeData.count(feSpace))("Should not happen!\n");

191
      return dofFeData[feSpace].nRankDofs;
192
    }
193

194 195 196 197 198 199 200 201 202 203 204 205 206
    /// Returns the number of DOFs in rank's domain for a set of FE spaces.
    inline int getNumberRankDofs(vector<const FiniteElemSpace*>& feSpaces)
    {
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

      int result = 0;
      for (unsigned int i = 0; i < feSpaces.size(); i++) {
	TEST_EXIT_DBG(dofFeData.count(feSpaces[i]))("Should not happen!\n");
	result += dofFeData[feSpaces[i]].nRankDofs;
      }

      return result;
    }
207

208
    /// Returns the first global DOF index of an FE space, owned by rank.
209
    inline int getStartDofs(const FiniteElemSpace *feSpace)
210
    {
211 212 213 214
      FUNCNAME("MeshDistributor::getStartDofs()");

      TEST_EXIT_DBG(dofFeData.count(feSpace))("Should not happen!\n");

215
      return dofFeData[feSpace].rStartDofs;
216 217
    }

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    /// Returns the first global DOF index for a set of FE spaces, owned by rank.
    inline int getStartDofs(vector<const FiniteElemSpace*>& feSpaces)
    {
      FUNCNAME("MeshDistributor::getStartDofs()");

      int result = 0;
      for (unsigned int i = 0; i < feSpaces.size(); i++) {
	TEST_EXIT_DBG(dofFeData.count(feSpaces[i]))("Should not happen!\n");

	result += dofFeData[feSpaces[i]].rStartDofs;
      }

      return result;
    }

233 234 235 236 237 238 239 240 241 242
    /** \brief
     * Returns the global number of DOFs for a given FE space.
     *
     * \param[in]  feSpace  If the FE space is defined, the function returns
     *                      the number of DOFs for this FE space. If this
     *                      parameter is not specified, the function assumes
     *                      that there is only one FE space and returns the
     *                      number of DOFs for this one.
     */
    inline int getNumberOverallDofs(const FiniteElemSpace *feSpace = NULL)
243
    {
244 245
      FUNCNAME("MeshDistributor::getNumberOverallDofs()");

246 247 248 249 250 251 252
      if (feSpace == NULL) {
	TEST_EXIT_DBG(dofFeData.size() == 1)
	  ("More than one FE space defined!\n");

	return dofFeData.begin()->second.nOverallDofs;
      }

253 254
      TEST_EXIT_DBG(dofFeData.count(feSpace))("Should not happen!\n");

255
      return dofFeData[feSpace].nOverallDofs;
256
    }
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
    /// Returns the global number of DOFs for a set of FE spaces.
    inline int getNumberOverallDofs(vector<const FiniteElemSpace*>& feSpaces)
    {
      FUNCNAME("MeshDistributor::getNumberOverallDofs()");

      int result = 0;
      for (unsigned int i = 0; i < feSpaces.size(); i++) {
	TEST_EXIT_DBG(dofFeData.count(feSpaces[i]))("Should not happen!\n");

	result += dofFeData[feSpaces[i]].nOverallDofs;
      }

      return result;
    }

273
    inline DofMapping& getMapDofToGlobal(const FiniteElemSpace *feSpace)
Thomas Witkowski's avatar
Thomas Witkowski committed
274
    {
275
      FUNCNAME("MeshDistributor::getMapDofToGlobal()");
276 277 278

      TEST_EXIT_DBG(dofFeData.count(feSpace))("Should not happen!\n");

279
      return dofFeData[feSpace].mapDofToGlobal;
Thomas Witkowski's avatar
Thomas Witkowski committed
280 281
    }

282
    /// Maps a local DOF to its global index.
283 284
    inline DegreeOfFreedom mapDofToGlobal(const FiniteElemSpace *feSpace,
					  DegreeOfFreedom dof)
285
    {
286
      FUNCNAME("MeshDistributor::mapDofToGlobal()");
287 288 289 290

      TEST_EXIT_DBG(dofFeData.count(feSpace))
	("No DOF data for FE space at addr %p!\n", feSpace);

291
      return dofFeData[feSpace].mapDofToGlobal[dof];
292
    }
293

294 295 296 297
    /// Returns for a global index the DOF index in rank's subdomain. As there
    /// is no direct data structure that stores this information, we have to
    /// search for it in \ref dofFeData.mapDofToGlobal. This is not very
    /// efficient and this function should thus be used for debugging only.
298 299
    DegreeOfFreedom mapGlobalToLocal(const FiniteElemSpace *feSpace,
				     DegreeOfFreedom dof);
300

301
    /// Maps a local DOF to its local index.
302 303
    inline DegreeOfFreedom mapLocalToDof(const FiniteElemSpace *feSpace,
					 DegreeOfFreedom dof)
304
    {
305
      FUNCNAME("MeshDistributor::mapLocalToDof()");
306 307 308 309

      TEST_EXIT_DBG(dofFeData.count(feSpace))
	("No DOF data for FE space at addr %p!\n", feSpace);

310
      return dofFeData[feSpace].mapLocalToDof[dof];
311 312
    }

313 314
    /// Returns the periodic mapping handler, \ref periodicMap.
    inline PeriodicMap& getPeriodicMap()
Thomas Witkowski's avatar
Thomas Witkowski committed
315
    {
316
      return periodicMap;
317 318
    }

319
    DofComm& getSendDofs()
320 321 322 323
    {
      return sendDofs;
    }

324
    DofComm& getRecvDofs()
325 326 327 328
    {
      return recvDofs;
    }

329 330 331 332 333
    DofComm& getPeriodicDofs()
    {
      return periodicDofs;
    }

334 335
    /// 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.
336
    inline bool getIsRankDof(const FiniteElemSpace *feSpace, DegreeOfFreedom dof)
337
    {
338 339
      if (dofFeData[feSpace].isRankDof.count(dof))
	return dofFeData[feSpace].isRankDof[dof];
340 341

      return false;
342
    }
343

344
    inline DofIndexToBool& getIsRankDof(const FiniteElemSpace *feSpace)
345
    {
346
      return dofFeData[feSpace].isRankDof;
347 348
    }

349
    inline long getLastMeshChangeIndex()
350
    {
351
      return lastMeshChangeIndex;
352
    }
353

354
    inline int getMpiRank()
355
    {
356
      return mpiRank;
357
    }
358

Thomas Witkowski's avatar
Thomas Witkowski committed
359 360 361 362 363
    inline int getMpiSize()
    {
      return mpiSize;
    }

364 365 366
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
367 368
    }

369 370
    /// Creates a set of all DOFs that are on interior boundaries of rank's
    /// domain. Thus, it creates the union of \ref sendDofs and \ref recvDofs.
371 372
    void createBoundaryDofs(const FiniteElemSpace *feSpace,
			    std::set<DegreeOfFreedom> &boundaryDofs);
373

374
    // Writes all data of this object to an output stream.
375
    void serialize(ostream &out);
376

377
    // Reads the object data from an input stream.
378
    void deserialize(istream &in);
379 380

    /** \brief
381 382 383 384
     * 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.
385
     *
386 387 388
     * 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.
389
     */    
390 391 392 393 394
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

395 396
      const FiniteElemSpace *fe = vec.getFeSpace();

397
      for (DofComm::Iterator it(sendDofs, fe); !it.end(); it.nextRank()) {
398
	vector<T> dofs;
399
	dofs.reserve(it.getDofs().size());
400
	
401 402
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
403
	
404
	stdMpi.send(it.getRank(), dofs);
405
      }
406 407 408 409
	     
      for (DofComm::Iterator it(recvDofs); !it.end(); it.nextRank())
        stdMpi.recv(it.getRank());
	     
410
      stdMpi.startCommunication();
411 412 413 414 415

      for (DofComm::Iterator it(recvDofs, fe); !it.end(); it.nextRank())
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
416 417
    }
    
418
    /** \brief
419 420 421
     * 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.
422 423 424
     */
    void synchVector(SystemVector &vec);

425 426
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
427 428 429 430 431
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

432
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace)
433
    {
434
      return boundaryDofInfo[feSpace];
435 436
    }

437 438
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace,
			    DofContainer& dofs);
439

440 441 442 443 444 445

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

    
446
  protected:
447 448
    void addProblemStat(ProblemStatSeq *probStat);

449 450
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
451
    void createInteriorBoundaryInfo();
452

Thomas Witkowski's avatar
Thomas Witkowski committed
453 454 455 456 457
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
459 460
    void createBoundaryDofs();

461 462
    void createBoundaryDofs(const FiniteElemSpace *feSpace);

463 464
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
465 466
    void removeMacroElements();

467 468
    void updateLocalGlobalNumbering();

469 470
    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
471
    void updateLocalGlobalNumbering(const FiniteElemSpace *feSpace);
472

473 474 475 476
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

477
    /** \brief
478 479 480 481
     * 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.
     */    
482
    void createPeriodicMap(const FiniteElemSpace *feSpace);
483

484 485 486 487 488 489 490 491
    /** \brief
     * 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.
     */
492 493
    void createMacroElementInfo();

494 495
    void updateMacroElementInfo();

496
    /** \brief
497 498 499 500 501 502
     * 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.
503
     *
504 505
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
506
     *
507 508 509
     * \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.
510 511
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
512
  
513 514
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
515
    void setRankDofs(ProblemStatSeq *probStat);
516

517 518
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
519 520
    void setRankDofs();

521 522 523 524
    /// 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
525
    // Removes all periodic boundaries from a given boundary map.
526
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
527

528
    /// Writes a vector of dof pointers to an output stream.
529
    void serialize(ostream &out, DofContainer &data);
530

531 532 533 534
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

535
    /// Reads a vector of dof pointers from an input stream.
536 537
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
538 539

    /// Reads a \ref RankToDofContainer from an input stream.
540 541 542
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofMap);
543 544 545

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

550
      int mapSize = data.size();
551
      SerUtil::serialize(out, mapSize);
552
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
553 554 555
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
556 557
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
558 559 560 561 562
      }
    }

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

568
      int mapSize = 0;
569
      SerUtil::deserialize(in, mapSize);
570 571 572
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
573 574
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
575 576 577

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

578 579 580
	data[dofMap[v1]] = v2;
      }
    }
581

582
  protected:
583 584
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
585
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
586

587 588 589
    /// If true, the mesh distributor is already initialized;
    bool initialized;

590 591 592 593 594 595
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

596 597
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
598 599 600
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
601
    string name;
602

603 604
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
605

606 607 608
    /// Mesh of the problem.
    Mesh *mesh;

609
    /** \brief
610 611 612
     * 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.
613 614 615
     */    
    RefinementManager *refineManager;

616 617 618
    /// Info level.
    int info;

619 620
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
621
    MeshPartitioner *partitioner;
622

623 624
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
625
    map<int, double> elemWeights;
626 627

    /** \brief
628 629
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
630
     */
631
    map<int, int> partitionMap;
632

633
    map<const FiniteElemSpace*, DofData> dofFeData;
634

635 636
    /// Data structure to store all sub-objects of all elements of the 
    /// macro mesh.
Thomas Witkowski's avatar
Thomas Witkowski committed
637 638
    ElementObjects elObjects;

639
    /// Maps to each macro element index a pointer to the corresponding element.
640
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
641
    
642
    /// Maps to each macro element index the type of this element.
643
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
644

Thomas Witkowski's avatar
Thomas Witkowski committed
645
    /** \brief 
646 647 648 649
     * 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.
Thomas Witkowski's avatar
Thomas Witkowski committed
650
     */
651
    InteriorBoundary rankIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
652 653
    
    /** \brief
654 655 656 657
     * 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
658
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
659
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
660

661
    /** \brief
662 663
     * Defines the periodic boundaries with other ranks. Periodic boundaries
     * have no owner, as it is the case of interior boundaries.
664 665 666
     */
    InteriorBoundary periodicBoundary;

667
    /** \brief
668 669
     * This map contains for each rank the list of DOFs the current rank must 
     * send to exchange solution DOFs at the interior boundaries.
670
     */
671
    DofComm sendDofs;
672 673

    /** \brief
674 675 676
     * This map contains on each rank the list of DOFs from which the current 
     * rank will receive DOF values (i.e., this are all DOFs at an interior 
     * boundary). The DOF indices are given in rank's local numbering.
677
     */
678
    DofComm recvDofs;
679

680 681 682 683 684 685 686 687
    /** \brief
     * This map contains on each rank a list of DOFs along the interior bound-
     * aries to communicate with other ranks. The DOF indices are given in rank's
     * local numbering. Periodic boundaries within one subdomain are not 
     * considered here. 
     */
    DofComm periodicDofs;

688
    PeriodicMap periodicMap;
689

690 691 692 693
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
694 695 696
    /** \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
697 698
     * initialization function, if the problem definition has already been read
     * from a serialization file.
699 700
     */
    bool deserialized;
701

702 703 704
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

705 706 707
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

708 709
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
710 711
    int repartitionIthChange;

712 713
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
714
    int nMeshChangesAfterLastRepartitioning;
715

716 717 718
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
719

720
    /// Directory name where all debug output files should be written to.
721
    string debugOutputDir;
722

723
    /** \brief
724 725
     * Stores the mesh change index. This is used to recognize changes in the
     * mesh structure (e.g. through refinement or coarsening managers).
726 727
     */
    long lastMeshChangeIndex;
728

729 730 731 732
    /// 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.
733
    map<int, vector<int> > macroElementNeighbours;
734

735 736
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
737
    vector<MacroElement*> allMacroElements;
738

Thomas Witkowski's avatar
Thomas Witkowski committed
739 740
    Flag createBoundaryDofFlag;

741
    map<const FiniteElemSpace*, BoundaryDofInfo> boundaryDofInfo;
742

Thomas Witkowski's avatar
Thomas Witkowski committed
743
  public:
744 745
    bool sebastianMode;

746 747 748
    /// 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
749 750
    static const Flag BOUNDARY_SUBOBJ_SORTED;

751 752 753 754 755 756 757 758 759
    /// 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
760

761 762
    static MeshDistributor *globalMeshDistributor;

763
    friend class ParallelDebug;
764 765 766
  };
}

767
#endif // AMDIS_MESHDISTRIBUTOR_H