libMesh
elem_quality.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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_ELEM_QUALITY_H
21 #define LIBMESH_ELEM_QUALITY_H
22 
23 // Local includes
24 #include "libmesh/enum_elem_type.h"
25 #include "libmesh/enum_elem_quality.h"
26 
27 // C++ includes
28 #include <vector>
29 #include <string>
30 
31 namespace libMesh
32 {
33 
41 namespace Quality
42 {
48 const unsigned int num_quals = 16;
49 
54 std::string name (const ElemQuality q);
55 
60 std::string describe (const ElemQuality q);
61 
66 std::vector<ElemQuality> valid (const ElemType t);
67 }
68 
69 } // namespace libMesh
70 
71 #endif // LIBMESH_ELEM_QUALITY_H
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
ElemType
Defines an enum for geometric element types.
std::string describe(const ElemQuality q)
This function returns a string containing a short description of q.
Definition: elem_quality.C:127
The libMesh namespace provides an interface to certain functionality in the library.
const unsigned int num_quals
The number of element quality types we have defined.
Definition: elem_quality.h:48
ElemQuality
Defines an enum for element quality metrics.
std::vector< ElemQuality > valid(const ElemType t)
Returns all valid quality metrics for element type t.
Definition: elem_quality.C:321