ParallelDomainBase.h 18.2 KB
Newer Older
1 2 3 4 5 6
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
7
// ==  TU Dresden                                                            ==
8
// ==                                                                        ==
9 10 11
// ==  Institut für Wissenschaftliches Rechnen                               ==
// ==  Zellescher Weg 12-14                                                  ==
// ==  01069 Dresden                                                         ==
12 13 14 15
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
16
// ==  https://gforge.zih.tu-dresden.de/projects/amdis/                      ==
17 18 19
// ==                                                                        ==
// ============================================================================

20 21 22 23
/** \file ParallelDomainBase.h */

#ifndef AMDIS_PARALLELDOMAINBASE_H
#define AMDIS_PARALLELDOMAINBASE_H
24 25 26


#include <map>
27
#include <set>
28
#include <vector>
Thomas Witkowski's avatar
Thomas Witkowski committed
29
#include <mpi.h>
30

Thomas Witkowski's avatar
Thomas Witkowski committed
31
#include "Global.h"
32 33
#include "ProblemTimeInterface.h"
#include "ProblemIterationInterface.h"
34
#include "FiniteElemSpace.h"
35
#include "AdaptInfo.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
36
#include "parallel/InteriorBoundary.h"
37
#include "Serializer.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
38
#include "BoundaryManager.h"
39 40
#include "AMDiS_fwd.h"

