Element.h 19 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
22
23
24
25

/** \file Element.h */

#ifndef AMDIS_ELEMENT_H
#define AMDIS_ELEMENT_H

26
#include "AMDiS_fwd.h"
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#include "Global.h"
#include "RefinementManager.h"
#include "Serializable.h"
#include "ElementData.h"
#include "LeafData.h"

namespace AMDiS {

  template<typename T, GeoIndex d> class FixVec;

#define AMDIS_UNDEFINED  5

  /** \ingroup Triangulation 
   * \brief
   * Base class for Line, Triangle, Tetrahedron
   *
   * Elements in AMDiS are always simplices (a simplex is a Line in 1d, a 
   * Triangle in 2d and a Tetrahedron in 3d). 
   * We restrict ourselves here to simplicial meshes, for several reasons:
   * -# A simplex is one of the most simple geometric types and complex domains 
   *    may be approximated by a set of simplices quite easily.
   * -# Simplicial meshes allow local refinement without the need of 
   *    nonconforming meshes (hanging nodes), parametric elements, or mixture of
   *    element types (which is the case for quadrilateral meshes).
   * -# Polynomials of any degree are easily represented on a simplex using 
   *    local (barycentric) coordinates.
   *
   * A Line element and its refinement:
   *
   * <img src="line.png">
   *
   * A Triangle element and its refinement:
   *
   * <img src="triangle.png">
   *
   * A Tetrahedron element and its refinements:
   *
   * <img src="tetrahedron.png">
   */
  class Element : public Serializable
  {
  private:
69
    /// private standard constructor because an Element must know his Mesh
70
    Element() {}
71

72
  public:
73
    /// constructs an Element which belongs to Mesh
74
75
    Element(Mesh *);

76
    /// copy constructor
77
78
    Element(const Element& old);

79
    /// destructor
80
81
    virtual ~Element();

82
    ///
83
84
    void deleteElementDOFs();

85
86
    /// Clone this Element and return a reference to it. Because also the DOFs
    /// are cloned, \ref Mesh::serializedDOfs must be used.
87
88
    Element* cloneWithDOFs();

89
90
91
92
    /** \name getting methods
     * \{
     */

93
    /// Returns \ref child[0]
Thomas Witkowski's avatar
Thomas Witkowski committed
94
95
    inline Element* getFirstChild() const 
    {
96
      return child[0];
97
    }
98

99
    /// Returns \ref child[1]
Thomas Witkowski's avatar
Thomas Witkowski committed
100
101
    inline Element* getSecondChild() const 
    {
102
      return child[1];
103
    }
104

105
    /// Returns \ref child[i], i=0,1
Thomas Witkowski's avatar
Thomas Witkowski committed
106
107
    inline Element* getChild(int i) const 
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
108
      TEST_EXIT_DBG(i == 0 || i == 1)("There is only child 0 or 1! (i = %d)\n", i);
109
      return child[i];
110
    }
111

112
113
    /// Returns true if Element is a leaf element (\ref child[0] == NULL), returns
    /// false otherwise.
Thomas Witkowski's avatar
Thomas Witkowski committed
114
115
    inline const bool isLeaf() const 
    { 
116
      return (child[0] == NULL); 
117
    }
118

119
    /// Returns \ref dof[i][j] which is the j-th DOF of the i-th node of Element.
120
    inline DegreeOfFreedom getDof(int i, int j) const 
Thomas Witkowski's avatar
Thomas Witkowski committed
121
    { 
122
      TEST_EXIT_DBG(dof != NULL)("DOFs are not valid in element %d!\n", index);
123

124
      return dof[i][j];
125
    }
126

127
    /// Returns \ref dof[i] which is a pointer to the DOFs of the i-th node.
128
    inline const DegreeOfFreedom* getDof(int i) const 
Thomas Witkowski's avatar
Thomas Witkowski committed
129
    {
130
      TEST_EXIT_DBG(dof != NULL)("DOFs are not valid in element %d!\n", index);
131

132
      return dof[i];
133
    }
134

135
    /// Returns a pointer to the DOFs of this Element
136
    inline const DegreeOfFreedom** getDof() const 
Thomas Witkowski's avatar
Thomas Witkowski committed
137
    {
138
      TEST_EXIT_DBG(dof != NULL)("DOFs are not valid in element %d!\n", index);
139

140
      return const_cast<const DegreeOfFreedom**>(dof);
141
    }
142

143
    /// Returns \ref mesh of Element
Thomas Witkowski's avatar
Thomas Witkowski committed
144
145
    inline Mesh* getMesh() const 
    { 
146
      return mesh; 
147
    }
148

149
150
    /// Returns \ref elementData's error estimation, if Element is a leaf element
    /// and has leaf data. 
151
152
    inline double getEstimation(int row) const
    {
153
      if (isLeaf()) {
154
	TEST_EXIT_DBG(elementData)("leaf element without leaf data\n");
155
	ElementData *ld = elementData->getElementData(ESTIMATABLE);
156
	TEST_EXIT_DBG(ld)("leaf data not estimatable!\n");
157

158
159
160
161
	return dynamic_cast<LeafDataEstimatableInterface*>(ld)->getErrorEstimate(row);
      }	
      
      return 0.0;
162
    }
163

164
165
    /// Returns Element's coarsening error estimation, if Element is a leaf 
    /// element and if it has leaf data and if this leaf data are coarsenable.
Thomas Witkowski's avatar
Thomas Witkowski committed
166
167
    inline double getCoarseningEstimation(int row) 
    {
168
      if (isLeaf()) {
169
	TEST_EXIT_DBG(elementData)("leaf element without leaf data\n");
170
	ElementData *ld = elementData->getElementData(COARSENABLE);
171
	TEST_EXIT_DBG(ld)("element data not coarsenable!\n");
172

173
	return dynamic_cast<LeafDataCoarsenableInterface*>(ld)->getCoarseningErrorEstimate(row);
174
      }
175
176
      
      return 0.0;
177
    }
178

179
    /// Returns region of element if defined, -1 else.
180
181
    int getRegion() const;

182
    /// Returns local vertex number of the j-th vertex of the i-th edge
183
184
    virtual int getVertexOfEdge(int i, int j) const = 0; 

185
186
    /// Returns local vertex number of the vertexIndex-th vertex of the
    /// positionIndex-th part of type position (vertex, edge, face)
187
    virtual int getVertexOfPosition(GeoIndex position,
188
189
				    int positionIndex,
				    int vertexIndex) const = 0;
190

191
    ///
192
193
    virtual int getPositionOfVertex(int side, int vertex) const = 0;

194
    ///
195
196
    virtual int getEdgeOfFace(int face, int edge) const = 0;

197
    ///
198
199
200
201
    virtual DofEdge getEdge(int localEdgeIndex) const = 0;

