ElementObjectDatabase.h 17.9 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
30

#include <map>
#include <vector>
#include <boost/tuple/tuple.hpp>
#include <boost/tuple/tuple_comparison.hpp>

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

namespace AMDiS {

40
41
  using namespace std;

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

49
50

  /// Defines one element object. This may be either a vertex, edge or face.
Thomas Witkowski's avatar
Thomas Witkowski committed
51
  struct ElementObjectData {
52
    ElementObjectData(int a = -1, int b = 0)
Thomas Witkowski's avatar
Thomas Witkowski committed
53
      : elIndex(a),
54
	ithObject(b)
Thomas Witkowski's avatar
Thomas Witkowski committed
55
    {}
56
57

    /// Index of the element this object is part of.
Thomas Witkowski's avatar
Thomas Witkowski committed
58
59
    int elIndex;
    
60
    /// Index of the object within the element.
Thomas Witkowski's avatar
Thomas Witkowski committed
61
    int ithObject;
Thomas Witkowski's avatar
Thomas Witkowski committed
62

63
    /// Write this element object to disk.
64
    void serialize(ostream &out) const
65
66
67
68
69
    {
      SerUtil::serialize(out, elIndex);
      SerUtil::serialize(out, ithObject);
    }

70
    /// Read this element object from disk.
71
    void deserialize(istream &in)
72
73
74
75
76
    {
      SerUtil::deserialize(in, elIndex);
      SerUtil::deserialize(in, ithObject);
    }

77
    /// Compare this element object with another one.
78
79
    bool operator==(ElementObjectData& cmp) const
    {
80
      return (elIndex == cmp.elIndex && ithObject == cmp.ithObject);
81
82
    }

83
    /// Define a strict order on element objects.
84
85
    bool operator<(const ElementObjectData& rhs) const
    {
86
87
      return (elIndex < rhs.elIndex || 
	      (elIndex == rhs.elIndex && ithObject < rhs.ithObject));
88
    }
Thomas Witkowski's avatar
Thomas Witkowski committed
89
90
91
92
  };



93
94
  /** \brief
   * This class is a database of element objects. An element object is either a
95
96
97
98
99
100
101
   * 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.
102
   */
103
  class ElementObjectDatabase {
Thomas Witkowski's avatar
Thomas Witkowski committed
104
  public:
105
    ElementObjectDatabase()
106
107
      : feSpace(NULL),
	mesh(NULL),
108
109
	iterGeoPos(CENTER),
	macroElementRankMap(NULL),
110
111
	levelData(NULL)
    {}
Thomas Witkowski's avatar
Thomas Witkowski committed
112

113
    void setFeSpace(const FiniteElemSpace *fe)
Thomas Witkowski's avatar
Thomas Witkowski committed
114
    {
115
116
117
118
119
120
121
      feSpace = fe;
      mesh = feSpace->getMesh();
    }
  
