ElementObjectDatabase.h 19.1 KB
Newer Older
Thomas Witkowski's avatar
Thomas Witkowski committed
1
2
3
4
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
5
// ==  http://www.amdis-fem.org                                              ==
Thomas Witkowski's avatar
Thomas Witkowski committed
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.


Thomas Witkowski's avatar
Thomas Witkowski committed
20

21
/** \file ElementObjectDatabase.h */
Thomas Witkowski's avatar
Thomas Witkowski committed
22

23
24
#ifndef AMDIS_ELEMENT_OBJECT_DATABASE_H
#define AMDIS_ELEMENT_OBJECT_DATABASE_H
Thomas Witkowski's avatar
Thomas Witkowski committed
25
26
27
28
29

#include <map>
#include <vector>
#include <boost/tuple/tuple.hpp>
#include <boost/tuple/tuple_comparison.hpp>
30
#include <boost/container/flat_map.hpp>
Thomas Witkowski's avatar
Thomas Witkowski committed
31

32
#include "AMDiS_fwd.h"
33
#include "Containers.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
34
35
#include "Global.h"
#include "Boundary.h"
36
#include "Serializer.h"
37
#include "FiniteElemSpace.h"
Thomas Witkowski's avatar
Thomas Witkowski committed
38
39
40

namespace AMDiS {

41
42
  using namespace std;

43
44
  using boost::container::flat_map;

45
  /// Just to templatize the typedef.
46
  template<typename T>
47
  struct PerBoundMap {
48
49
50
51
    typedef map<pair<T, T>, BoundaryType> type;
    typedef typename type::iterator iterator;
  };

52

53
54
#pragma pack(push)
#pragma pack(1)
55
  /// Defines one element object. This may be either a vertex, edge or face.
Thomas Witkowski's avatar
Thomas Witkowski committed
56
  struct ElementObjectData {
57
    ElementObjectData(int a = -1, int b = 0)
Thomas Witkowski's avatar
Thomas Witkowski committed
58
      : elIndex(a),
59
	ithObject(b)
Thomas Witkowski's avatar
Thomas Witkowski committed
60
    {}
61
62

    /// Index of the element this object is part of.
Thomas Witkowski's avatar
Thomas Witkowski committed
63
64
    int elIndex;
    
65
    /// Index of the object within the element.
66
    char ithObject;
Thomas Witkowski's avatar
Thomas Witkowski committed
67

68
    /// Write this element object to disk.
69
    void serialize(ostream &out) const
70
71
72
73
74
    {
      SerUtil::serialize(out, elIndex);
      SerUtil::serialize(out, ithObject);
    }

75
    /// Read this element object from disk.
76
    void deserialize(istream &in)
77
78
79
80
81
    {
      SerUtil::deserialize(in, elIndex);
      SerUtil::deserialize(in, ithObject);
    }

82
    /// Compare this element object with another one.
83
84
    bool operator==(ElementObjectData& cmp) const
    {
85
      return (elIndex == cmp.elIndex && ithObject == cmp.ithObject);
86
87
    }

88
    /// Define a strict order on element objects.
89
90
    bool operator<(const ElementObjectData& rhs) const
    {
91
92
      return (elIndex < rhs.elIndex || 
	      (elIndex == rhs.elIndex && ithObject < rhs.ithObject));
93
    }
Thomas Witkowski's avatar
Thomas Witkowski committed
94
  };
95
#pragma pack(pop)
Thomas Witkowski's avatar
Thomas Witkowski committed
96
97


98
99
  /** \brief
   * This class is a database of element objects. An element object is either a
100
101
102
103
104
105
106
   * vertex, edge or the face of a specific element. This database is used to
   * store all objects of all elements of a mesh. The information is stored in a
   * way that makes it possible to identify all elements, which have a given
   * vertex, edge or face in common. If is is known which element is owned by 
   * which rank in parallel computations, it is thus possible to get all interior
   * boundaries on object level. This is required, because two elements may share
   * a common vertex without beging neighbours in the definition of AMDiS.
107
   */
108
  class ElementObjectDatabase {
Thomas Witkowski's avatar
Thomas Witkowski committed
109
  public:
110
    ElementObjectDatabase()
111
112
      : feSpace(NULL),
	mesh(NULL),
113
114
	iterGeoPos(CENTER),
	macroElementRankMap(NULL),
115
116
	levelData(NULL)
    {}
Thomas Witkowski's avatar
Thomas Witkowski committed
117

118
    void setFeSpace(const FiniteElemSpace *fe)
Thomas Witkowski's avatar
Thomas Witkowski committed
119
    {
120
121
122
123
124
125
126
      feSpace = fe;
      mesh = feSpace->getMesh();
    }
  
