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

42
namespace AMDiS {
43 44

  using namespace std;
Thomas Witkowski's avatar
Thomas Witkowski committed
45 46 47 48


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

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

  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;  
  };
  
78
  class MeshDistributor
79
  {
80
  private:
81
    MeshDistributor();
82
	          
83
    virtual ~MeshDistributor() {}
84

85
  public:
86
    void initParallelization();
87

88
    void exitParallelization();
89

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

98 99 100 101 102 103 104
    /// Adds all DOFVectors of a SystemVector to \ref interchangeVecs.
    void addInterchangeVector(SystemVector *vec)
    {
      for (int i = 0; i < vec->getSize(); i++)
	interchangeVectors.push_back(vec->getDOFVector(i));
    }
    
105
    /** \brief
106 107 108 109 110
     * 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.
111
     *
112 113 114 115 116
     * \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.
117
     */
118
    void checkMeshChange(bool tryRepartition = true);
119

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

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

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

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

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

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

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

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

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

168
    /// Returns \ref nRankDOFs, the number of DOFs in the rank mesh.
169
    inline int getNumberRankDofs(const FiniteElemSpace *feSpace) 
170
    {
171 172 173 174
      FUNCNAME("MeshDistributor::getNumberRankDofs()");

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

175
      return dofFeData[feSpace].nRankDofs;
176
    }
177

178
    /// Returns \ref rStartDofs, the first global DOF index owned by rank.
179
    inline int getStartDofs(const FiniteElemSpace *feSpace)
180
    {
181 182 183 184
      FUNCNAME("MeshDistributor::getStartDofs()");

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

185
      return dofFeData[feSpace].rStartDofs;
186 187
    }

188
    /// Returns \ref nOverallDofs, the global number of DOFs.
189
    inline int getNumberOverallDofs(const FiniteElemSpace *feSpace)
190
    {
191 192 193 194
      FUNCNAME("MeshDistributor::getNumberOverallDofs()");

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

195
      return dofFeData[feSpace].nOverallDofs;
196
    }
197

198
    inline DofMapping& getMapLocalGlobalDofs(const FiniteElemSpace *feSpace)
Thomas Witkowski's avatar
Thomas Witkowski committed
199
    {
200 201 202 203
      FUNCNAME("MeshDistributor::getMapLocalGlobalDofs()");

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

204
      return dofFeData[feSpace].mapLocalGlobalDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
205 206
    }

207
    /// Maps a local DOF to its global index.
208 209
    inline DegreeOfFreedom mapLocalToGlobal(const FiniteElemSpace *feSpace,
					    DegreeOfFreedom dof)
210
    {
211 212 213 214 215
      FUNCNAME("MeshDistributor::mapLocalToGlobal()");

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

216
      return dofFeData[feSpace].mapLocalGlobalDofs[dof];
217
    }
218

219 220
    DegreeOfFreedom mapGlobalToLocal(const FiniteElemSpace *feSpace,
				     DegreeOfFreedom dof);
221

222
    /// Maps a local DOF to its local index.
223 224
    inline DegreeOfFreedom mapLocalToDofIndex(const FiniteElemSpace *feSpace,
					      DegreeOfFreedom dof)
225
    {
226 227 228 229 230
      FUNCNAME("MeshDistributor::mapLocalToDofIndex()");

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

231
      return dofFeData[feSpace].mapLocalDofIndex[dof];
232 233
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
234 235 236 237 238 239
    /// Returns the periodic mapping for all boundary DOFs in rank.
    inline PeriodicDofMap& getPeriodicMapping()
    {
      return periodicDof;
    }

240 241
    /// Returns for a global dof index its periodic mapping for a given 
    /// boundary type.
242
    inline int getPeriodicMapping(int globalDofIndex, BoundaryType type)
243
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
244 245
      FUNCNAME("MeshDistributor::getPeriodicMapping()");

246
      TEST_EXIT_DBG(periodicDof[type].count(globalDofIndex) == 1)
Thomas Witkowski's avatar
Thomas Witkowski committed
247 248
	("There is no periodic association for global DOF %d for boundary type %d!\n",
	 globalDofIndex, type);
249 250 251 252

      return periodicDof[type][globalDofIndex];
    }

253
    /// For a given global DOF index, this function returns the set of periodic
254 255
    /// associations, i.e., the boundary types the DOF is associated to, for 
    /// this DOF.
256
    inline std::set<BoundaryType>& getPerDofAssociations(int globalDofIndex)
257
    {      
258 259 260
      TEST_EXIT_DBG(periodicDofAssociations.count(globalDofIndex)) 
 	("Should not happen!\n"); 

261
      return periodicDofAssociations[globalDofIndex];
262
    }
263

264
    /// Returns true, if the DOF (global index) is a periodic DOF.
265
    inline bool isPeriodicDof(int globalDofIndex)
266
    {
267 268
      return (periodicDofAssociations.count(globalDofIndex) > 0 &&
	       periodicDofAssociations[globalDofIndex].size() > 0);
269 270
    }

271 272 273
    /// Returns true, if the DOF (global index) is a periodic DOF for the given
    /// boundary type.
    inline bool isPeriodicDof(int globalDofIndex, BoundaryType type)
274 275
    {
      return (periodicDof[type].count(globalDofIndex) > 0);
276 277
    }

278 279 280 281 282 283 284 285 286 287
    map<int, map<const FiniteElemSpace*, DofContainer> >& getSendDofs()
    {
      return sendDofs;
    }

    map<int, map<const FiniteElemSpace*, DofContainer> >& getRecvDofs()
    {
      return recvDofs;
    }

288 289
    /// 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.
290
    inline bool getIsRankDof(const FiniteElemSpace *feSpace, DegreeOfFreedom dof)
291
    {
292 293
      if (dofFeData[feSpace].isRankDof.count(dof))
	return dofFeData[feSpace].isRankDof[dof];
294 295

      return false;
296
    }
297

298
    inline DofIndexToBool& getIsRankDof(const FiniteElemSpace *feSpace)
299
    {
300
      return dofFeData[feSpace].isRankDof;
301 302
    }

303
    inline long getLastMeshChangeIndex()
304
    {
305
      return lastMeshChangeIndex;
306
    }
307

308
    inline int getMpiRank()
309
    {
310
      return mpiRank;
311
    }
312

Thomas Witkowski's avatar
Thomas Witkowski committed
313 314 315 316 317
    inline int getMpiSize()
    {
      return mpiSize;
    }

318 319 320
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
321 322
    }