41
namespace AMDiS {
42
  
43 44
  class ParMetisPartitioner;

45
  class MeshDistributor
46
  {
47
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
48 49 50 51 52 53 54 55 56 57 58 59
    /// Defines a mapping type from DOFs to rank numbers.
    typedef std::map<const DegreeOfFreedom*, int> DofToRank;

    /// Defines a mapping type from DOFs to a set of rank numbers.
    typedef std::map<const DegreeOfFreedom*, std::set<int> > DofToPartitions;

    /// Defines a mapping type from rank numbers to sets of DOFs.
    typedef std::map<int, DofContainer> RankToDofContainer;

    /// Defines a mapping type from DOF indices to DOF indices.
    typedef std::map<DegreeOfFreedom, DegreeOfFreedom> DofMapping;

60 61 62
    /// Defines a mapping type from DOFs to boolean values.
    typedef std::map<const DegreeOfFreedom*, bool> DofToBool;

Thomas Witkowski's avatar
Thomas Witkowski committed
63
    /// Defines a mapping type from DOF indices to boolean values.
64
    typedef std::map<DegreeOfFreedom, bool> DofIndexToBool;
Thomas Witkowski's avatar
Thomas Witkowski committed
65

Thomas Witkowski's avatar
Thomas Witkowski committed
66 67 68
    /// Forward type (it maps rank numbers to the interior boundary objects).
    typedef InteriorBoundary::RankToBoundMap RankToBoundMap;

Thomas Witkowski's avatar
Thomas Witkowski committed
69 70
    typedef std::map<const DegreeOfFreedom*, DegreeOfFreedom> DofIndexMap;

71
    typedef std::map<DegreeOfFreedom, std::set<DegreeOfFreedom> > PeriodicDofMap;
72 73
    
    typedef std::vector<MeshStructure> MeshCodeVec;
74

75
  public:
76 77 78
    MeshDistributor(std::string str);
		          
    virtual ~MeshDistributor() {}
79

80
    void initParallelization(AdaptInfo *adaptInfo);
81

82 83 84
    void exitParallelization(AdaptInfo *adaptInfo);

    void addProblemStat(ProblemVec *probVec);
85

86 87 88 89 90 91 92 93 94
    /** \brief
     * 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.
     */
    void checkMeshChange();

95
    void updateDofAdmins();    
96

97 98 99 100 101 102 103
    /** \brief
     * 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.
     */
    void testForMacroMesh();
104 105 106 107 108 109

    /// Set for each element on the partitioning level the number of leaf elements.
    double setElemWeights(AdaptInfo *adaptInfo);

    void partitionMesh(AdaptInfo *adaptInfo);

110 111 112 113 114 115 116
    inline virtual std::string getName() 
    { 
      return name; 
    }
    
    /// Returns \ref nRankDOFs, the number of DOFs in the rank mesh.
    inline int getNumberRankDofs() 
117
    {
118
      return nRankDofs;
119
    }
120

121
    inline int getNumberOverallDofs()
122
    {
123
      return nOverallDofs;
124
    }
125

126
    inline DegreeOfFreedom mapLocalToGlobal(DegreeOfFreedom dof)
127
    {
128
      return mapLocalGlobalDofs[dof];
129
    }
130

131 132 133 134 135
    inline DegreeOfFreedom mapLocalToDofIndex(DegreeOfFreedom dof)
    {
      return mapLocalDofIndex[dof];
    }

136
    inline std::set<DegreeOfFreedom>& getPeriodicDof(DegreeOfFreedom dof)
137
    {
138
      return periodicDof[dof];
139
    }
140

141
    inline PeriodicDofMap& getPeriodicDofMap()
142
    {
143
      return periodicDof;
144 145
    }

146 147 148 149
    inline bool getIsRankDof(DegreeOfFreedom dof)
    {
      return isRankDof[dof];
    }
150

151
    inline long getLastMeshChangeIndex()
152
    {
153
      return lastMeshChangeIndex;
154
    }
155

156 157 158 159
    inline int getRstart()
    {
      return rstart;
    }
160

161
    inline int getMpiRank()
162
    {
163
      return mpiRank;
164
    }
165

166 167 168
    inline MPI::Intracomm& getMpiComm()
    {
      return mpiComm;
169 170
    }

171
    inline RankToDofContainer& getSendDofs()
172
    {
173
      return sendDofs;
174 175
    }

176
    inline RankToDofContainer& getRecvDofs()
177
    {
178
      return recvDofs;
179
    }
180

181
    // Writes all data of this object to an output stream.
182
    void serialize(std::ostream &out);
183

184
    // Reads the object data from an input stream.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    void deserialize(std::istream &in);

    /** \brief
     * 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.
     *
     * 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.
     */    
    void synchVector(DOFVector<double> &vec);

    /** \brief
     * 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.
     */
    void synchVector(SystemVector &vec);

206
  protected:
207
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
208
     * Determines the interior boundaries, i.e. boundaries between ranks, and stores
209 210
     * all information about them in \ref interiorBoundary.
     */
211
    void createInteriorBoundaryInfo();
212

Thomas Witkowski's avatar
Thomas Witkowski committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
    /** \brief
     * Deterimes the interior boundaries between ranks, that are based on the 
     * neighbourhood information of the macro elements. That means that in 2d the
     * function search for all edge based interior boundaries and in 3d for all face
     * based interior boundaries. This function cannot find boundaries of substructure
     * elements, i.e. vertex boundaries in 2d and vertex and edge boundaries in 3d.
     */
    void createMacroElementInteriorBoundaryInfo();

    /** \brief
     * Determines all interior boundaries between rank that consist of element's
     * substructures. In 2d these may be only vertices. In 3d there may be also
     * interior boundaries consisting of either a whole edge or of a single vertex.
     */
    void createSubstructureInteriorBoundaryInfo();

229 230 231
    /// Removes all macro elements from the mesh that are not part of ranks partition.
    void removeMacroElements();

232 233
    /// Creates from a macro mesh a correct local and global DOF index numbering.
    void createLocalGlobalNumbering();
234

235 236
    /// Updates the local and global DOF numbering after the mesh has been changed.
    void updateLocalGlobalNumbering();
237

238 239 240 241 242
    /** \brief
     * 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.
     */
243 244
    void createPeriodicMap();

245 246
    /** \brief
     * This function create new mappings from local to global indices, 
247
     * \ref mapLocalGlobalDofs, and from local to dof indices, \ref mapLocalDofIndex.
248 249 250 251 252 253 254 255 256 257 258 259 260 261
     * Furthermore, using the first argument the dof indices in ranks partition are
     * changed.
     * 
     * \param[in] rankDofsNewLocalIndex       Map from dof pointers of all dofs in rank
     *                                        to new dof indices.
     * \param[in] rankOwnedDofsNewLocalIndex  Map from dof pointers of dofs owned by
     *                                        the rank to the new local index.
     * \param[in] rankDofsNewGlobalIndex      Map from dof pointers of all dofs in rank
     *                                        to the new global index.
     */
    void createLocalMappings(DofIndexMap &rankDofsNewLocalIndex,
			     DofIndexMap &rankOwnedDofsNewLocalIndex,
			     DofIndexMap &rankDofsNewGlobalIndex);

262 263
    /** \brief
     * This function traverses the whole mesh, i.e. before it is really partitioned,
Thomas Witkowski's avatar
Thomas Witkowski committed
264 265 266
     * and collects information about which DOF corresponds to which rank. Can only
     * be used, if \ref partitionVec is set correctly. This is only the case, when
     * the macro mesh is partitioned.
267
     *
268 269 270 271 272
     * \param[out] partitionDOFs   Stores to each DOF pointer the set of ranks the DOF
     *                             is part of.
     * \param[out] rankDOFs        Stores all rank DOFs.
     * \param[out] boundaryDOFs    Stores all DOFs in ranks partition that are on an 
     *                             interior boundary but correspond to another rank.
273
     */
274
    void createDofMemberInfo(DofToPartitions& partitionDofs,
Thomas Witkowski's avatar
n  
Thomas Witkowski committed
275 276
			     DofContainer& rankOwnedDofs,
			     DofContainer& rankAllDofs,
277
			     DofToRank& boundaryDofs,
278
			     DofToBool& isVertexDof);
Thomas Witkowski's avatar
Thomas Witkowski committed
279

280 281 282 283 284 285 286 287 288 289 290 291 292
    /** \brief
     * 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.
     * 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.
     *
     * \param[in] allBound   Defines a map from rank to interior boundaries which 
     *                       should be checked.
     */
    bool checkAndAdaptBoundary(RankToBoundMap &allBound);
Thomas Witkowski's avatar
Thomas Witkowski committed
293
    
294 295 296 297 298 299 300
    /** \brief
     * This functions create a Paraview file with the macro mesh where the elements
     * are colored by the partition they are part of. This function can be used for
     * debugging.
     */
    void writePartitioningMesh(std::string filename);

Thomas Witkowski's avatar
Thomas Witkowski committed
301 302 303
    // Removes all periodic boundaries from a given boundary map.
    void removeBoundaryCondition(BoundaryIndexMap& boundaryMap);

304 305
    bool fitElementToMeshCode(MeshStructure &code, 
			      Element *el, 
306 307
			      GeoIndex subObj,
			      int ithObj, 
308 309
			      int elType,
			      bool reverseMode);
310 311
    
    bool fitElementToMeshCode2(MeshStructure &code, 
312
			       TraverseStack &stack,
313 314
			       GeoIndex subObj,
			       int ithObj, 
315 316
			       int elType,
			       bool reverseMode);
317

318 319 320 321 322 323 324 325 326 327 328 329 330
    /// Writes a vector of dof pointers to an output stream.
    void serialize(std::ostream &out, DofContainer &data);

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

    /// Writes a \ref RankToDofContainer to an output stream.
    void serialize(std::ostream &out, RankToDofContainer &data);

    /// Reads a \ref RankToDofContainer from an input stream.
    void deserialize(std::istream &in, RankToDofContainer &data,
		     std::map<int, const DegreeOfFreedom*> &dofMap);
331

332 333 334 335 336 337
    /// Writes a periodic dof mapping to an output stream.
    void serialize(std::ostream &out, PeriodicDofMap &data);

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

338 339 340 341 342
    /// Writes a mapping from dof pointers to some values to an output stream.
    template<typename T>
    void serialize(std::ostream &out, std::map<const DegreeOfFreedom*, T> &data)
    {
      int mapSize = data.size();
343
      SerUtil::serialize(out, mapSize);
344 345 346 347
      for (typename std::map<const DegreeOfFreedom*, T>::iterator it = data.begin();
	   it != data.end(); ++it) {
	int v1 = (*(it->first));
	T v2 = it->second;
348 349
	SerUtil::serialize(out, v1);
	SerUtil::serialize(out, v2);
350 351 352 353 354 355 356 357
      }
    }

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

360
      int mapSize = 0;
361
      SerUtil::deserialize(in, mapSize);
362 363 364
      for (int i = 0; i < mapSize; i++) {
	int v1 = 0;
	T v2;
365 366
	SerUtil::deserialize(in, v1);
	SerUtil::deserialize(in, v2);
367 368 369

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

370 371 372 373
	data[dofMap[v1]] = v2;
      }
    }
		        
374
  protected:
Thomas Witkowski's avatar
Thomas Witkowski committed
375
    ///
376
    std::vector<ProblemVec*> probStat;
Thomas Witkowski's avatar
Thomas Witkowski committed
377

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
    /// The rank of the current process.
    int mpiRank;