    Mesh* getMesh()
    {
      return mesh;
127
128
    }

129
130
131
132
133
134
    /*
     * \param[in]  macroElementRankMap   Maps to each macro element of the mesh
     *                                   the rank that owns this macro element.
     */
    void create(map<int, int>& macroElementRankMap,
		MeshLevelData& levelData);
135

136
    void createMacroElementInfo(vector<MacroElement*> &mel);
137

138
139
140
    /// Create for a filled object database the membership information for all
    /// element objects. An object is owned by a rank, if the rank has the
    /// heighest rank number of all ranks where the object is part of.
141
    void updateRankData();
142

Thomas Witkowski's avatar
bla    
Thomas Witkowski committed
143
144
145
    /// All data from the database is dropped. 
    void clear();

146
    /** \brief
147
148
149
     * Iterates over all elements for one geometrical index, i.e., over all
     * vertices, edges or faces in the mesh. The function returns true, if the
     * result is valid. Otherwise the iterator is at the end position.
150
     *
151
152
     * \param[in]  pos   Must be either VERTEX, EDGE or FACE and defines the
     *                   elements that should be traversed.
153
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
154
155
    bool iterate(GeoIndex pos)
    {
156
157
158
      // CENTER marks the variable "iterGeoPos" to be in an undefined state. I.e.,
      // there is no iteration that is actually running.

Thomas Witkowski's avatar
Thomas Witkowski committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
      if (iterGeoPos == CENTER) {
	iterGeoPos = pos;
	switch (iterGeoPos) {
	case VERTEX:
	  vertexIter = vertexInRank.begin();
	  break;
	case EDGE:
	  edgeIter = edgeInRank.begin();
	  break;
	case FACE:
	  faceIter = faceInRank.begin();
	  break;
	default:
	  ERROR_EXIT("Not GeoIndex %d!\n", iterGeoPos);
	}
      } else {
	switch (iterGeoPos) {
	case VERTEX:
	  ++vertexIter;
	  break;
	case EDGE:
	  ++edgeIter;
	  break;
	case FACE:
	  ++faceIter;
	  break;
	default:
	  ERROR_EXIT("Not GeoIndex %d!\n", iterGeoPos);
	}
      }

      switch (iterGeoPos) {
      case VERTEX:
	if (vertexIter == vertexInRank.end()) {
	  iterGeoPos = CENTER;
	  return false;
	}
	break;
      case EDGE:
	if (edgeIter == edgeInRank.end()) {
	  iterGeoPos = CENTER;
	  return false;
	}
	break;
      case FACE:
	if (faceIter == faceInRank.end()) {
	  iterGeoPos = CENTER;
	  return false;
	}
	break;
      default:
	ERROR_EXIT("Should not happen!\n");	
      }

      return true;
    }


217
    /// Returns the data of the current iterator position.
218
    flat_map<int, ElementObjectData>& getIterateData()
Thomas Witkowski's avatar
Thomas Witkowski committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    {
      switch (iterGeoPos) {
      case VERTEX:
	return vertexIter->second;
	break;
      case EDGE:
	return edgeIter->second;
	break;
      case FACE:
	return faceIter->second;
	break;
      default:
	ERROR_EXIT("Should not happen!\n");

	// Will never be reached, just to avoid compiler warnings.
	return faceIter->second;
      }
    }

238
    /// Returns the rank owner of the current iterator position.
239
    int getIterateOwner(int level);
Thomas Witkowski's avatar
Thomas Witkowski committed
240

241
242
243
244
245
246
247
248
249
    /// Returns the owner of a macro element vertex.
    int getOwner(DegreeOfFreedom vertex, int level);

    /// Returns the owner of a macro element edge.
    int getOwner(DofEdge edge, int level);
	
    /// Returns the owner of a macro element face.
    int getOwner(DofFace face, int level);

250
    /// Returns the rank owner of the current iterator position.
251
    int getIterateMaxLevel();
252

253
    /// Checks if a given vertex DOF is in a given rank.
254
255
256
257
258
    int isInRank(DegreeOfFreedom vertex, int rank)
    {
      return (vertexInRank[vertex].count(rank));
    }

259
    /// Checks if a given edge is in a given rank.
260
261
262
263
264
    int isInRank(DofEdge edge, int rank)
    {
      return (edgeInRank[edge].count(rank));
    }

265
    /// Checks if a given face is in a given rank.
266
267
268
269
270
271
    int isInRank(DofFace face, int rank)
    {
      return (faceInRank[face].count(rank));
    }


272
273
    /// Returns a vector with all macro elements that have a given vertex DOF 
    /// in common.
274
    vector<ElementObjectData>& getElements(DegreeOfFreedom vertex)
Thomas Witkowski's avatar
Thomas Witkowski committed
275
276
277
278
    {
      return vertexElements[vertex];
    }

279
    /// Returns a vector with all macro elements that have a given edge in common.
280
    vector<ElementObjectData>& getElements(DofEdge edge)
Thomas Witkowski's avatar
Thomas Witkowski committed
281
282
283
284
    {
      return edgeElements[edge];
    }

285
    /// Returns a vector with all macro elements that have a given face in common.
286
    vector<ElementObjectData>& getElements(DofFace face)
Thomas Witkowski's avatar
Thomas Witkowski committed
287
288
289
290
    {
      return faceElements[face];
    }

291

292
293
    /// Returns a vector with all macro elements that have a given vertex DOF 
    /// in common.
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
    vector<ElementObjectData>& getElementsVertex(int elIndex, int ithVertex)
    {
      ElementObjectData elObj(elIndex, ithVertex);
      DegreeOfFreedom vertex = vertexLocalMap[elObj];
      return vertexElements[vertex];
    }
    
    /// Returns a vector with all macro elements that have a given edge in common.
    vector<ElementObjectData>& getElementsEdge(int elIndex, int ithEdge)
    {
      ElementObjectData elObj(elIndex, ithEdge);
      DofEdge edge = edgeLocalMap[elObj];
      return edgeElements[edge];
    }

    /// Returns a vector with all macro elements that have a given face in common.
    vector<ElementObjectData>& getElementsFace(int elIndex, int ithFace)
    {
      ElementObjectData elObj(elIndex, ithFace);
      DofFace face = faceLocalMap[elObj];
      return faceElements[face];
    }

317
318
319
320
321
322
    /// Returns, for a given vertex, a map that maps from rank numbers to 
    /// element data objects, which identify on the rank the element which 
    /// contains this vertex. If more than one element in one subdomain contains
    /// the vertex, the element with the highest element index is given. If the
    /// vertex is not contained in a rank's subdomain, it will not be considered
    /// in this mapping.
323
    flat_map<int, ElementObjectData>& getElementsInRank(DegreeOfFreedom vertex)
324
325
326
327
    {
      return vertexInRank[vertex];
    }

328
329
330
331
332
333
    /// Returns, for a given edge, a map that maps from rank numbers to 
    /// element data objects, which identify on the rank the element which 
    /// contains this edge. If more than one element in one subdomain contains
    /// the edge, the element with the highest element index is given. If the
    /// edge is not contained in a rank's subdomain, it will not be considered
    /// in this mapping.
334
    flat_map<int, ElementObjectData>& getElementsInRank(DofEdge edge)
335
336
337
338
    {
      return edgeInRank[edge];
    }

339
340
341
342
    /// Returns, for a given face, a map that maps from rank numbers to 
    /// element data objects, which identify on the rank the element which 
    /// contains this face. If the face is not contained in a rank's subdomain, 
    /// it will not be considered in this mapping.
343
    flat_map<int, ElementObjectData>& getElementsInRank(DofFace face)
344
345
346
347
    {
      return faceInRank[face];
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
    /// Get degree of a DOF, thus the number of ranks which contain it.
    inline int getDegree(DegreeOfFreedom dof)
    {
      return vertexInRank[dof].size();
    }

    /// Get degree of an edge, thus the number of ranks which contain it.
    inline int getDegree(DofEdge edge)
    {
      return edgeInRank[edge].size();
    }

    /// Get degree of a face, thus the number of ranks which contain it.
    inline int getDegree(DofFace face)
    {
      return faceInRank[face].size();
    }

366
    /// Returns to an element object data the appropriate vertex DOF.
367
368
    DegreeOfFreedom getVertexLocalMap(ElementObjectData &data)
    {
369
370
      TEST_EXIT_DBG(vertexLocalMap.count(data))("Should not happen!\n");

371
372
373
      return vertexLocalMap[data];
    }

374
    /// Returns to an element object data the appropriate edge.
375
376
    DofEdge getEdgeLocalMap(ElementObjectData &data)
    {
377
378
      TEST_EXIT_DBG(edgeLocalMap.count(data))("Should not happen!\n");

379
380
381
      return edgeLocalMap[data];
    }

382
    /// Returns to an element object data the appropriate face.
383
384
    DofFace getFaceLocalMap(ElementObjectData &data)
    {
385
386
      TEST_EXIT_DBG(faceLocalMap.count(data))("Should not happen!\n");

387
388
389
      return faceLocalMap[data];
    }

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
    PerBoundMap<DegreeOfFreedom>::type& getPeriodicVertices()
    {
      return periodicVertices;
    }

    PerBoundMap<DofEdge>::type& getPeriodicEdges()
    {
      return periodicEdges;
    }

    PerBoundMap<DofFace>::type& getPeriodicFaces()
    {
      return periodicFaces;
    }

405
406
    inline bool getEdgeReverseMode(ElementObjectData &obj0, 
				   ElementObjectData &obj1)
407
    {
408
409
410
      if (mesh->getDim() == 2)
	return true;

411
412
      if (edgeReverseMode.empty())
	return false;
413

414
      return static_cast<bool>(edgeReverseMode.count(make_pair(obj0, obj1)));
415
416
    }

417
418
    inline bool getFaceReverseMode(ElementObjectData &obj0, 
				   ElementObjectData &obj1)
419
    {
420
421
      if (faceReverseMode.empty())
	return false;
422

423
      return static_cast<bool>(faceReverseMode.count(make_pair(obj0, obj1)));
424
425
    }

426
427
428
429
430
431
    /// Returns true if there is periodic data.
    bool hasPeriodicData()
    {
      return (periodicVertices.size() != 0);
    }

432
433
434
435
436
437
438
439
    /// Returns true if the given boundary type is larger or equal to the smallest
    /// periodic boundary ID in mesh. See \ref smallestPeriodicBcType for more
    /// information.
    bool isValidPeriodicType(BoundaryType t) const
    {
      return (t >= smallestPeriodicBcType);
    }

440
441
442
443
444
445
446
447
448
449
    inline Element* getElementPtr(int index)
    {
      return macroElIndexMap[index];
    }

    inline int getElementType(int index)
    {
      return macroElIndexTypeMap[index];
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
450
451
452
453
454
455
456
    void setData(map<int, int> &rankMap,
		MeshLevelData& ld)
    {
      macroElementRankMap = &rankMap;
      levelData = &ld;
    }

457
    /// Write the element database to disk.
458
    void serialize(ostream &out);
459
460
    
    /// Read the element database from disk.
461
    void deserialize(istream &in);
462

463
464
465
    /// Returns the estimated memory usage of an object of this class.
    unsigned long calculateMemoryUsage();

466
  protected:
467
468
469
470
471
472
473
474
475
    /** \brief
     * Adds an element to the object database. If the element is part of a
     * periodic boundary, all information about subobjects of the element on
     * this boundary are collected.
     *
     * \param[in]  elInfo    ElInfo object of the element. 
     */
    void addElement(ElInfo *elInfo);

476
    /// Adds the i-th DOF vertex of an element to the object database.
Thomas Witkowski's avatar
Thomas Witkowski committed
477
    void addVertex(Element *el, int ith);
478
479