323 324
    /// 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.
325 326
    void createBoundaryDofs(const FiniteElemSpace *feSpace,
			    std::set<DegreeOfFreedom> &boundaryDofs);
327

328
    // Writes all data of this object to an output stream.
329
    void serialize(ostream &out);
330

331
    // Reads the object data from an input stream.
332
    void deserialize(istream &in);
333 334

    /** \brief
335 336 337 338
     * 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.
339
     *
340 341 342
     * 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.
343
     */    
344 345 346 347 348
    template<typename T>
    void synchVector(DOFVector<T> &vec) 
    {
      StdMpi<vector<T> > stdMpi(mpiComm);

349 350 351 352 353
      const FiniteElemSpace *fe = vec.getFeSpace();

      typedef map<int, map<const FiniteElemSpace*, DofContainer> >::iterator it_type;

      for (it_type sendIt = sendDofs.begin(); 
354 355
	   sendIt != sendDofs.end(); ++sendIt) {
	vector<T> dofs;
356
	int nSendDofs = sendIt->second[fe].size();
357 358 359
	dofs.reserve(nSendDofs);
	
	for (int i = 0; i < nSendDofs; i++)
360
	  dofs.push_back(vec[*((sendIt->second[fe])[i])]);
361 362 363 364
	
	stdMpi.send(sendIt->first, dofs);
      }
      
365
      for (it_type recvIt = recvDofs.begin();
366
	   recvIt != recvDofs.end(); ++recvIt)
367
	stdMpi.recv(recvIt->first, recvIt->second[fe].size());
368 369 370
      
      stdMpi.startCommunication();
      
371
      for (it_type recvIt = recvDofs.begin();
372 373
	   recvIt != recvDofs.end(); ++recvIt)
	for (unsigned int i = 0; i < recvIt->second.size(); i++)
374
	  vec[*(recvIt->second[fe])[i]] = stdMpi.getRecvData(recvIt->first)[i];
375 376
    }
    
