Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ElementConfig.h
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ElementConfig.h
4 //
5 // For more information, please see: http://www.nektar.info/
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Mesh elementconfig.
33 //
34 ////////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKMESHUTILS_MESHELEMENTS_ELEMENTCONFIG
37 #define NEKMESHUTILS_MESHELEMENTS_ELEMENTCONFIG
38 
39 namespace Nektar
40 {
41 namespace NekMeshUtils
42 {
43 
44 /**
45  * @brief Basic information about an element.
46  *
47  * ElmtConfig contains four member variables which denote the
48  * properties of an element when it is created.
49  */
50 struct ElmtConfig
51 {
53  unsigned int pOrder,
54  bool pFn,
55  bool pVn,
56  bool pReorient = true,
59  : m_e(pE), m_faceNodes(pFn), m_volumeNodes(pVn), m_order(pOrder),
60  m_reorient(pReorient), m_edgeCurveType(pECt), m_faceCurveType(pFCt)
61  {
62  }
63 
65  : m_e(p.m_e), m_faceNodes(p.m_faceNodes),
69  {
70  }
71 
73  {
74  }
75 
76  /// Element type (e.g. triangle, quad, etc).
78  /// Denotes whether the element contains face nodes. For 2D elements, if
79  /// this is true then the element contains interior nodes.
81  /// Denotes whether the element contains volume (i.e. interior) nodes. These
82  /// are not supported by either the mesh converter or Nektar++ but are
83  /// included for completeness and are required for some output modules
84  /// (e.g. Gmsh).
86  /// Order of the element.
87  unsigned int m_order;
88  /// Denotes whether the element needs to be re-orientated for a spectral
89  /// element framework.
90  bool m_reorient;
91  /// Distribution of points in edges.
93  /// Distribution of points in faces.
95 };
96 
97 NEKMESHUTILS_EXPORT bool operator==(ElmtConfig const &c1, ElmtConfig const &c2);
98 
99 }
100 }
101 #endif
bool m_faceNodes
Denotes whether the element contains face nodes. For 2D elements, if this is true then the element co...
Definition: ElementConfig.h:80
Basic information about an element.
Definition: ElementConfig.h:50
LibUtilities::PointsType m_faceCurveType
Distribution of points in faces.
Definition: ElementConfig.h:94
ElmtConfig(ElmtConfig const &p)
Definition: ElementConfig.h:64
bool operator==(ElmtConfig const &c1, ElmtConfig const &c2)
Compares two element config structs.
LibUtilities::PointsType m_edgeCurveType
Distribution of points in edges.
Definition: ElementConfig.h:92
unsigned int m_order
Order of the element.
Definition: ElementConfig.h:87
1D Evenly-spaced points using Lagrange polynomial
Definition: PointsType.h:65
bool m_volumeNodes
Denotes whether the element contains volume (i.e. interior) nodes. These are not supported by either ...
Definition: ElementConfig.h:85
ElmtConfig(LibUtilities::ShapeType pE, unsigned int pOrder, bool pFn, bool pVn, bool pReorient=true, LibUtilities::PointsType pECt=LibUtilities::ePolyEvenlySpaced, LibUtilities::PointsType pFCt=LibUtilities::ePolyEvenlySpaced)
Definition: ElementConfig.h:52
#define NEKMESHUTILS_EXPORT
bool m_reorient
Denotes whether the element needs to be re-orientated for a spectral element framework.
Definition: ElementConfig.h:90
LibUtilities::ShapeType m_e
Element type (e.g. triangle, quad, etc).
Definition: ElementConfig.h:77