1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2020 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17 
18 
19 
20 #ifndef LIBMESH_REFERENCE_ELEM_H
21 #define LIBMESH_REFERENCE_ELEM_H
22 
23 // Local includes
24 #include "libmesh/libmesh_common.h"
25 
26 #ifdef LIBMESH_FORWARD_DECLARE_ENUMS
27 namespace libMesh
28 {
29 enum ElemType : int;
30 }
31 #else
32 #include "libmesh/enum_elem_type.h"
33 #endif
34 
35 namespace libMesh
36 {
37 
38 // forward declarations
39 class Elem;
40 
41 /**
42  * This namespace implements singleton reference elements for each
43  * fundamental element type supported by \p libMesh.
44  *
45  * \author Benjamin S. Kirk
46  * \date 2013
47  * \brief Namespace providing access to reference geometric element types.
48  */
49 namespace ReferenceElem
50 {
51 /**
52  * \returns A constant reference to the reference element of
53  * the user-requested type.
54  */
55 const Elem & get (const ElemType type_in);
56 
57 } // namespace ReferenceElem
58 
59 
60 } // namespace libMesh
61 
62 
63 #endif // LIBMESH_REFERENCE_ELEM_H
64