377
    /** \brief
378 379 380
     * 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.
381 382 383
     */
    void synchVector(SystemVector &vec);

384 385
    void check3dValidMesh();

Thomas Witkowski's avatar
Thomas Witkowski committed
386 387 388 389 390
    void setBoundaryDofRequirement(Flag flag)
    {
      createBoundaryDofFlag = flag;
    }

391
    BoundaryDofInfo& getBoundaryDofInfo(const FiniteElemSpace *feSpace)
392
    {
393
      return boundaryDofInfo[feSpace];
394 395
    }

396 397
    void getAllBoundaryDofs(const FiniteElemSpace *feSpace,
			    DofContainer& dofs);
398

399 400 401 402 403 404

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

    
405
  protected:
406 407
    void addProblemStat(ProblemStatSeq *probStat);

408 409
    /// Determines the interior boundaries, i.e. boundaries between ranks, and
    /// stores all information about them in \ref interiorBoundary.
410
    void createInteriorBoundaryInfo();
411

Thomas Witkowski's avatar
Thomas Witkowski committed
412 413 414 415 416
    void updateInteriorBoundaryInfo();

    void createMeshElementData();

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

Thomas Witkowski's avatar
Thomas Witkowski committed
418 419
    void createBoundaryDofs();

420 421
    void createBoundaryDofs(const FiniteElemSpace *feSpace);

422 423
    /// Removes all macro elements from the mesh that are not part of ranks 
    /// partition.
424 425
    void removeMacroElements();

426 427
    void updateLocalGlobalNumbering();

428 429
    /// Updates the local and global DOF numbering after the mesh has been 
    /// changed.
430
    void updateLocalGlobalNumbering(const FiniteElemSpace *feSpace);
431

432
    /** \brief
433 434 435
     * Creates to all dofs in rank's partition that are on a periodic boundary
     * the mapping from dof index to the other periodic dof indices. This 
     * information is stored in \ref periodicDof.
436
     */
437
    void createPeriodicMap(const FiniteElemSpace *feSpace);
438

439 440 441 442 443 444 445 446
    /** \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.
     */
447 448
    void createMacroElementInfo();

449 450
    void updateMacroElementInfo();

451
    /** \brief
452 453 454 455 456 457
     * 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.
458
     *
459 460
     * \param[in] allBound   Defines a map from rank to interior boundaries 
     *                       which should be checked.
461
     *
462 463 464
     * \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.
465 466
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
467
  
468 469
    /// Sets \ref isRankDof to all matrices and rhs vectors in a given 
    /// stationary problem.
470
    void setRankDofs(ProblemStatSeq *probStat);
471

472 473
    /// Sets \ref isRankDof to all matrices and rhs vectors in all 
    /// stationary problems.
474 475
    void setRankDofs();

476 477 478 479
    /// 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
480
    // Removes all periodic boundaries from a given boundary map.
481
    void removePeriodicBoundaryConditions(BoundaryIndexMap& boundaryMap);
Thomas Witkowski's avatar
Thomas Witkowski committed
482

483
    /// Writes a vector of dof pointers to an output stream.
484
    void serialize(ostream &out, DofContainer &data);
485

486 487 488 489
    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(ostream &out, 
		   map<int, map<const FiniteElemSpace*, DofContainer> > &data);

490
    /// Reads a vector of dof pointers from an input stream.
491 492
    void deserialize(istream &in, DofContainer &data,
		     map<int, const DegreeOfFreedom*> &dofMap);
493 494

    /// Reads a \ref RankToDofContainer from an input stream.
495 496 497
    void deserialize(istream &in, 
		     map<int, map<const FiniteElemSpace*, DofContainer> > &data,
		     map<const FiniteElemSpace*, map<int, const DegreeOfFreedom*> > &dofMap);
498

499
    /// Writes a periodic dof mapping to an output stream.
500
    void serialize(ostream &out, PeriodicDofMap &data);
501

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

504
    /// Reads a periodic dof mapping from an input stream.
505
    void deserialize(istream &in, PeriodicDofMap &data);
506

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

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

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

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

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

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

543 544 545
	data[dofMap[v1]] = v2;
      }
    }
546

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

552 553 554
    /// If true, the mesh distributor is already initialized;
    bool initialized;

555 556 557 558 559 560
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

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

    /// Name of the problem (as used in the init files)
566
    string name;
567

568 569
    /// Finite element spaces of the problem.
    vector<const FiniteElemSpace*> feSpaces;
570

571 572 573
    /// Mesh of the problem.
    Mesh *mesh;

574
    /** \brief
575 576 577
     * 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.
578 579 580
     */    
    RefinementManager *refineManager;

