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/ElementObjectDatabase.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"
36
#include "Containers.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
37
#include "Global.h"
38 39
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
40
#include "FiniteElemSpace.h"
41
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
42
#include "BoundaryManager.h"
43
#include "SystemVector.h"
44

45
namespace AMDiS {
46 47

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


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

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

  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;

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

    /// Maps local to global dof indices.
Thomas Witkowski's avatar
Thomas Witkowski committed
73
    DofMap mapDofToGlobal;
74 75

    /// Maps local dof indices to real dof indices.
Thomas Witkowski's avatar
Thomas Witkowski committed
76
    DofMap mapLocalToDof;
77
  };
78 79


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

87
  public:
88
    void initParallelization();
89

90
    void exitParallelization();
91

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

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

122 123 124 125 126 127 128 129 130 131
    /** \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();

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

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

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

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

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

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

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

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

170 171 172 173 174 175 176 177 178 179
    /** \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) 
180
    {
181 182
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

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

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

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

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

195 196 197 198 199 200 201 202 203 204 205 206 207
    /// 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;
    }
208

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

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

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

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
    /// 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;
    }

234 235 236 237 238 239 240 241 242 243
    /** \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)
244
    {
245 246
      FUNCNAME("MeshDistributor::getNumberOverallDofs()");

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

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

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

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

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
    /// 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;
    }

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

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

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

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

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

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

295 296 297 298
    /// 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.
299 300
    DegreeOfFreedom mapGlobalToLocal(const FiniteElemSpace *feSpace,
				     DegreeOfFreedom dof);
301

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

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

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

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

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

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

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

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

      return false;
343
    }
344

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

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

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

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

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

370 371 372 373 374
    inline bool isInitialized()
    {
      return initialized;
    }

375 376
    /// 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.
377 378
    void createBoundaryDofs(const FiniteElemSpace *feSpace,
			    std::set<DegreeOfFreedom> &boundaryDofs);
379

380
    // Writes all data of this object to an output stream.
381
    void serialize(ostream &out);
382

383
    // Reads the object data from an input stream.
384
    void deserialize(istream &in);
385 386

    /** \brief
387 388 389 390
     * 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.
391
     *
392 393 394
     * 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.
395
     */    
396 397 398 399 400
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

401 402
      const FiniteElemSpace *fe = vec.getFeSpace();

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

      for (DofComm::Iterator it(recvDofs, fe); !it.end(); it.nextRank())
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
422 423
    }
    
424
    /** \brief
425 426 427
     * 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.
428 429 430
     */
    void synchVector(SystemVector &vec);

431 432
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
433 434 435 436 437
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

438
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace)
439
    {
440
      return boundaryDofInfo[feSpace];
441 442
    }

443 444
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace,
			    DofContainer& dofs);
445

446 447 448 449 450 451

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

    
452
  protected:
453 454
    void addProblemStat(ProblemStatSeq *probStat);

455 456
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
457
    void createInteriorBoundaryInfo();
458

Thomas Witkowski's avatar
Thomas Witkowski committed
459 460 461 462 463
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
465 466
    void createBoundaryDofs();

467 468
    void createBoundaryDofs(const FiniteElemSpace *feSpace);

469 470
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
471 472
    void removeMacroElements();

473 474
    void updateLocalGlobalNumbering();

475 476
    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
477
    void updateLocalGlobalNumbering(const FiniteElemSpace *feSpace);
478

479 480 481 482
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

483
    /** \brief
484 485 486 487
     * 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.
     */    
488
    void createPeriodicMap(const FiniteElemSpace *feSpace);
489

490 491 492 493 494 495 496 497
    /** \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.
     */
498 499
    void createMacroElementInfo();

500 501
    void updateMacroElementInfo();

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

523 524
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
525 526
    void setRankDofs();

527 528 529 530
    /// Removes all periodic boundary condition information from all matrices and
    /// vectors of all stationary problems and from the mesh itself.
    void removePeriodicBoundaryConditions();

531 532 533 534
    /// Removes all periodic boundary condition information from all matrices and
    /// vector of a given stationary problem.
    void removePeriodicBoundaryConditions(ProblemStatSeq *probStat);