    /// Adds the i-th edge of an element to the object database.
Thomas Witkowski's avatar
Thomas Witkowski committed
480
    void addEdge(Element *el, int ith);
481
482

    /// Adds the i-th face of an element to the object database.
Thomas Witkowski's avatar
Thomas Witkowski committed
483
    void addFace(Element *el, int ith);
484

485
486
487
488
489
490
491
    /// Creates final data of the periodic boundaries. Must be called after all
    /// elements of the mesh are added to the object database. Then this
    /// functions search for indirectly connected vertices in periodic 
    /// boundaries. This is only the case, if there are more than one boundary
    /// conditions. Then, e.g., in 2D, all edges of a square are iterectly
    /// connected. In 3D, if the macro mesh is a box, all eight vertex nodes and
    /// always four of the 12 edges are indirectly connected.
492
    void createPeriodicData();
Thomas Witkowski's avatar
Thomas Witkowski committed
493
    
494
495
496
497
498
499
    /// Creates on all boundaries the reverse mode flag.
    void createReverseModeData();

    BoundaryType getNewBoundaryType();

    BoundaryType provideConnectedPeriodicBoundary(BoundaryType b0, 
500
						  BoundaryType b1);
501
502

    /// Some auxiliary function to write the element object database to disk.
503
    void serialize(ostream &out, vector<ElementObjectData>& elVec);
504

505
    /// Some auxiliary function to read the element object database from disk.
506
    void deserialize(istream &in, vector<ElementObjectData>& elVec);
507

508
    /// Some auxiliary function to write the element object database to disk.
509
    void serialize(ostream &out, flat_map<int, ElementObjectData>& data);
510

511
    /// Some auxiliary function to read the element object database from disk.
512
    void deserialize(istream &in, flat_map<int, ElementObjectData>& data);
513

514
    int getOwner(vector<ElementObjectData>& objData, int level);
Thomas Witkowski's avatar
Thomas Witkowski committed
515
  private:
516
517
    const FiniteElemSpace* feSpace;

518
519
    /// The mesh that is used to store all its element information in 
    /// the database.
520
    Mesh *mesh;
521

522
    
523
    /// Maps to each vertex DOF all element objects that represent this vertex.
524
    flat_map<DegreeOfFreedom, vector<ElementObjectData> > vertexElements;
525
526