    Mesh* getMesh()
    {
      return mesh;
122
123
    }

124
125
126
127
128
129
    /*
     * \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);
130

131
    void createMacroElementInfo(vector<MacroElement*> &mel);
132

133
134
135
    /// 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.
136
    void updateRankData();
137

Thomas Witkowski's avatar
bla    
Thomas Witkowski committed
138
139
140
    /// All data from the database is dropped. 
    void clear();

141
    /** \brief
142
143
144
     * 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.
145
     *
146
147
     * \param[in]  pos   Must be either VERTEX, EDGE or FACE and defines the
     *                   elements that should be traversed.
148
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
149
150
    bool iterate(GeoIndex pos)
    {
151
152
153
      // 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
154
155
156
157
158
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
      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;
    }


212
    /// Returns the data of the current iterator position.
213
    map<int, ElementObjectData>& getIterateData()
Thomas Witkowski's avatar
Thomas Witkowski committed
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    {
      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;
      }
    }

233
    /// Returns the rank owner of the current iterator position.
234
    int getIterateOwner(int level);
Thomas Witkowski's avatar
Thomas Witkowski committed
235

236
237
238
239
240
241
242
243
244
    /// 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);

245
    /// Returns the rank owner of the current iterator position.
246
    int getIterateMaxLevel();
247

248
    /// Checks if a given vertex DOF is in a given rank.
249
250
251
252
253
    int isInRank(DegreeOfFreedom vertex, int rank)
    {
      return (vertexInRank[vertex].count(rank));
    }

254
    /// Checks if a given edge is in a given rank.
255
256
257
258
259
    int isInRank(DofEdge edge, int rank)
    {
      return (edgeInRank[edge].count(rank));
    }

260
    /// Checks if a given face is in a given rank.
261
262
263
264
265
266
    int isInRank(DofFace face, int rank)
    {
      return (faceInRank[face].count(rank));
    }


267
268
    /// Returns a vector with all macro elements that have a given vertex DOF 
    /// in common.
269
    vector<ElementObjectData>& getElements(DegreeOfFreedom vertex)
Thomas Witkowski's avatar
Thomas Witkowski committed
270
271
272
273
    {
      return vertexElements[vertex];
    }

274
    /// Returns a vector with all macro elements that have a given edge in common.
275
    vector<ElementObjectData>& getElements(DofEdge edge)
Thomas Witkowski's avatar
Thomas Witkowski committed
276
277
278
279
    {
      return edgeElements[edge];
    }

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

286

287
288
    /// Returns a vector with all macro elements that have a given vertex DOF 
    /// in common.
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    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];
    }

312
313
314
315
316
317
    /// 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.
318
    map<int, ElementObjectData>& getElementsInRank(DegreeOfFreedom vertex)
319
320
321
322
    {
      return vertexInRank[vertex];
    }

323
324
325
326
327
328
    /// 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.
329
    map<int, ElementObjectData>& getElementsInRank(DofEdge edge)
330
331
332
333
    {
      return edgeInRank[edge];
    }

334
335
336
337
    /// 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.
338
    map<int, ElementObjectData>& getElementsInRank(DofFace face)
339
340
341
342
    {
      return faceInRank[face];
    }

343
    /// Returns to an element object data the appropriate vertex DOF.
344
345
    DegreeOfFreedom getVertexLocalMap(ElementObjectData &data)
    {
346
347
      TEST_EXIT_DBG(vertexLocalMap.count(data))("Should not happen!\n");

348
349
350
      return vertexLocalMap[data];
    }

351
    /// Returns to an element object data the appropriate edge.
352
353
    DofEdge getEdgeLocalMap(ElementObjectData &data)
    {
354
355
      TEST_EXIT_DBG(edgeLocalMap.count(data))("Should not happen!\n");

356
357
358
      return edgeLocalMap[data];
    }

359
    /// Returns to an element object data the appropriate face.
360
361
    DofFace getFaceLocalMap(ElementObjectData &data)
    {
362
363
      TEST_EXIT_DBG(faceLocalMap.count(data))("Should not happen!\n");

364
365
366
      return faceLocalMap[data];
    }

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
    PerBoundMap<DegreeOfFreedom>::type& getPeriodicVertices()
    {
      return periodicVertices;
    }

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

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

382
383
    inline bool getEdgeReverseMode(ElementObjectData &obj0, 
				   ElementObjectData &obj1)
384
    {
385
386
387
      if (mesh->getDim() == 2)
	return true;

388
389
390
391
392
393
      TEST_EXIT_DBG(edgeReverseMode.count(make_pair(obj0, obj1)))
	("Should not happen!\n");

      return edgeReverseMode[make_pair(obj0, obj1)];
    }

394
395
    inline bool getFaceReverseMode(ElementObjectData &obj0, 
				   ElementObjectData &obj1)
396
397
398
399
400
401
402
    {
      TEST_EXIT_DBG(faceReverseMode.count(make_pair(obj0, obj1)))
	("Should not happen!\n");

      return faceReverseMode[make_pair(obj0, obj1)];
    }

403
404
405
406
407
408
    /// Returns true if there is periodic data.
    bool hasPeriodicData()
    {
      return (periodicVertices.size() != 0);
    }

409
410
411
412
413
414
415
416
    /// 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);
    }

417
418
419
420
421
422
423
424
425
426
    inline Element* getElementPtr(int index)
    {
      return macroElIndexMap[index];
    }

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

Thomas Witkowski's avatar
Thomas Witkowski committed
427
428
429
430
431
432
433
    void setData(map<int, int> &rankMap,
		MeshLevelData& ld)
    {
      macroElementRankMap = &rankMap;
      levelData = &ld;
    }

434
    /// Write the element database to disk.
435
    void serialize(ostream &out);
436
437
    
    /// Read the element database from disk.
438
    void deserialize(istream &in);
439

440
441
442
    /// Returns the estimated memory usage of an object of this class.
    unsigned long calculateMemoryUsage();

443
  protected:
444
445
446
447
448
449
450
451
452
    /** \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);

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

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

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

462
463
464
465
466
467
468
469
470
471
    /** \brief
     * 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.
     */
    void createPeriodicData();
Thomas Witkowski's avatar
Thomas Witkowski committed
472
    
473
474
475
476
477
478
    /// Creates on all boundaries the reverse mode flag.
    void createReverseModeData();

