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

46
namespace AMDiS {
47 48

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


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

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

  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;

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

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

    /// Maps local dof indices to real dof indices.
Thomas Witkowski's avatar
Thomas Witkowski committed
77
    DofMap mapLocalToDof;
78
  };
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 172 173 174 175 176 177 178 179 180
    /** \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) 
181
    {
182 183
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

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

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

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

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

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

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

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

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

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

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

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

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

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

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

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    /// 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
275
    inline DofMap& getMapDofToGlobal(const FiniteElemSpace *feSpace)
Thomas Witkowski's avatar
Thomas Witkowski committed
276
    {
277
      FUNCNAME("MeshDistributor::getMapDofToGlobal()");
278 279 280

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      return false;
344
    }
345

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

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

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

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

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

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

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

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

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

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

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

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

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

432 433
    void check3dValidMesh();

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

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

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

447 448 449 450
    const ElementObjectDatabase& getElementObjectDb() 
    {
      return elObjDb;
    }
451 452 453 454

    /// Adds a stationary problem to the global mesh distributor objects.
    static void addProblemStatGlobal(ProblemStatSeq *probStat);
    
455
  protected:
456 457
    void addProblemStat(ProblemStatSeq *probStat);

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

Thomas Witkowski's avatar
Thomas Witkowski committed
462 463 464 465 466
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
468 469
    void createBoundaryDofs();

470 471
    void createBoundaryDofs(const FiniteElemSpace *feSpace);

472 473
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
474 475
    void removeMacroElements();

476 477
    void updateLocalGlobalNumbering();

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

482 483 484 485
    /// Calls \ref createPeriodicMap(feSpace) for all FE spaces that are
    /// handled by the mesh distributor.
    void createPeriodicMap();

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

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

503 504
    void updateMacroElementInfo();

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

526 527
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
528 529
    void setRankDofs();

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

534 535 536 537
    /// 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
538
    // Removes all periodic boundaries from a given boundary map.
539
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
540

541 542
    void createMeshLevelStructure();

543
    /// Writes a vector of dof pointers to an output stream.
544
    void serialize(ostream &out, DofContainer &data);
545

546 547 548 549
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

550
    /// Reads a vector of dof pointers from an input stream.
551 552
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
553 554

    /// Reads a \ref RankToDofContainer from an input stream.
555 556 557
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofMap);
558 559 560

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

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

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

583
      int mapSize = 0;
584
      SerUtil::deserialize(in, mapSize);
585 586 587
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
588 589
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
590 591 592

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

593 594 595
	data[dofMap[v1]] = v2;
      }
    }
596

597
  protected:
598 599
    /// List of all stationary problems that are managed by this mesh 
    /// distributor.
600
    vector<ProblemStatSeq*> problemStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
601

602 603 604
    /// If true, the mesh distributor is already initialized;
    bool initialized;

605 606 607 608 609 610
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

611 612
    /// MPI communicator collected all processes, which should be used for
    /// calculation. The Debug procces is not included in this communicator.
613 614 615
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
616
    string name;
617

618 619
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
620

621 622 623
    /// Mesh of the problem.
    Mesh *mesh;

624 625 626
    /// 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.    
627 628
    RefinementManager *refineManager;

629 630 631
    /// Info level.
    int info;

632 633
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
634
    MeshPartitioner *partitioner;
635

636 637
    /// Weights for the elements, i.e., the number of leaf elements within 
    /// this element.
638
    map<int, double> elemWeights;
639

640 641
    /// Stores to every macro element index the number of the rank that owns this
    /// macro element.
642
    map<int, int> partitionMap;
643

644
    map<const FiniteElemSpace*, DofData> dofFeData;
645

646
    /// Database to store and query all sub-objects of all elements of the 
647
    /// macro mesh.
648
    ElementObjectDatabase elObjDb;
Thomas Witkowski's avatar
Thomas Witkowski committed
649

650
    /// Maps to each macro element index a pointer to the corresponding element.
651
    map<int, Element*> macroElIndexMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
652
    
653
    /// Maps to each macro element index the type of this element.
654
    map<int, int> macroElIndexTypeMap;
Thomas Witkowski's avatar
Thomas Witkowski committed
655

656 657 658 659
    /// 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.
660
    InteriorBoundary rankIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
661
    
662 663 664 665
    /// 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
666
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
667

668 669
    /// Defines the periodic boundaries with other ranks. Periodic boundaries
    /// have no owner, as it is the case of interior boundaries.
670 671
    InteriorBoundary periodicBoundary;

672 673
    /// This map contains for each rank the list of DOFs the current rank must 
    /// end to exchange solution DOFs at the interior boundaries.
674
    DofComm sendDofs;
675

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

681 682 683 684
    /// 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. 
685 686
    DofComm periodicDofs;

687
    PeriodicMap periodicMap;
688

689 690 691 692
    /// This set of values must be interchanged between ranks when the mesh is 
    /// repartitioned.
    vector<DOFVector<double>*> interchangeVectors;
		        
693 694 695 696
    /// 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.
697
    bool deserialized;
698

699 700 701
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

702 703 704
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

705 706
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
707 708
    int repartitionIthChange;

709 710
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
711
    int nMeshChangesAfterLastRepartitioning;
712

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

717
    /// Directory name where all debug output files should be written to.
718
    string debugOutputDir;
719

720 721
    /// Stores the mesh change index. This is used to recognize changes in the
    /// mesh structure (e.g. through refinement or coarsening managers).
722
    long lastMeshChangeIndex;
723

724 725 726 727
    /// 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.
728
    map<int, vector<int> > macroElementNeighbours;
729

730 731
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
732
    vector<MacroElement*> allMacroElements;
733

Thomas Witkowski's avatar
Thomas Witkowski committed
734 735
    Flag createBoundaryDofFlag;

736
    map<const FiniteElemSpace*, BoundaryDofInfo> boundaryDofInfo;
737

738 739
    MeshLevelData levelData;

Thomas Witkowski's avatar
Thomas Witkowski committed
740
  public:
741 742
    bool sebastianMode;

743 744 745
    /// 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
746 747
    static const Flag BOUNDARY_SUBOBJ_SORTED;

748 749 750 751 752 753 754 755 756
    /// 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
757

758 759
    static MeshDistributor *globalMeshDistributor;

760
    friend class ParallelDebug;
761 762 763
  };
}

764
#endif // AMDIS_MESHDISTRIBUTOR_H