    ///
    virtual DofFace getFace(int localFaceIndex) const = 0;
202

203
    /// Returns the number of parts of type i in this element
204
205
    virtual int getGeo(GeoIndex i) const = 0;

206
    /// Returns Element's \ref mark
207
    inline const int getMark() const 
Thomas Witkowski's avatar
Thomas Witkowski committed
208
    { 
209
      return mark;
210
    }
211

212
    /// Returns \ref newCoord[i]
Thomas Witkowski's avatar
Thomas Witkowski committed
213
214
    inline double getNewCoord(int i) const 
    {
215
216
217
	TEST_EXIT_DBG(newCoord)("newCoord = NULL\n");
	return (*newCoord)[i];
    }
218

219
    /// Returns Element's \ref index
Thomas Witkowski's avatar
Thomas Witkowski committed
220
221
    inline int getIndex() const 
    { 
222
      return index; 
223
    }
224

225
    /// Returns \ref newCoord
Thomas Witkowski's avatar
Thomas Witkowski committed
226
227
    inline WorldVector<double>* getNewCoord() const 
    { 
228
      return newCoord; 
229
    }
230
231
232
233
234
235
236

    /** \} */

    /** \name setting methods
     * \{
     */

237
    /// Sets \ref child[0]
Thomas Witkowski's avatar
Thomas Witkowski committed
238
239
    virtual void setFirstChild(Element *aChild) 
    {
240
      child[0] = aChild;
241
    }
242

243
    /// Sets \ref child[1]
Thomas Witkowski's avatar
Thomas Witkowski committed
244
245
    virtual void setSecondChild(Element *aChild) 
    {
246
      child[1] = aChild;
247
    }
248

249
    /// Sets \ref elementData of Element
Thomas Witkowski's avatar
Thomas Witkowski committed
250
251
    void setElementData(ElementData* ed) 
    {
252
      elementData = ed;
253
    }
254

255
256
    /// Sets \ref newCoord of Element. Needed by refinement, if Element has a
    /// boundary edge on a curved boundary.
Thomas Witkowski's avatar
Thomas Witkowski committed
257
258
    inline void setNewCoord(WorldVector<double>* coord) 
    {
259
      newCoord = coord;
260
    }
261

262
    /// Sets \ref mesh.
Thomas Witkowski's avatar
Thomas Witkowski committed
263
264
    inline void setMesh(Mesh *m) 
    {
265
      mesh = m;
266
    }
267

268
    /// Sets the pointer to the DOFs of the i-th node of Element
269
    inline void setDof(int pos, DegreeOfFreedom* p) 
Thomas Witkowski's avatar
Thomas Witkowski committed
270
    {
271
      dof[pos] = p;
272
    }
273

274
275
276
277
278
279
280
281
282
    /// Delets the main DOF pointer. The caller must ensure that the DOFs are
    /// either freed correctly elsewhere or that they are still used by other
    /// elements.
    void delDofPtr()
    {
      delete [] dof;
      dof = NULL;
    }

283
284
    /// Checks whether Element is a leaf element and whether it has leaf data.
    /// If the checks don't fail, leaf data's error estimation is set to est.
285
286
    inline void setEstimation(double est, int row)
    {
287
288
      FUNCNAME("Element::setEstimation()");

289
      if (isLeaf()) {
290
	TEST_EXIT_DBG(elementData)("Leaf element %d without leaf data!\n", index);
291
	ElementData *ld = elementData->getElementData(ESTIMATABLE);
292
	TEST_EXIT_DBG(ld)("Leaf data %d not estimatable!\n", index);
293
294
295

	dynamic_cast<LeafDataEstimatableInterface*>(ld)->
	  setErrorEstimate(row, est);
296
      } else {
297
298
	ERROR_EXIT("setEstimation only for leaf elements!\n");
      }
299
    }
300

301
302
    /// Sets Element's coarsening error estimation, if Element is a leaf element
    /// and if it has leaf data and if this leaf data are coarsenable.
303
304
    inline void setCoarseningEstimation(double est, int row)
    {
305
      if (isLeaf()) {
306
	TEST_EXIT_DBG(elementData)("leaf element without leaf data\n");
307
	ElementData *ld = elementData->getElementData(COARSENABLE);
308
	TEST_EXIT_DBG(ld)("leaf data not coarsenable\n");
309
310
311

	dynamic_cast<LeafDataCoarsenableInterface*>(ld)->
	  setCoarseningErrorEstimate(row, est);
312
      } else {
313
314
	ERROR_EXIT("setEstimation only for leaf elements!\n");
      }
315
    }
316

317
    /// Sets Elements \ref mark = mark + 1;
Thomas Witkowski's avatar
Thomas Witkowski committed
318
319
    inline void incrementMark() 
    {
320
321
      mark++;
    }
322

323
    /// Sets Elements \ref mark = mark - 1;
Thomas Witkowski's avatar
Thomas Witkowski committed
324
325
    inline void decrementMark() 
    {
326
327
      if (0 < mark) 
	mark--;
328
    }
329

330
    /// Sets Element's \ref mark
331
    inline void setMark(int m) 
Thomas Witkowski's avatar
Thomas Witkowski committed
332
    {
333
      mark = m;
334
    }
335
336
337
338
339
340
341
342

