MeshDistributor.h 23.2 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 66 67 68 69 70 71 72 73 74 75 76 77 78

  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;

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

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

    /// Maps local dof indices to real dof indices.
    DofMapping mapLocalDofIndex;  
  };
79 80


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

88
  public:
89
    void initParallelization();
90

91
    void exitParallelization();
92

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

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

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

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

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

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

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

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

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

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

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

171
    /// Returns the number of DOFs in rank's domain for a given FE space.
172
    inline int getNumberRankDofs(const FiniteElemSpace *feSpace) 
173
    {
174 175 176 177
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

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

178
      return dofFeData[feSpace].nRankDofs;
179
    }
180

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    /// 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;
    }
    
    /// Returns the first global DOF index of an FE space, owned by rank.
196
    inline int getStartDofs(const FiniteElemSpace *feSpace)
197
    {
198 199 200 201
      FUNCNAME("MeshDistributor::getStartDofs()");

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

202
      return dofFeData[feSpace].rStartDofs;
203 204
    }

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
    /// 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;
    }

    /// Returns the global number of DOFs for a given FE space.
221
    inline int getNumberOverallDofs(const FiniteElemSpace *feSpace)
222
    {
223 224 225 226
      FUNCNAME("MeshDistributor::getNumberOverallDofs()");

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

227
      return dofFeData[feSpace].nOverallDofs;
228
    }
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
    /// 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;
    }

245
    inline DofMapping& getMapLocalGlobalDofs(const FiniteElemSpace *feSpace)
Thomas Witkowski's avatar
Thomas Witkowski committed
246
    {
247 248 249 250
      FUNCNAME("MeshDistributor::getMapLocalGlobalDofs()");

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

251
      return dofFeData[feSpace].mapLocalGlobalDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
252 253
    }

254
    /// Maps a local DOF to its global index.
255 256
    inline DegreeOfFreedom mapLocalToGlobal(const FiniteElemSpace *feSpace,
					    DegreeOfFreedom dof)
257
    {
258 259 260 261 262
      FUNCNAME("MeshDistributor::mapLocalToGlobal()");

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

263
      return dofFeData[feSpace].mapLocalGlobalDofs[dof];
264
    }
265

266 267
    DegreeOfFreedom mapGlobalToLocal(const FiniteElemSpace *feSpace,
				     DegreeOfFreedom dof);
268

269
    /// Maps a local DOF to its local index.
270 271
    inline DegreeOfFreedom mapLocalToDofIndex(const FiniteElemSpace *feSpace,
					      DegreeOfFreedom dof)
272
    {
273 274 275 276 277
      FUNCNAME("MeshDistributor::mapLocalToDofIndex()");

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

278
      return dofFeData[feSpace].mapLocalDofIndex[dof];
279 280
    }

281 282
    /// Returns the periodic mapping handler, \ref periodicMap.
    inline PeriodicMap& getPeriodicMap()
Thomas Witkowski's avatar
Thomas Witkowski committed
283
    {
284
      return periodicMap;
285 286
    }

287
    DofComm& getSendDofs()
288 289 290 291
    {
      return sendDofs;
    }

292
    DofComm& getRecvDofs()
293 294 295 296
    {
      return recvDofs;
    }

297 298 299 300 301
    DofComm& getPeriodicDofs()
    {
      return periodicDofs;
    }

302 303
    /// 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.
304
    inline bool getIsRankDof(const FiniteElemSpace *feSpace, DegreeOfFreedom dof)
305
    {
306 307
      if (dofFeData[feSpace].isRankDof.count(dof))
	return dofFeData[feSpace].isRankDof[dof];
308 309

      return false;
310
    }
311

312
    inline DofIndexToBool& getIsRankDof(const FiniteElemSpace *feSpace)
313
    {
314
      return dofFeData[feSpace].isRankDof;
315 316
    }

317
    inline long getLastMeshChangeIndex()
318
    {
319
      return lastMeshChangeIndex;
320
    }
321

322
    inline int getMpiRank()
