ParallelDofMapping.h 15.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ==  http://www.amdis-fem.org                                              ==
// ==                                                                        ==
// ============================================================================
//
// 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.



/** \file FeSpaceMapping.h */

23
#include <vector>
24
#include <map>
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
25
26
#include <set>
#include "parallel/DofComm.h"
27
#include "parallel/MeshLevelData.h"
28
29
#include "parallel/MpiHelper.h"
#include "parallel/ParallelTypes.h"
30
#include "parallel/StdMpi.h"
31

32
33
#include <petscis.h>

34
35
36
37
#ifndef AMDIS_FE_SPACE_MAPPING_H
#define AMDIS_FE_SPACE_MAPPING_H

namespace AMDiS {
Thomas Witkowski's avatar
Thomas Witkowski committed
38

39
40
  using namespace std;

41
  /** \brief
42
43
44
   * Is used to store matrix indices to all DOFs in rank's subdomain. Thus, the
   * class defines a mapping from component number and DOF index to a global
   * matrix index. This class does not calculate the indices by itself!
45
46
47
48
49
50
51
52
53
54
55
56
   */
  class DofToMatIndex
  {
  public:
    DofToMatIndex() {}

    /// Reset the data structure.
    inline void clear()
    {
      data.clear();
    }

57
58
59
60
61
62
63
    /** Add a new mapping for a given DOF.
     * 
     * \param[in]   component       Component number for which the mapping 
     *                              is defined.
     * \param[in]   dof             DOF index
     * \param[in]   globalMatIndex  Global matrix index.
     */
64
65
66
67
68
    inline void add(int component, DegreeOfFreedom dof, int globalMatIndex)
    {
      data[component][dof] = globalMatIndex;
    }

69
    /// Maps a global DOF index to the global matrix index for a specific 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
    /// system component number.
    inline int get(int component, DegreeOfFreedom dof)
    {
      FUNCNAME("DofToMatIndex::get()");

      TEST_EXIT_DBG(data.count(component))
	("No mapping data for component %d available!\n", component);

      TEST_EXIT_DBG(data[component].count(dof))
	("Mapping for DOF %d in component %d does not exists!\n",
	 dof, component);

      return data[component][dof];
    }

85
86
87
88
89
    /// Returns for a given matrix index the component and (local or global) DOF
    /// index. As the data structure is not made for this kind of reverse
    /// search, this is very slow and should be only used for debugging.
    void getReverse(int rowIndex, int &component, int &dofIndex);

90
91
92
93
94
95
96
  private:
    /// The mapping data. For each system component there is a specific map that
    /// maps global DOF indices to global matrix indices.
    map<int, map<DegreeOfFreedom, int> > data;
  };


97
98
99
100
101
102
  /**
   * This class defines the parallel mapping of DOFs for one FE space. It is used
   * by the class \ref ParallelDofMapping to specifiy the mapping for a set of 
   * FE spaces.
   */
  class FeSpaceDofMap
103
104
  {
  public:
105
106
    /// This constructor exists only to create std::map of this class and make
    /// use of the operator [] for read access. Should never be called.
107
    FeSpaceDofMap() 
108
109
110
    {
      ERROR_EXIT("Should not be called!\n");
    }
111
112
     
    /// This is the only valid constructur to be used. 
113
114
    FeSpaceDofMap(MeshLevelData* ld)
      : levelData(ld),
115
	dofComm(NULL),
116
	feSpace(NULL),
Thomas Witkowski's avatar
Thomas Witkowski committed
117
	needGlobalMapping(false),
118
	hasNonLocalDofs(false)
119
120
121
    {
      clear();
    }
122
123

    /// Clears all data of the mapping.
124
    void clear();
125

126
127
    /// Maps a DOF index to both, the local and global index of the mapping. The
    /// global index must not be set.
Thomas Witkowski's avatar
Thomas Witkowski committed
128
    MultiIndex& operator[](DegreeOfFreedom d)
129
    {
130
      TEST_EXIT_DBG(dofMap.count(d))("DOF %d is not in map!\n", d);
131

132
      return dofMap[d];
133
    }
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

    /** \brief
     * Searchs the map for a given DOF. It does not fail, if the DOF is not 
     * mapped by this mapping. In this case, it returns false. If the DOF is 
     * mapped, the result is stored and the function returns true.
     *
     * \param[in]    dof     DOF index for which a mapping is searched.
     * \param[out]   index   In the case that the DOF is mapped, the result
     *                       is stored here.
     */
    inline bool find(DegreeOfFreedom dof, MultiIndex& index)
    {
      DofMap::iterator it = dofMap.find(dof);
      if (it == dofMap.end())
	return false;

      index = it->second;
      return true;
    }
153
    
154
155
    /// Inserts a new DOF to rank's mapping. The DOF is assumed to be owend by
    /// the rank.
156
    void insertRankDof(DegreeOfFreedom dof0, DegreeOfFreedom dof1 = -1)
157
    {
158
      FUNCNAME("FeSpaceDofMap::insertRankDof()");
159
      
160
      TEST_EXIT_DBG(dofMap.count(dof0) == 0)("Should not happen!\n");
161
      
162
163
      dofMap[dof0].local = dof1;
      nLocalDofs++;
Thomas Witkowski's avatar
Thomas Witkowski committed
164
      if (dof1 != -1)
165
	nRankDofs++;
166
167
    }
    
168
169
    /// Inserts a new DOF to rank's mapping. The DOF exists in rank's subdomain
    /// but is owned by a different rank, thus it is part of an interior boundary.
170
    void insertNonRankDof(DegreeOfFreedom dof0, DegreeOfFreedom dof1 = -1)
171
    {
172
      FUNCNAME("FeSpaceDofMap::insertNonRankDof()");
173
      
174
      TEST_EXIT_DBG(dofMap.count(dof0) == 0)("Should not happen!\n");
175
      
176
177
178
      dofMap[dof0].local = dof1;
      nLocalDofs++;
      nonRankDofs.insert(dof0);
179
180
    }
    
181
    /// Checks if a given DOF is in the DOF mapping.
182
    bool isSet(DegreeOfFreedom dof)
183
    {
184
      return static_cast<bool>(dofMap.count(dof));
185
    }
186

187
188
189
    /// Checks if a given DOF is a rank owned DOF of the DOF mapping. The DOF must
    /// a DOF of the mapping (this is not checked here), otherwise the result is
    /// meaningsless.
190
    bool isRankDof(DegreeOfFreedom dof)
191
    {
192
      return !(static_cast<bool>(nonRankDofs.count(dof)));
193
    }
194
    
195
    /// Returns number of DOFs in the mapping.
196
    unsigned int size()
197
    {
198
      return dofMap.size();
199
200
    }
    
201
    /// Returns the raw data of the mapping.
202
    DofMap& getMap()
203
    {
204
      return dofMap;
205
    }
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
206

207
208
209
210
211
212
213
214
215
216
    DofMap::iterator begin()
    {
      return dofMap.begin();
    }

    DofMap::iterator end()
    {
      return dofMap.end();
    }

217
218
    /// Recomputes the mapping.
    void update();
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
219

220
    /// Sets the FE space this mapping corresponds to.
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
221
222
223
224
225
    void setFeSpace(const FiniteElemSpace *fe)
    {
      feSpace = fe;
    }

226
227
    /// Informs the mapping whether the mapping will include DOFs that are not
    /// owned by the rank.
228
    void setNonLocalDofs(bool b)
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
229
    {
230
      hasNonLocalDofs = b;
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
231
232
    }

233
    /// Informs the mapping whether a global index must be computed.
234
    void setNeedGlobalMapping(bool b)
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
235
    {
236
      needGlobalMapping = b;
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
237
238
    }

239
    /// Sets the DOF communicator.
240
    void setDofComm(DofComm &dc)
Thomas Witkowski's avatar
Thomas Witkowski committed
241
    {
242
      dofComm = &dc;
Thomas Witkowski's avatar
Thomas Witkowski committed
243
244
    }

245
246
247
248
249
250
    void setMpiComm(MPI::Intracomm &m, int l)
    {
      mpiComm = m;
      meshLevel = l;
    }

251
  private:
252
    /// Computes a global mapping from the local one.
253
    void computeGlobalMapping();
254
255
256

    /// Computes the global indices of all DOFs in the mapping that are not owned
    /// by the rank.
257
    void computeNonLocalIndices();
258
259

  private:
260
    MeshLevelData *levelData;
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
261

262
263
    /// DOF communicator for all DOFs on interior boundaries.
    DofComm *dofComm;
264

265
266
267
268
    MPI::Intracomm mpiComm;

    int meshLevel;

269
    /// The FE space this mapping belongs to. This is used only the get the
270
    /// correct DOF communicator in \ref dofComm.
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
271
272
    const FiniteElemSpace *feSpace;

273
    /// Mapping data from DOF indices to local and global indices.
274
    DofMap dofMap;
275

276
    /// Set of all DOFs that are in mapping but are not owned by the rank.
277
    std::set<DegreeOfFreedom> nonRankDofs;
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
278

279
    /// If true, a global index mapping will be computed for all DOFs.
Thomas Witkowski's avatar
Thomas Witkowski committed
280
    bool needGlobalMapping;
Thomas Witkowski's avatar
FETI-DP  
Thomas Witkowski committed
281

282
283
284
285
    /// Is true if there are DOFs in at least one subdomain that are not owned
    /// by the rank. If the value is false, each rank contains only DOFs that
    /// are also owned by this rank.
    bool hasNonLocalDofs;
286

287
288
  public:
    /// 
289
    int nRankDofs, nLocalDofs, nOverallDofs, rStartDofs;
290
291
  };
  
292
293
294
295
296
297
  