    /** \} */


    /** \name pure virtual methods 
     * \{ 
     */

343
344
    /// orient the vertices of edges/faces.
    /// Used by Estimator for the jumps => same quadrature nodes from both sides!
345
    virtual const FixVec<int,WORLD>& 
346
      sortFaceIndices(int face, FixVec<int, WORLD> *vec) const = 0;
347

348
349
    /// Returns a copy of itself. Needed by Mesh to create Elements by 
    /// a prototype. 
350
351
    virtual Element *clone() = 0;

352
353
354
    /// Returns which side of child[childnr] corresponds to side sidenr of 
    /// this Element. If the child has no corresponding side, the return value 
    /// is negative.
355
356
    virtual int getSideOfChild(int childnr, int sidenr, int elType = 0) const = 0;

357
    /** \brief
358
359
360
     * Generalization of \ref getSideOfChild to arbitrary subObject. Thus, 
     * e.g., in 3d we can ask for the local id of a verte, edge or face 
     * on the elements children.
361
362
363
364
365
366
367
368
369
     *
     * \param[in]  childnr    Either 0 or 1 for the left or right children.
     * \param[in]  subObj     Defines whether we ask for VERTEX, EDGE or FACE.
     * \param[in]  ithObj     Number of the object on the parent.
     * \param[in]  elType     Type of the element. Important only in 3D.
     */
    virtual int getSubObjOfChild(int childnr, GeoIndex subObj, int ithObj, 
				 int elType = 0) const = 0;

370
371
372
373
374
375
    /// Returns which vertex of elements parent corresponds to the vertexnr of
    /// the element, if the element is the childnr-th child of the parent.
    /// If the vertex is the ner vertex at the refinement edge, -1 is returned.
    virtual int getVertexOfParent(int childnr, 
				  int vertexnr, 
				  int elType = 0) const = 0;
376

377
    /// Returns whether Element is a Line
378
379
    virtual bool isLine() const = 0;

380
    /// Returns whether Element is a Triangle
381
382
    virtual bool isTriangle() const = 0;

383
    /// Returns whether Element is a Tetrahedron
384
385
    virtual bool isTetrahedron() const = 0;

386
    /// Returns whether Element has sideElem as one of its sides.
387
388
    virtual bool hasSide(Element *sideElem) const = 0;

389
390
391
392
393
394
395
    /** \brief
     * Returns for a given element type number the element type number of the children.
     * For 1d and 2d this is always 0, because element type number are used in the 
     * 3d case only.
     */
    virtual int getChildType(int elType) const = 0;

396
    /** \brief
397
398
399
400
     * Traverses a vertex/edge/face of a given element (this includes also all
     * children of the element having the same edge/face). All DOFs on mesh
     * nodes alonge this vertex/edge/face are assembled and put together to 
     * a list.
401
     *
402
403
404
405
406
407
408
409
     * \param[in]  feSpace     FE space which is used to get the dofs.
     * \param[in]  bound       Defines the vertex/edge/face of the element on
     *                         which all vertex dofs are assembled.
     * \param[out] dofs        List of dofs, where the result is stored.
     * \param[in]  baseDofPtr  If true, the base DOF pointes are stored. Thus,
     *                         dof* [\ref dof] of the element is inserted. If 
     *                         false, &(dof[.][n0]) is put to the result vector, 
     *                         with n0 beging the number of predofs.
410
     */
411
    virtual void getNodeDofs(const FiniteElemSpace* feSpace, 
412
			     BoundaryObject bound,
413
414
			     DofContainer& dofs,
			     bool baseDofPtr = false) const = 0;
415
416