    /// Maps to each edge all element objects that represent this edge.
527
    flat_map<DofEdge, vector<ElementObjectData> > edgeElements;
Thomas Witkowski's avatar
Thomas Witkowski committed
528

529
    /// Maps to each face all element objects that represent this edge.
530
531
532
533
534
535
536
537
538
539
540
541
    flat_map<DofFace, vector<ElementObjectData> > faceElements;

    
    /// Temporary object to speed up creation of \ref vertexElements
    map<DegreeOfFreedom, vector<ElementObjectData> > tmpVertexElements;

    /// Temporary object to speed up creation of \ref edgeElements
    map<DofEdge, vector<ElementObjectData> > tmpEdgeElements;

    /// Temporary object to speed up creation of \ref faceElements
    map<DofFace, vector<ElementObjectData> > tmpFaceElements;

542

543
544
    
    /// Maps to an element object the corresponding vertex DOF.
545
    flat_map<ElementObjectData, DegreeOfFreedom> vertexLocalMap;
546
547

    /// Maps to an element object the corresponding edge.
548
    flat_map<ElementObjectData, DofEdge> edgeLocalMap;
549
550

    /// Maps to an element object the corresponding face.
551
    flat_map<ElementObjectData, DofFace> faceLocalMap;
552

553
   
554
555
    /// Defines to each vertex DOF a map that maps to each rank number the element
    /// objects that have this vertex DOF in common.
556
    flat_map<DegreeOfFreedom, flat_map<int, ElementObjectData> > vertexInRank;
557

558
559
    /// Defines to each edge a map that maps to each rank number the element 
    /// objects that have this edge in common.
560
    flat_map<DofEdge, flat_map<int, ElementObjectData> > edgeInRank;
561

562
563
    /// Defines to each face a map that maps to each rank number the element 
    /// objects that have this face in common.
564
    flat_map<DofFace, flat_map<int, ElementObjectData> > faceInRank;
Thomas Witkowski's avatar
Thomas Witkowski committed
565

566
567