  /**
   * Implements the mapping from sets of distributed DOF indices to local and
   * global indices. The mapping works for a given set of FE spaces. Furthermore,
   * this class may compute the matrix indices of the set of DOF indices.
   */
Thomas Witkowski's avatar
Thomas Witkowski committed
298
  class ParallelDofMapping
299
300
  {
  public:
Thomas Witkowski's avatar
Thomas Witkowski committed
301
    ParallelDofMapping() 
302
      : levelData(NULL),
303
	dofComm(NULL),
304
	hasNonLocalDofs(false),
305
306
	needMatIndex(false),
	needMatIndexFromGlobal(false),
307
	feSpaces(0),
308
309
310
311
312
	nRankDofs(1),
	nLocalDofs(1),
	nOverallDofs(1),
	rStartDofs(1)
    {
313
314
315
316
      nRankDofs = -1;
      nLocalDofs = -1;
      nOverallDofs = -1;
      rStartDofs = -1;
317
    } 
318

319
320
321
322
    /** \brief Initialize the parallel DOF mapping.
     *
     * \param[in]  m                  MPI communicator.
     * \param[in]  fe                 The FE spaces of all components of the 
323
324
325
326
     *                                PDE to be solved.
     * \param[in]  uniqueFe           Unique list of FE spaces. Thus, two
     *                                arbitrary elements of this list are always
     *                                different.
327
328
329
330
331
     * \param[in]  needGlobalMapping  If true, the mapping computes also a global
     *                                index for the DOFs.
     * \param[in]  bNonLocalDofs      If true, at least one rank's mapping con-
     *                                taines DOFs that are not owend by the rank.
     */
332
    void init(MeshLevelData& mld,
333
	      vector<const FiniteElemSpace*> &fe,
334
	      vector<const FiniteElemSpace*> &uniqueFe,
335
336
	      bool needGlobalMapping,
	      bool bNonLocalDofs);
337
338

    void setMpiComm(MPI::Intracomm &m, int l);
339
340
341
    
    /// Clear all data.
    void clear();
342
343
344

    /// Set the DOF communicator objects that are required to exchange information
    /// about DOFs that are on interior boundaries.
345
    void setDofComm(DofComm &dofComm);
346

347
348
349
    /// Returns the DOF communicator.
    DofComm& getDofComm()
    {
350
351
352
      FUNCNAME("ParallelDofMapping::getDofComm()");

      TEST_EXIT_DBG(dofComm)("No DOF communicator object defined!\n");
353
354
355
356

      return *dofComm;
    }

357
358
359
360
361
362
    void setComputeMatIndex(bool b, bool global = false)
    {
      needMatIndex = b;
      needMatIndexFromGlobal = global;
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
363
364
365
366
367
    inline bool isMatIndexFromGlobal()
    {
      return needMatIndexFromGlobal;
    }

368
369
    /// Access the DOF mapping for a given FE space.
    inline FeSpaceDofMap& operator[](const FiniteElemSpace* feSpace)
370
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
371
      FUNCNAME("ParallelDofMapping::operator[]()");
372

373
374
      TEST_EXIT_DBG(data.count(feSpace))
	("No data for FE space at address %p!\n", feSpace);
375
376
377
378

      return data.find(feSpace)->second;
    }

379
    /// Returns \ref nRankDofs, thus the number of DOFs owned by the rank.
380
    inline int getRankDofs()
381
    {
382
      TEST_EXIT_DBG(nRankDofs >= 0)("Should not happen!\n");
383

384
      return nRankDofs;
385
386
    }

387
    /// Returns \ref nLocalDofs, thus the number of DOFs in ranks subdomain.
388
    inline int getLocalDofs()
Thomas Witkowski's avatar
Thomas Witkowski committed
389
    {
390
      TEST_EXIT_DBG(nLocalDofs >= 0)("Should not happen!\n");
Thomas Witkowski's avatar
Thomas Witkowski committed
391

392
      return nLocalDofs;
Thomas Witkowski's avatar
Thomas Witkowski committed
393
394
    }

395
    /// Returns \ref nOverallDofs, thus the number of all DOFs in this mapping.
396
    inline int getOverallDofs()
397
    {
398
      TEST_EXIT_DBG(nOverallDofs >= 0)("Should not happen!\n");
399

400
      return nOverallDofs;
401
402
    }

403
404
    /// Returns \ref rStartDofs, thus the smallest global index of a DOF that is
    /// owned by the rank.
405
    inline int getStartDofs()
406
    {
407
      TEST_EXIT_DBG(rStartDofs >= 0)("Should not happen!\n");
408

409
      return rStartDofs;
410
411
    }

412
    /// Update the mapping.
Thomas Witkowski's avatar
Thomas Witkowski committed
413
    void update();
414

415
416
417
    /// Update the mapping.
    void update(vector<const FiniteElemSpace*>& feSpaces);

418
419
    /// Returns the global matrix index of a given DOF for a given 
    /// component number.
420
    inline int getMatIndex(int ithComponent, DegreeOfFreedom d)
Thomas Witkowski's avatar
Thomas Witkowski committed
421
    {
422
      return dofToMatIndex.get(ithComponent, d);
Thomas Witkowski's avatar
Thomas Witkowski committed
423
424
    }

425
426
427
428
429
430
431
    /// Returns the component number and local/global DOF index for a given
    /// matrix row index. Should be used for debugging only!
    inline void getReverseMatIndex(int index, int &component, int &dofIndex)
    {
      dofToMatIndex.getReverse(index, component, dofIndex);
    }

432
433
    /// Returns the local matrix index of a given DOF for a given 
    /// component number.
434
    inline int getLocalMatIndex(int ithComponent, DegreeOfFreedom d)
435
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
436
      FUNCNAME("ParallelDofMapping::getLocalMatIndex()");
437

438
      TEST_EXIT_DBG(data[feSpaces[ithComponent]].isRankDof(d))
439
440
	("Should not happen!\n");

441
      return dofToMatIndex.get(ithComponent, d) - rStartDofs;
442
443
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
444
445
446
447
448
449
450
451
452
453
454
455
    // Writes all data of this object to an output stream.
    void serialize(ostream &out)
    {
      ERROR_EXIT("MUST BE IMPLEMENTED!\n");
    }

    // Reads the object data from an input stream.
    void deserialize(istream &in)
    {
      ERROR_EXIT("MUST BE IMPLEMENTED!\n");
    }

456
    /// Compute local and global matrix indices.
457
    void computeMatIndex(bool globalIndex);
458

459
460
461
462
    void createIndexSet(IS &is, 
			int firstComponent, 
			int nComponents);

463
464
465
466
467
  protected:
    /// Insert a new FE space DOF mapping for a given FE space.
    void addFeSpace(const FiniteElemSpace* feSpace);

    /// Compute \ref nRankDofs.
468
    int computeRankDofs();
469
470

    /// Compute \ref nLocalDofs.
471
    int computeLocalDofs();
472
473

    /// Compute \ref nOverallDofs.
474
    int computeOverallDofs();
475
476

    /// Compute \ref rStartDofs.
477
    int computeStartDofs();
478

479
  private:
480
481
482
483
    MPI::Intracomm mpiComm;

    int meshLevel;

484
    MeshLevelData *levelData;
485

486
487
    /// DOF communicator for all DOFs on interior boundaries.
    DofComm *dofComm;
488

489
490
491
492
    /// Is true if there are DOFs in at least one subdomain that are not owned
    /// by the rank. If the value is false, each rank contains only DOFs that
    /// are also owned by this rank.
    bool hasNonLocalDofs;
493

494
495
496
497
498
499
500
501
    /// If true, matrix indeces for the stored DOFs are computed, see
    /// \ref computeMatIndex.
    bool needMatIndex;

    /// If matrix indices should be computed, this variable defines if the
    /// mapping from DOF indices to matrix row indices is defined on local
    /// or global DOF indices. If true, the mapping is to specify and to use
    /// on global ones, otherwise on local DOF indices.
Thomas Witkowski's avatar
Thomas Witkowski committed
502
503
504
505
506
    /// In most scenarios the mapping stored on local DOF indices is what we
    /// want to have. Only when periodic boundary conditions are used together
    /// with some global matrix approache, the matrix indices must be stored
    /// also for DOFs that are not part of the local subdomain. Thus, the
    /// mapping will be stored on global DOF indices.
507
508
    bool needMatIndexFromGlobal;

509
510
511
512
    /// Maps from FE space pointers to DOF mappings.
    map<const FiniteElemSpace*, FeSpaceDofMap> data;

    /// The FE spaces for all components.
513
514
    vector<const FiniteElemSpace*> feSpaces;

515
516
    /// The set of all FE spaces. It uniquly contains all different FE spaces
    /// from \ref feSpaces.
517
    vector<const FiniteElemSpace*> feSpacesUnique;
Thomas Witkowski's avatar
Thomas Witkowski committed
518

519
    /// Number of DOFs owned by rank.
520
    int nRankDofs;
521
522

    /// Number of DOFs in rank's subdomain.
523
    int nLocalDofs;
524
525

    /// Number of global DOFs (this value is thus the same on all ranks).
526
    int nOverallDofs;
527
528

    /// Smallest global index of a DOF owned by the rank.
529
    int rStartDofs;
530
531
532

    /// Mapping from global DOF indices to global matrix indices under 
    /// consideration of possibly multiple components.
533
    DofToMatIndex dofToMatIndex;
534
535
536
537
538
  };

}

#endif