    /** \brief
417
418
419
420
     * Traverses a vertex/edge/face of a given element (this includes also all
     * children of the element having the same edge/face). All DOFs belonging
     * to higher order basis functions alonge this vertex/edge/face are 
     * assembled and put together to a list.
421
     *
422
423
424
425
426
427
428
429
     * \param[in]  feSpace     FE space which is used to get the dofs.
     * \param[in]  bound       Defines the edge/face of the element on which
     *                         all non vertex dofs are assembled.
     * \param[out] dofs        All dofs are put to this dof list.
     * \param[in]  baseDofPtr  If true, the base DOF pointes are stored. Thus,
     *                         dof* [\ref dof] of the element is inserted. If 
     *                         false, &(dof[.][n0]) is put to the result vector, 
     *                         with n0 beging the number of predofs.
430
     */
431
    virtual void getHigherOrderDofs(const FiniteElemSpace* feSpace, 
432
				    BoundaryObject bound,
433
434
				    DofContainer& dofs,
				    bool baseDofPtr = false) const = 0;
435

436
437
    /// Combines \ref getNodeDofs and \ref getHigherOrderDofs to one function. 
    /// See parameter description there.
438
    void getAllDofs(const FiniteElemSpace* feSpace, 
439
		    BoundaryObject bound, 
440
441
		    DofContainer& dofs,
		    bool baseDofPtr = false);
442
443


444
445
446
447
    /** \} */