Thomas Witkowski's avatar
Thomas Witkowski committed
535
    // Removes all periodic boundaries from a given boundary map.
536
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
537

538
    /// Writes a vector of dof pointers to an output stream.
539
    void serialize(ostream &out, DofContainer &data);
540

541 542 543 544
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

545
    /// Reads a vector of dof pointers from an input stream.
546 547
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
548 549

    /// Reads a \ref RankToDofContainer from an input stream.
550 551 552
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofMap);
553 554 555

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

560
      int mapSize = data.size();
561
      SerUtil::serialize(out, mapSize);
562
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
563 564 565
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
566 567
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
568 569 570 571 572
      }
    }

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

578
      int mapSize = 0;
579
      SerUtil::deserialize(in, mapSize);
580 581 582
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
583 584
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
585 586 587

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

588 589 590
	data[dofMap[v1]] = v2;
      }
    }
591

592
  protected:
593 594
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
595
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
596

597 598 599
    /// If true, the mesh distributor is already initialized;
    bool initialized;

600 601 602 603 604 605
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

606 607
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
608 609 610
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
611
    string name;
612

613 614
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
615

616 617 618
    /// Mesh of the problem.
    Mesh *mesh;

619 620 621
    /// 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.    
622 623
    RefinementManager *refineManager;

624 625 626
    /// Info level.
    int info;

627 628
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
629
    MeshPartitioner *partitioner;
630

631 632
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
633
    map<int, double> elemWeights;
634

635 636
    /// Stores to every macro element index the number of the rank that owns this
    /// macro element.
637
    map<int, int> partitionMap;
638

639
    map<const FiniteElemSpace*, DofData> dofFeData;
640

641
    /// Database to store and query all sub-objects of all elements of the 
642
    /// macro mesh.
643
    ElementObjectDatabase elObjDb;
Thomas Witkowski's avatar
Thomas Witkowski committed
644

645
    /// Maps to each macro element index a pointer to the corresponding element.
646
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
647
    
648
    /// Maps to each macro element index the type of this element.
649
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
650

651 652 653 654
    /// 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.
655
    InteriorBoundary rankIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
656
    
657 658 659 660
    /// 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
661
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
662

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

667 668
    /// This map contains for each rank the list of DOFs the current rank must 
    /// end to exchange solution DOFs at the interior boundaries.
669
    DofComm sendDofs;
670

671 672 673
    /// 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.
674
    DofComm recvDofs;
675

676 677 678 679
    /// 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. 
680 681
    DofComm periodicDofs;

682
    PeriodicMap periodicMap;
683

684 685 686 687
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
688 689 690 691
    /// 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.
692
    bool deserialized;
693

694 695 696
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

697 698 699
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

700 701
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
702 703
    int repartitionIthChange;

704 705
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
706
    int nMeshChangesAfterLastRepartitioning;
707

708 709 710
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
711

712
    /// Directory name where all debug output files should be written to.
713
    string debugOutputDir;
714

715 716
    /// Stores the mesh change index. This is used to recognize changes in the
    /// mesh structure (e.g. through refinement or coarsening managers).
717
    long lastMeshChangeIndex;
718

719 720 721 722
    /// 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.
723
    map<int, vector<int> > macroElementNeighbours;
724

725 726
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
727
    vector<MacroElement*> allMacroElements;
728

Thomas Witkowski's avatar
Thomas Witkowski committed
729 730
    Flag createBoundaryDofFlag;

731
    map<const FiniteElemSpace*, BoundaryDofInfo> boundaryDofInfo;
732

Thomas Witkowski's avatar
Thomas Witkowski committed
733
  public:
734 735
    bool sebastianMode;

736 737 738
    /// 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
739 740
    static const Flag BOUNDARY_SUBOBJ_SORTED;

741 742 743 744 745 746 747 748 749
    /// 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
750

751 752
    static MeshDistributor *globalMeshDistributor;

753
    friend class ParallelDebug;
754 755 756
  };
}

757
#endif // AMDIS_MESHDISTRIBUTOR_H