323
    {
324
      return mpiRank;
325
    }
326

Thomas Witkowski's avatar
Thomas Witkowski committed
327 328 329 330 331
    inline int getMpiSize()
    {
      return mpiSize;
    }

332 333 334
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
335 336
    }

337 338
    /// 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.
339 340
    void createBoundaryDofs(const FiniteElemSpace *feSpace,
			    std::set<DegreeOfFreedom> &boundaryDofs);
341

342
    // Writes all data of this object to an output stream.
343
    void serialize(ostream &out);
344

345
    // Reads the object data from an input stream.
346
    void deserialize(istream &in);
347 348

    /** \brief
349 350 351 352
     * 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.
353
     *
354 355 356
     * 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.
357
     */    
358 359 360 361 362
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

363 364
      const FiniteElemSpace *fe = vec.getFeSpace();

365
      for (DofComm::Iterator it(sendDofs, fe); !it.end(); it.nextRank()) {
366
	vector<T> dofs;
367
	dofs.reserve(it.getDofs().size());
368
	
369 370
	for (; !it.endDofIter(); it.nextDof())
	  dofs.push_back(vec[it.getDofIndex()]);
371
	
372
	stdMpi.send(it.getRank(), dofs);
373
      }
374 375 376 377
	     
      for (DofComm::Iterator it(recvDofs); !it.end(); it.nextRank())
        stdMpi.recv(it.getRank());
	     
378
      stdMpi.startCommunication();
379 380 381 382 383

      for (DofComm::Iterator it(recvDofs, fe); !it.end(); it.nextRank())
	for (; !it.endDofIter(); it.nextDof())
	  vec[it.getDofIndex()] = 
	     stdMpi.getRecvData(it.getRank())[it.getDofCounter()];
384 385
    }
    
386
    /** \brief
387 388 389
     * 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.
390 391 392
     */
    void synchVector(SystemVector &vec);

393 394
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
395 396 397 398 399
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

400
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace)
401
    {
402
      return boundaryDofInfo[feSpace];
403 404
    }

405 406
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace,
			    DofContainer& dofs);
407

408 409 410 411 412 413

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

    
414
  protected:
415 416
    void addProblemStat(ProblemStatSeq *probStat);

417 418
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
419
    void createInteriorBoundaryInfo();
420

Thomas Witkowski's avatar
Thomas Witkowski committed
421 422 423 424 425
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
427 428
    void createBoundaryDofs();

429 430
    void createBoundaryDofs(const FiniteElemSpace *feSpace);

431 432
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
433 434
    void removeMacroElements();

435 436
    void updateLocalGlobalNumbering();

437 438
    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
439
    void updateLocalGlobalNumbering(const FiniteElemSpace *feSpace);
440

441 442 443 444
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

445
    /** \brief
446 447 448 449
     * 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.
     */    
450
    void createPeriodicMap(const FiniteElemSpace *feSpace);
451

452 453 454 455 456 457 458 459
    /** \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.
     */
460 461
    void createMacroElementInfo();

462 463
    void updateMacroElementInfo();

464
    /** \brief
465 466 467 468 469 470
     * 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.
471
     *
472 473
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
474
     *
475 476 477
     * \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.
478 479
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
480
  
481 482
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
483
    void setRankDofs(ProblemStatSeq *probStat);
484

485 486
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
487 488
    void setRankDofs();

489 490 491 492
    /// 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
493
    // Removes all periodic boundaries from a given boundary map.
494
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
495

496
    /// Writes a vector of dof pointers to an output stream.
497
    void serialize(ostream &out, DofContainer &data);
498

499 500 501 502
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

503
    /// Reads a vector of dof pointers from an input stream.
504 505
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
506 507

    /// Reads a \ref RankToDofContainer from an input stream.
508 509 510
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofMap);
511 512 513

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

518
      int mapSize = data.size();
519
      SerUtil::serialize(out, mapSize);
520
      for (typename map<const DegreeOfFreedom*, T>::iterator it = data.begin();
521 522 523
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
524 525
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
526 527 528 529 530
      }
    }

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

536
      int mapSize = 0;
537
      SerUtil::deserialize(in, mapSize);
538 539 540
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
541 542
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
543 544 545

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

546 547 548
	data[dofMap[v1]] = v2;
      }
    }
549

550
  protected:
551 552
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
553
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
554

555 556 557
    /// If true, the mesh distributor is already initialized;
    bool initialized;

558 559 560 561 562 563
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

564 565
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
566 567 568
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
569
    string name;
570

571 572
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
573

574 575 576
    /// Mesh of the problem.
    Mesh *mesh;

577
    /** \brief
578 579 580
     * 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.
581 582 583
     */    
    RefinementManager *refineManager;