    // ===== other public methods =================================================

448
    /// assignment operator
449
    Element& operator=(const Element& el);
450
451
452
453
454
455
456

    /** \brief
     * Checks whether the face with vertices dof[0],..,dof[DIM-1] is
     * part of mel's boundary. returns the opposite vertex if true, -1 else
     */
    int oppVertex(FixVec<DegreeOfFreedom*, DIMEN> pdof) const;

457
    /// Refines Element's leaf data
Thomas Witkowski's avatar
Thomas Witkowski committed
458
459
    inline void refineElementData(Element* child1, Element* child2, int elType = 0) 
    {
460
461
462
      if (elementData) {
	bool remove = elementData->refineElementData(this, child1, child2, elType);
	if (remove) {
463
	  ElementData *tmp = elementData->getDecorated();
Thomas Witkowski's avatar
Thomas Witkowski committed
464
	  delete elementData;
465
466
467
	  elementData = tmp;
	}
      }
468
    }
469

470
    /// Coarsens Element's leaf data
471
472
    inline void coarsenElementData(Element* child1, Element* child2, 
				   int elType = 0) 
Thomas Witkowski's avatar
Thomas Witkowski committed
473
    {
474
475
      ElementData *childData;
      childData = child1->getElementData();
476
      if (childData) {
477
	childData->coarsenElementData(this, child1, child2, elType);
Thomas Witkowski's avatar
Thomas Witkowski committed
478
	delete childData;
479
480
481
	child1->setElementData(NULL);
      }
      childData = child2->getElementData();
482
      if (childData) {
483
	childData->coarsenElementData(this, child2, child1, elType);
Thomas Witkowski's avatar
Thomas Witkowski committed
484
	delete childData;
485
486
	child2->setElementData(NULL);
      }
487
    }
488

489
    /// Returns pointer to \ref elementData
Thomas Witkowski's avatar
Thomas Witkowski committed
490
491
    inline ElementData* getElementData() const 
    {
492
      return elementData;
493
    }
494

495
    ///
Thomas Witkowski's avatar
Thomas Witkowski committed
496
497
498
    inline ElementData* getElementData(int typeID) const 
    {
      if (elementData)
499
	return elementData->getElementData(typeID);
Thomas Witkowski's avatar
Thomas Witkowski committed
500

501
      return NULL;
502
    }
503

504
    /// Deletes the \ref elementData with a specific typeID.
505
    bool deleteElementData(int typeID);
506
507
508
509
510
511
512
513