    BoundaryType getNewBoundaryType();

    BoundaryType provideConnectedPeriodicBoundary(BoundaryType b0, 
479
						  BoundaryType b1);
480
481

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

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

487
    /// Some auxiliary function to write the element object database to disk.
488
    void serialize(ostream &out, map<int, ElementObjectData>& data);
489

490
    /// Some auxiliary function to read the element object database from disk.
491
    void deserialize(istream &in, map<int, ElementObjectData>& data);
492

493
    int getOwner(vector<ElementObjectData>& objData, int level);
Thomas Witkowski's avatar
Thomas Witkowski committed
494
  private:
495
496
    const FiniteElemSpace* feSpace;

497
498
    /// The mesh that is used to store all its element information in 
    /// the database.
499
    Mesh *mesh;
500
    
501
    /// Maps to each vertex DOF all element objects that represent this vertex.
502
    map<DegreeOfFreedom, vector<ElementObjectData> > vertexElements;
503
504

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

507
508
    /// Maps to each face all element objects that represent this edge.
    map<DofFace, vector<ElementObjectData> > faceElements;
509

510
511
    
    /// Maps to an element object the corresponding vertex DOF.
512
    map<ElementObjectData, DegreeOfFreedom> vertexLocalMap;
513
514

    /// Maps to an element object the corresponding edge.
515
    map<ElementObjectData, DofEdge> edgeLocalMap;
516
517

    /// Maps to an element object the corresponding face.
518
    map<ElementObjectData, DofFace> faceLocalMap;
519

520
   
521
522
    /// Defines to each vertex DOF a map that maps to each rank number the element
    /// objects that have this vertex DOF in common.
523
    map<DegreeOfFreedom, map<int, ElementObjectData> > vertexInRank;
524

525
526
    /// Defines to each edge a map that maps to each rank number the element 
    /// objects that have this edge in common.
527
    map<DofEdge, map<int, ElementObjectData> > edgeInRank;
528

529
530
    /// Defines to each face a map that maps to each rank number the element 
    /// objects that have this face in common.
531
    map<DofFace, map<int, ElementObjectData> > faceInRank;
Thomas Witkowski's avatar
Thomas Witkowski committed
532

533
534

    /// Vertex iterator to iterate over \ref vertexInRank
535
    map<DegreeOfFreedom, map<int, ElementObjectData> >::iterator vertexIter;
536
537

    /// Edge iterator to iterate over \ref edgeInRank
538
    map<DofEdge, map<int, ElementObjectData> >::iterator edgeIter;
539
540

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

543
544
545
546
547

    /// 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
548
    GeoIndex iterGeoPos;
549

550
    map<pair<BoundaryType, BoundaryType>, BoundaryType> bConnMap;
551

552
    /// The following three data structures store periodic DOFs, edges and faces.
553
554
555
    PerBoundMap<DegreeOfFreedom>::type periodicVertices;
    PerBoundMap<DofEdge>::type periodicEdges;
    PerBoundMap<DofFace>::type periodicFaces;
556

557
558
559
560
561
562
563
    /// 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.
564
    map<DegreeOfFreedom, std::set<BoundaryType> > periodicDofAssoc;
565

566
    /// Stores to each edge all its periodic associations.
567
568
569
570
571
    map<DofEdge, std::set<DofEdge> > periodicEdgeAssoc;

    map<pair<ElementObjectData, ElementObjectData>, bool> edgeReverseMode;

    map<pair<ElementObjectData, ElementObjectData>, bool> faceReverseMode;
572

573
574
    map<int, int> *macroElementRankMap;

575
576
577
578
579
    /// Maps to each macro element index a pointer to the corresponding element.
    map<int, Element*> macroElIndexMap;
    
    /// Maps to each macro element index the type of this element.
    map<int, int> macroElIndexTypeMap;
580
581

    MeshLevelData* levelData;
Thomas Witkowski's avatar
Thomas Witkowski committed
582
583
584
585
586
  };

}

#endif