581 582 583
    /// Info level.
    int info;

584 585
    /// Pointer to a mesh partitioner that is used to partition the mesh to 
    /// the ranks.
586
    MeshPartitioner *partitioner;
587

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

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

598
    map<const FiniteElemSpace*, DofData> dofFeData;
599

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

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

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

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

632
    /** \brief
633 634
     * This map contains for each rank the list of DOFs the current rank must 
     * send to exchange solution DOFs at the interior boundaries.
635
     */
636 637
    //    map<FiniteElemSpace, RankToDofContainer> sendDofs;
    map<int, map<const FiniteElemSpace*, DofContainer> > sendDofs;
638 639

    /** \brief
640 641 642
     * 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.
643
     */
644 645
    //    map<FiniteElemSpace, RankToDofContainer> recvDofs;
    map<int, map<const FiniteElemSpace*, DofContainer> > recvDofs;
646

647
    /** \brief
648 649 650 651
     * If periodic boundaries are used, this map stores, for each periodic 
     * boundary type, for all DOFs in rank's partition (that are on periodic 
     * boundaries), the corresponding mapped periodic DOFs. The mapping is 
     * defined by using global DOF indices.
652
     */
653
    PeriodicDofMap periodicDof;
654 655
    
    /** \brief
656 657 658 659 660
     * If periodic boundaries are used, this map stores to each periodic DOF in 
     * rank's partition the set of periodic boundaries the DOF is associated to.
     * In 2D, most DOFs are only on one periodic boundary. Only, e.g., in a box 
     * with all boundaries being periodic, the four corners are associated by 
     * two different boundaries.
661
     */
662
    map<int, std::set<BoundaryType> > periodicDofAssociations;
663

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

677 678 679
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

680 681 682
    /// If true, it is possible to repartition the mesh during computations.
    bool repartitioningAllowed;

683 684
    /// Stores the number of mesh changes that must lie in between to 
    /// repartitionings.
685 686
    int repartitionIthChange;

687 688
    /// Counts the number of mesh changes after the last mesh repartitioning 
    /// was done.
689
    int nMeshChangesAfterLastRepartitioning;
690

691 692 693
    /// Countes the number of mesh repartitions that were done. Till now, this 
    /// variable is used only for debug outputs.
    int repartitioningCounter;
694

695
    /// Directory name where all debug output files should be written to.
696
    string debugOutputDir;
697

698
    /** \brief
699 700
     * Stores the mesh change index. This is used to recognize changes in the
     * mesh structure (e.g. through refinement or coarsening managers).
701 702
     */
    long lastMeshChangeIndex;
703

704 705 706 707
    /// 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.
708
    map<int, vector<int> > macroElementNeighbours;
709

710 711
    /// Store all macro elements of the overall mesh, i.e., before the
    /// mesh is redistributed for the first time.
712
    vector<MacroElement*> allMacroElements;
713

Thomas Witkowski's avatar
Thomas Witkowski committed
714 715
    Flag createBoundaryDofFlag;

716
    map<const FiniteElemSpace*, BoundaryDofInfo> boundaryDofInfo;
717

Thomas Witkowski's avatar
Thomas Witkowski committed
718
  public:
719 720 721
    /// 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
722 723
    static const Flag BOUNDARY_SUBOBJ_SORTED;

724 725 726 727 728 729 730 731 732
    /// 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
733

734 735
    static MeshDistributor *globalMeshDistributor;

736
    friend class ParallelDebug;
737 738 739
  };
}

740
#endif // AMDIS_MESHDISTRIBUTOR_H