    /** \brief
     * Returns whether element is refined at side side
     * el1, el2 are the corresponding children. 
     * (not neccessarly the direct children!)
     * elementTyp is the type of this element (comes from ElInfo)
     */
    bool isRefinedAtSide(int side, Element *el1, Element *el2, 
514
			 unsigned char elementTyp = 255);
515

516
    /// Returns whether Element's \ref newCoord is set
Thomas Witkowski's avatar
Thomas Witkowski committed
517
518
    inline bool isNewCoordSet() const 
    { 
519
      return (newCoord != NULL);
520
    }
521

522
    /// Frees memory for \ref newCoord
523
    void eraseNewCoord();
524
525
 
    /// Serialize the element to a file.
526
    void serialize(std::ostream &out);
527

528
    /// Deserialize an element from a file.
529
    void deserialize(std::istream &in);
530

531
532
533
    /// Sets Element's \ref dof pointer.
    void createNewDofPtrs();
 
534
  protected:
535
    /// Sets Element's \ref index. Used by friend class Mesh.
Thomas Witkowski's avatar
Thomas Witkowski committed
536
537
    inline void setIndex(int i) 
    {
538
      index = i;
539
    }
540

541
    /// Used by friend class Mesh while dofCompress
542
    void newDofFct1(const DOFAdmin*, std::vector<int>&);
543

544
    /// Used by friend class Mesh while dofCompress
545
546
547
    void newDofFct2(const DOFAdmin*);

    /// Changes old dofs to negative new dofs
548
549
    void changeDofs1(const DOFAdmin* admin, std::vector<int>& newDofIndex,
		     int n0, int nd0, int nd, int pos);
550
551
552

    /// Changes negative new dofs to positive
    void changeDofs2(int n0, int nd0, int nd, int pos);
553
554

  protected:
555
556
    /// Pointers to the two children of interior elements of the tree. Pointers
    /// to NULL for leaf elements.
557
    Element *child[2];
558
559
560
561
562

    /** \brief
     * Vector of pointers to DOFs. These pointers must be available for elements
     * vertices (for the geometric description of the mesh). There my be pointers
     * for the edges, for faces and for the center of an element. They are 
563
564
565
     * ordered the following way: The first N_VERTICES entries correspond to the
     * DOFs at the vertices of the element. The next ones are those at the edges,
     * if present, then those at the faces, if present, and then those at the 
566
567
     * barycenter, if present.
     */
568
    DegreeOfFreedom **dof;
569
570
571
572
573
574

    /** \brief
     * Unique global index of the element. these indices are not strictly ordered
     * and may be larger than the number of elements in the binary tree (the list
     * of indices may have holes after coarsening).
     */
575
    int index;
576
577
578
579
580
581

    /** \brief
     * Marker for refinement and coarsening. if mark is positive for a leaf
     * element, this element is refined mark times. if mark is negative for
     * a leaf element, this element is coarsened -mark times.
     */
582
    int mark;
583
584
585
586
587
 
    /** \brief
     * If the element has a boundary edge on a curved boundary, this is a pointer
     * to the coordinates of the new vertex that is created due to the refinement
     * of the element, otherwise it is a NULL pointer. Thus coordinate 
588
589
     * information can be also produced by the traversal routines in the case of 
     * curved boundary.
590
591
592
     */
    WorldVector<double> *newCoord;

593
    /// Pointer to the Mesh this element belongs to
594
    Mesh* mesh;
595

596
    /// Pointer to Element's leaf data
597
    ElementData* elementData;
598

599
600
601
    /// This map is used for deletion of all DOFs of all elements of a mesh. Once
    /// a DOF-vector (all DOFS at a node, edge, etc.) is deleted, its address is
    /// added to this map to note not to delete it a second time.
602
    static std::map<DegreeOfFreedom*, bool> deletedDOFs;
603
604
605

    friend class Mesh;
  };
606
607
608
609
610


  /// Writes the element hierarchie to a Graphviz dot-file. Using the dot-tool from
  /// Graphvis, this dot-file can be converted to a ps-file. Useful for debugging!
  void writeDotFile(Element *el, std::string filename, int maxLevels = -1);
611
612
}

613
614
#include "Element.hh"

615
616
#endif  // AMDIS_ELEMENT_H