ug4
reference_element_util.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2015: G-CSC, Goethe University Frankfurt
3  * Author: Andreas Vogel
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_ELEMENT_UTIL__
34 #define __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_ELEMENT_UTIL__
35 
36 
37 namespace ug{
38 
41 {
42  switch(roid)
43  {
44  case ROID_VERTEX: return 0;
45  case ROID_EDGE: return 1;
46  case ROID_TRIANGLE: return 2;
47  case ROID_QUADRILATERAL: return 2;
48  case ROID_TETRAHEDRON: return 3;
49  case ROID_OCTAHEDRON: return 3;
50  case ROID_PYRAMID: return 3;
51  case ROID_PRISM: return 3;
52  case ROID_HEXAHEDRON: return 3;
53  default:UG_THROW("ReferenceElementDimension: ReferenceObjectId "
54  <<roid<<" not found.");
55  }
56 }
57 
59 template <int dim>
61 
62 template <>
64 {
65  switch(roid)
66  {
67  case ROID_EDGE: return MathVector<1>(0.5);
68  default: UG_THROW("ReferenceObject "<<roid<<" not found in dim 1.");
69  }
70 }
71 
72 template <>
73 inline MathVector<2> ReferenceElementCenter<2>(ReferenceObjectID roid)
74 {
75  switch(roid)
76  {
77  case ROID_TRIANGLE: return MathVector<2>(1.0/3.0, 1.0/3.0);
78  case ROID_QUADRILATERAL: return MathVector<2>(0.5, 0.5);
79  default: UG_THROW("ReferenceObject "<<roid<<" not found in dim 2.");
80  }
81 }
82 
83 template <>
84 inline MathVector<3> ReferenceElementCenter<3>(ReferenceObjectID roid)
85 {
86  switch(roid)
87  {
88  case ROID_TETRAHEDRON: return MathVector<3>(0.25, 0.25, 0.25);
89  case ROID_PYRAMID: return MathVector<3>(2./5., 2./5., 1./5.);
90  case ROID_PRISM: return MathVector<3>(2./6., 2./6., 0.5);
91  case ROID_HEXAHEDRON: return MathVector<3>(0.5, 0.5, 0.5);
92  case ROID_OCTAHEDRON: return MathVector<3>(2./6., 2./6., 0.0);
93  default: UG_THROW("ReferenceObject "<<roid<<" not found in dim 3.");
94  }
95 }
96 
97 
98 } // end namespace ug
99 
100 #endif /* __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_ELEMENT_UTIL__ */
#define UG_THROW(msg)
Definition: error.h:57
the ug namespace
MathVector< 1 > ReferenceElementCenter< 1 >(ReferenceObjectID roid)
Definition: reference_element_util.h:63
ReferenceObjectID
these ids are used to identify the shape of a geometric object.
Definition: grid_base_objects.h:74
@ ROID_TETRAHEDRON
Definition: grid_base_objects.h:80
@ ROID_QUADRILATERAL
Definition: grid_base_objects.h:79
@ ROID_PYRAMID
Definition: grid_base_objects.h:83
@ ROID_PRISM
Definition: grid_base_objects.h:82
@ ROID_EDGE
Definition: grid_base_objects.h:77
@ ROID_OCTAHEDRON
Definition: grid_base_objects.h:84
@ ROID_HEXAHEDRON
Definition: grid_base_objects.h:81
@ ROID_TRIANGLE
Definition: grid_base_objects.h:78
@ ROID_VERTEX
Definition: grid_base_objects.h:76
MathVector< 2 > ReferenceElementCenter< 2 >(ReferenceObjectID roid)
Definition: reference_element_util.h:73
int ReferenceElementDimension(ReferenceObjectID roid)
returns the reference element dimension at run-time
Definition: reference_element_util.h:40
MathVector< dim > ReferenceElementCenter(ReferenceObjectID roid)
returns the Center of a reference element at run-time
MathVector< 3 > ReferenceElementCenter< 3 >(ReferenceObjectID roid)
Definition: reference_element_util.h:84