    /// Overall number of processes.
    int mpiSize;

    /** \brief
     * MPI communicator collected all processes, which should
     * be used for calculation. The Debug procces is not included
     * in this communicator.
     */
    MPI::Intracomm mpiComm;

    /// Name of the problem (as used in the init files)
    std::string name;

394 395 396
    /// Finite element space of the problem.
    FiniteElemSpace *feSpace;

397 398 399
    /// Mesh of the problem.
    Mesh *mesh;

400 401 402 403 404 405 406
    /** \brief
     * 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.
     */    
    RefinementManager *refineManager;

407 408 409
    /// Info level.
    int info;

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    /// Pointer to the paritioner which is used to devide a mesh into partitions.
    ParMetisPartitioner *partitioner;

    /// Weights for the elements, i.e., the number of leaf elements within this element.
    std::map<int, double> elemWeights;

    /// Is true, if the mesh was not partitioned before, otherwise it's false.
    bool initialPartitionMesh;

    /** \brief
     * Stores to every coarse element index the number of the partition it 
     * corresponds to.
     */
    std::map<int, int> partitionVec;

    /** \brief
     * Stores an old partitioning of elements. To every element index the number
     * of the parition it corresponds to is stored.
     */
    std::map<int, int> oldPartitionVec;    
430
   
431
    /// Number of DOFs in the rank mesh.
432
    int nRankDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
433

434 435 436
    ///
    int nOverallDofs;

Thomas Witkowski's avatar
Thomas Witkowski committed
437
    /** \brief 
Thomas Witkowski's avatar
Thomas Witkowski committed
438 439 440 441 442 443 444 445 446 447 448 449
     * 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.
     */
    InteriorBoundary myIntBoundary;
    