584 585 586
    /// Info level.
    int info;

587 588
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
589
    MeshPartitioner *partitioner;
590

591 592
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
593
    map<int, double> elemWeights;
594 595

    /** \brief
596 597
     * Stores to every macro element index the number of the rank that owns this
     * macro element.
598
     */
599
    map<int, int> partitionMap;
600

601
    map<const FiniteElemSpace*, DofData> dofFeData;
602

603 604
    /// Data structure to store all sub-objects of all elements of the 
    /// macro mesh.
Thomas Witkowski's avatar
Thomas Witkowski committed
605 606
    ElementObjects elObjects;

607
    /// Maps to each macro element index a pointer to the corresponding element.
608
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
609
    
610
    /// Maps to each macro element index the type of this element.
611
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
612

Thomas Witkowski's avatar
Thomas Witkowski committed
613
    /** \brief 
614 615 616 617
     * 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
618 619 620 621
     */
    InteriorBoundary myIntBoundary;
    
    /** \brief
622 623 624 625
     * 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
626
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
627
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
628

629
    /** \brief
630 631
     * Defines the periodic boundaries with other ranks. Periodic boundaries
     * have no owner, as it is the case of interior boundaries.
632 633 634
     */
    InteriorBoundary periodicBoundary;

635
    /** \brief
636 637
     * This map contains for each rank the list of DOFs the current rank must 
     * send to exchange solution DOFs at the interior boundaries.
638
     */
639
    DofComm sendDofs;
640 641

    /** \brief
642 643 644
     * 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.
645
     */
646
    DofComm recvDofs;
647

648 649 650 651 652 653 654 655
    /** \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;

656
    PeriodicMap periodicMap;
657

658 659 660 661
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
662 663 664
    /** \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
665 666
     * initialization function, if the problem definition has already been read
     * from a serialization file.
667 668
     */
    bool deserialized;
669

670 671 672
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

673 674 675
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

676 677
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
678 679
    int repartitionIthChange;

680 681
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
682
    int nMeshChangesAfterLastRepartitioning;
683

684 685 686
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
687

688
    /// Directory name where all debug output files should be written to.
689
    string debugOutputDir;
690

691
    /** \brief
692 693
     * Stores the mesh change index. This is used to recognize changes in the
     * mesh structure (e.g. through refinement or coarsening managers).
694 695
     */
    long lastMeshChangeIndex;
696

697 698 699 700
    /// 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.
701
    map<int, vector<int> > macroElementNeighbours;
702

703 704
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
705
    vector<MacroElement*> allMacroElements;
706

Thomas Witkowski's avatar
Thomas Witkowski committed
707 708
    Flag createBoundaryDofFlag;

709
    map<const FiniteElemSpace*, BoundaryDofInfo> boundaryDofInfo;
710

Thomas Witkowski's avatar
Thomas Witkowski committed
711
  public:
712 713 714
    /// 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
715 716
    static const Flag BOUNDARY_SUBOBJ_SORTED;

717 718 719 720 721 722 723 724 725
    /// 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
726

727 728
    static MeshDistributor *globalMeshDistributor;

729
    friend class ParallelDebug;
730 731 732
  };
}

733
#endif // AMDIS_MESHDISTRIBUTOR_H