    /// Vertex iterator to iterate over \ref vertexInRank
568
    flat_map<DegreeOfFreedom, flat_map<int, ElementObjectData> >::iterator vertexIter;
569
570

    /// Edge iterator to iterate over \ref edgeInRank
571
    flat_map<DofEdge, flat_map<int, ElementObjectData> >::iterator edgeIter;
572
573

    /// Face iterator to iterate over \ref faceInRank
574
    flat_map<DofFace, flat_map<int, ElementObjectData> >::iterator faceIter;
Thomas Witkowski's avatar
Thomas Witkowski committed
575

576
577
578
579
580

    /// Defines the geometrical iteration index of the iterators. I.e., the value
    /// is either VERTEX, EDGE or FACE and the corresponding element objects are
    /// traversed. The value CENTER is used to define a not defined states of the
    /// iterators, i.e., if no iteration is running.
Thomas Witkowski's avatar
Thomas Witkowski committed
581
    GeoIndex iterGeoPos;
582

583
    map<pair<BoundaryType, BoundaryType>, BoundaryType> bConnMap;
584

585
    /// The following three data structures store periodic DOFs, edges and faces.
586
587
588
    PerBoundMap<DegreeOfFreedom>::type periodicVertices;
    PerBoundMap<DofEdge>::type periodicEdges;
    PerBoundMap<DofFace>::type periodicFaces;
589

590
591
592
593
594
595
596
    /// Defines the smallest boudary ID for periodic boundary conditions. This is
    /// required to distinguish between "real" periodic boundaries and periodic
    /// boundary IDs that are set by the parallel algorithm for indirectly 
    /// connected boundaries.
    BoundaryType smallestPeriodicBcType;

    /// Stores to each vertex all its periodic associations.
597
    map<DegreeOfFreedom, std::set<BoundaryType> > periodicDofAssoc;
598

599
    /// Stores to each edge all its periodic associations.
600
601
    map<DofEdge, std::set<DofEdge> > periodicEdgeAssoc;

602
603
    /// Stores all interior edge boundaries which have reverse mode enabled.
    std::set<pair<ElementObjectData, ElementObjectData> > edgeReverseMode;
604

605
606
    /// Stores all interior face boundaries which have reverse mode enabled.
    std::set<pair<ElementObjectData, ElementObjectData> > faceReverseMode;
607

608
609
    map<int, int> *macroElementRankMap;

610
    /// Maps to each macro element index a pointer to the corresponding element.
611
    flat_map<int, Element*> macroElIndexMap;
612
613
    
    /// Maps to each macro element index the type of this element.
614
    flat_map<int, int> macroElIndexTypeMap;
615
616

    MeshLevelData* levelData;
Thomas Witkowski's avatar
Thomas Witkowski committed
617
618
619
620
621
  };

}

#endif