    /** \brief
     * 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
450
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
451
    InteriorBoundary otherIntBoundary;
Thomas Witkowski's avatar
Thomas Witkowski committed
452

453 454 455 456 457
    /** \brief
     *
     */
    InteriorBoundary periodicBoundary;

458 459 460 461
    /** \brief
     * This map contains for each rank the list of dofs the current rank must send
     * to exchange solution dofs at the interior boundaries.
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
462
    RankToDofContainer sendDofs;
463 464

    /** \brief
465 466 467
     * This map contains for 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.
468
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
469
    RankToDofContainer recvDofs;
470 471

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

Thomas Witkowski's avatar
Thomas Witkowski committed
474
    /// Maps local dof indices to real dof indices.
475
    DofMapping mapLocalDofIndex;  
476 477 478 479 480 481

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

484 485
    /** \brief
     * Maps every dof pointer in ranks macro mesh to a boolean variable indicating 
486
     * whether this dof is a vertex dof (true) or not (false).
487
     */
488
    DofToBool vertexDof;
Thomas Witkowski's avatar
n  
Thomas Witkowski committed
489

490 491 492 493 494
    /** \brief
     * If periodic boundaries are used, this map stores to each dof in rank's 
     * partition, that is on periodic boundaries, the corresponding periodic dofs.
     * The mapping is defined by using global dof indices.
     */
495 496
    PeriodicDofMap periodicDof;

497
    /// Is the index of the first row of the linear system, which is owned by the rank.
Thomas Witkowski's avatar
n  
Thomas Witkowski committed
498
    int rstart;
499

500 501 502 503 504 505 506
    /** \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
     * initialization function, if the problem definition has already been read from
     * a serialization file.
     */
    bool deserialized;
507

508 509 510
    /// Denotes whether there exists a filewriter for this object.
    bool writeSerializationFile;

511 512 513 514 515
    /** \brief
     * Stores the mesh change index. This is used to recognize changes in the mesh 
     * structure (e.g. through refinement or coarsening managers).
     */
    long lastMeshChangeIndex;
516

517 518 519 520 521
    /// This variable is true, if the macro elements are consistent with all other
    /// data structures. Within the initialization and during mesh redistribution this
    /// may not be the case.
    bool macroElementStructureConsisten;

522
    friend class ParallelDomainDbg;
523 524 525
  };
}

526
#endif // AMDIS_PARALLELDOMAINBASE_H