libMesh
Functions | Variables
libMesh::Quality Namespace Reference

A namespace for quality utility functions. More...

Functions

std::string name (const ElemQuality q)
 This function returns a string containing some name for q. More...
 
std::string describe (const ElemQuality q)
 This function returns a string containing a short description of q. More...
 
std::vector< ElemQuality > valid (const ElemType t)
 

Variables

const unsigned int num_quals = 16
 The number of element quality types we have defined. More...
 

Detailed Description

A namespace for quality utility functions.

Author
John W. Peterson
Date
2002 Utility functions for computing element quality indicators.

Function Documentation

◆ describe()

std::string libMesh::Quality::describe ( const ElemQuality  q)

This function returns a string containing a short description of q.

Returns
A description for a ElemQuality enum

Useful for asking the enum what it computes.

Definition at line 142 of file elem_quality.C.

References libMesh::ASPECT_RATIO, libMesh::ASPECT_RATIO_BETA, libMesh::ASPECT_RATIO_GAMMA, libMesh::CONDITION, libMesh::DIAGONAL, libMesh::DISTORTION, libMesh::EDGE_LENGTH_RATIO, libMesh::JACOBIAN, libMesh::MAX_ANGLE, libMesh::MAX_DIHEDRAL_ANGLE, libMesh::MIN_ANGLE, libMesh::MIN_DIHEDRAL_ANGLE, libMesh::SCALED_JACOBIAN, libMesh::SHAPE, libMesh::SHEAR, libMesh::SIZE, libMesh::SKEW, libMesh::STRETCH, libMesh::TAPER, and libMesh::WARP.

143 {
144 
145  std::ostringstream desc;
146 
147  switch (q)
148  {
149 
150  case EDGE_LENGTH_RATIO:
151  case ASPECT_RATIO:
152  desc << "Max edge length ratio\n"
153  << "at element center.\n"
154  << '\n'
155  << "Suggested ranges:\n"
156  << "Hexes: (1 -> 4)\n"
157  << "Quads: (1 -> 4)";
158  break;
159 
160  case SKEW:
161  desc << "Maximum |cos A|, where A\n"
162  << "is the angle between edges\n"
163  << "at element center.\n"
164  << '\n'
165  << "Suggested ranges:\n"
166  << "Hexes: (0 -> 0.5)\n"
167  << "Quads: (0 -> 0.5)";
168  break;
169 
170  case SHEAR:
171  desc << "LIBMESH_DIM / K(Js)\n"
172  << '\n'
173  << "LIBMESH_DIM = element dimension.\n"
174  << "K(Js) = Condition number of \n"
175  << " Jacobian skew matrix.\n"
176  << '\n'
177  << "Suggested ranges:\n"
178  << "Hexes(LIBMESH_DIM=3): (0.3 -> 1)\n"
179  << "Quads(LIBMESH_DIM=2): (0.3 -> 1)";
180  break;
181 
182  case SHAPE:
183  desc << "LIBMESH_DIM / K(Jw)\n"
184  << '\n'
185  << "LIBMESH_DIM = element dimension.\n"
186  << "K(Jw) = Condition number of \n"
187  << " weighted Jacobian\n"
188  << " matrix.\n"
189  << '\n'
190  << "Suggested ranges:\n"
191  << "Hexes(LIBMESH_DIM=3): (0.3 -> 1)\n"
192  << "Tets(LIBMESH_DIM=3): (0.2 -> 1)\n"
193  << "Quads(LIBMESH_DIM=2): (0.3 -> 1).";
194  break;
195 
196  case MAX_ANGLE:
197  desc << "Largest angle between all adjacent pairs of edges (in 2D, sides).\n"
198  << '\n'
199  << "Suggested ranges:\n"
200  << "Quads: (90 -> 135)\n"
201  << "Triangles: (60 -> 90)";
202  break;
203 
204  case MIN_ANGLE:
205  desc << "Smallest angle between all adjacent pairs of edges (in 2D, sides).\n"
206  << '\n'
207  << "Suggested ranges:\n"
208  << "Quads: (45 -> 90)\n"
209  << "Triangles: (30 -> 60)";
210  break;
211 
212  case MAX_DIHEDRAL_ANGLE:
213  desc << "Largest angle between all adjacent pairs of sides (in 2D, equivalent to MAX_ANGLE).\n"
214  << '\n'
215  << "Suggested ranges:\n"
216  << "Quads: (90 -> 135)\n"
217  << "Triangles: (60 -> 90)";
218  break;
219 
220  case MIN_DIHEDRAL_ANGLE:
221  desc << "Smallest angle between all adjacent pairs of sides (in 2D, equivalent to MIN_ANGLE).\n"
222  << '\n'
223  << "Suggested ranges:\n"
224  << "Quads: (45 -> 90)\n"
225  << "Triangles: (30 -> 60)";
226  break;
227 
228  case CONDITION:
229  desc << "Condition number of the\n"
230  << "Jacobian matrix.\n"
231  << '\n'
232  << "Suggested ranges:\n"
233  << "Quads: (1 -> 4)\n"
234  << "Hexes: (1 -> 8)\n"
235  << "Tris: (1 -> 1.3)\n"
236  << "Tets: (1 -> 3)";
237  break;
238 
239  case DISTORTION:
240  desc << "min |J| * A / <A>\n"
241  << '\n'
242  << "|J| = norm of Jacobian matrix\n"
243  << " A = actual area\n"
244  << "<A> = reference area\n"
245  << '\n'
246  << "Suggested ranges:\n"
247  << "Quads: (0.6 -> 1), <A>=4\n"
248  << "Hexes: (0.6 -> 1), <A>=8\n"
249  << "Tris: (0.6 -> 1), <A>=1/2\n"
250  << "Tets: (0.6 -> 1), <A>=1/6";
251  break;
252 
253  case TAPER:
254  desc << "Maximum ratio of lengths\n"
255  << "derived from opposite edges.\n"
256  << '\n'
257  << "Suggested ranges:\n"
258  << "Quads: (0.7 -> 1)\n"
259  << "Hexes: (0.4 -> 1)";
260  break;
261 
262  case WARP:
263  desc << "cos D\n"
264  << '\n'
265  << "D = minimum dihedral angle\n"
266  << " formed by diagonals.\n"
267  << '\n'
268  << "Suggested ranges:\n"
269  << "Quads: (0.9 -> 1)";
270  break;
271 
272  case STRETCH:
273  desc << "Sqrt(3) * L_min / L_max\n"
274  << '\n'
275  << "L_min = minimum edge length.\n"
276  << "L_max = maximum edge length.\n"
277  << '\n'
278  << "Suggested ranges:\n"
279  << "Quads: (0.25 -> 1)\n"
280  << "Hexes: (0.25 -> 1)";
281  break;
282 
283  case DIAGONAL:
284  desc << "D_min / D_max\n"
285  << '\n'
286  << "D_min = minimum diagonal.\n"
287  << "D_max = maximum diagonal.\n"
288  << '\n'
289  << "Suggested ranges:\n"
290  << "Hexes: (0.65 -> 1)";
291  break;
292 
293  case ASPECT_RATIO_BETA:
294  desc << "CR / (3 * IR)\n"
295  << '\n'
296  << "CR = circumsphere radius\n"
297  << "IR = inscribed sphere radius\n"
298  << '\n'
299  << "Suggested ranges:\n"
300  << "Tets: (1 -> 3)";
301  break;
302 
303  case ASPECT_RATIO_GAMMA:
304  desc << "S^(3/2) / 8.479670 * V\n"
305  << '\n'
306  << "S = sum(si*si/6)\n"
307  << "si = edge length\n"
308  << "V = volume\n"
309  << '\n'
310  << "Suggested ranges:\n"
311  << "Tets: (1 -> 3)";
312  break;
313 
314  case SIZE:
315  desc << "min (|J|, |1/J|)\n"
316  << '\n'
317  << "|J| = norm of Jacobian matrix.\n"
318  << '\n'
319  << "Suggested ranges:\n"
320  << "Quads: (0.3 -> 1)\n"
321  << "Hexes: (0.5 -> 1)\n"
322  << "Tris: (0.25 -> 1)\n"
323  << "Tets: (0.2 -> 1)";
324  break;
325 
326  case JACOBIAN:
327  case SCALED_JACOBIAN:
328  desc << "Minimum nodal Jacobian.\n"
329  << "The nodal Jacobians are computed by taking the cross product (2D) or scalar product (3D) of the adjacent edges that meet at that node.\n"
330  << "In the SCALED_JACOBIAN case, we also then divide by the lengths of each of the associated edges.\n"
331  << "For Pyramid elements where four edges meet at the apex node, special handling is required.\n"
332  << '\n'
333  << "Suggested acceptable ranges (from Cubit documentation) for SCALED_JACOBIAN metric:\n"
334  << "Quads/Hexes: (0.5 -> 1)\n"
335  << "Tris/Tets: (0.2 -> 1.0)";
336  break;
337 
338  default:
339  desc << "Unknown";
340  break;
341  }
342 
343  return desc.str();
344 }

◆ name()

std::string libMesh::Quality::name ( const ElemQuality  q)

This function returns a string containing some name for q.

Returns
A descriptive name for a ElemQuality enum

Useful for asking the enum what its name is. I added this since you may want a simple way to attach a name or description to the ElemQuality enums. It can be removed if it is found to be useless.

Definition at line 42 of file elem_quality.C.

References libMesh::ASPECT_RATIO, libMesh::ASPECT_RATIO_BETA, libMesh::ASPECT_RATIO_GAMMA, libMesh::CONDITION, libMesh::DIAGONAL, libMesh::DISTORTION, libMesh::JACOBIAN, libMesh::MAX_ANGLE, libMesh::MAX_DIHEDRAL_ANGLE, libMesh::MIN_ANGLE, libMesh::MIN_DIHEDRAL_ANGLE, libMesh::SCALED_JACOBIAN, libMesh::SHAPE, libMesh::SHEAR, libMesh::SIZE, libMesh::SKEW, libMesh::STRETCH, libMesh::TAPER, and libMesh::WARP.

Referenced by GETPOT_NAMESPACE::GetPot::_convert_to_type_no_default(), libMesh::add_command_line_name(), libMesh::add_command_line_names(), libMesh::MeshBase::add_elem_integer(), libMesh::MeshBase::add_elem_integers(), libMesh::MeshBase::add_node_integer(), libMesh::MeshBase::add_node_integers(), libMesh::EquationSystems::add_system(), libMesh::Factory< Base >::build(), libMesh::cast_ptr(), libMesh::cast_ref(), libMesh::ExodusII_IO_Helper::check_existing_vars(), libMesh::command_line_next(), libMesh::command_line_value(), libMesh::command_line_vector(), libMesh::ElemCutter::cut_3D(), libMesh::demangle(), DMlibMeshSetUpName_Private(), DMView_libMesh(), libMesh::Factory< Base >::Factory(), libMesh::EquationSystems::find_variable_numbers(), libMesh::Parameters::get(), libMesh::ExodusII_IO_Helper::get_complex_names(), libMesh::MeshBase::get_elem_integer_index(), libMesh::BoundaryInfo::get_id_by_name(), libMesh::MeshBase::get_id_by_name(), libMesh::ReferenceCounter::get_info(), libMesh::MeshBase::get_info(), libMesh::MeshBase::get_node_integer_index(), libMesh::EquationSystems::get_system(), libMesh::MeshBase::has_elem_integer(), libMesh::MeshBase::has_node_integer(), libMesh::EquationSystems::has_system(), libMesh::Parameters::have_parameter(), libMesh::ReferenceCounter::increment_constructor_count(), libMesh::ReferenceCounter::increment_destructor_count(), libMesh::PetscNonlinearSolver< Number >::init(), libMesh::PetscLinearSolver< Number >::init(), libMesh::RBParametrized::initialize_parameters(), libMesh::Parameters::insert(), libMesh::NameBasedIO::is_parallel_file_format(), main(), libMesh::VTKIO::node_values_to_vtk(), libMesh::Xdr::open(), GETPOT_NAMESPACE::GetPot::variable::operator=(), libMesh::RBParametrized::print_discrete_parameter_values(), libMesh::PetscMatrix< T >::print_matlab(), libMesh::PetscVector< libMesh::Number >::print_matlab(), libMesh::SparseMatrix< ValOut >::print_matlab(), libMesh::ExodusII_IO_Helper::NamesData::push_back_entry(), FEMParameters::read(), libMesh::OFFIO::read(), libMesh::NameBasedIO::read(), libMesh::TetGenIO::read(), libMesh::GMVIO::read(), libMesh::PltLoader::read(), libMesh::Nemesis_IO::read(), libMesh::GmshIO::read(), libMesh::DynaIO::read(), libMesh::MatlabIO::read(), libMesh::ExodusII_IO::read(), libMesh::VTKIO::read(), libMesh::UnstructuredMesh::read(), libMesh::EquationSystems::read(), libMesh::CheckpointIO::read_header(), libMesh::PltLoader::read_header(), libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject(), libMesh::Parameters::remove(), libMesh::Parameters::set(), libMesh::Parameters::Parameter< T >::type(), libMesh::Utility::unzip_file(), libMesh::NameBasedIO::write(), libMesh::GmshIO::write(), libMesh::EnsightIO::write(), libMesh::UnstructuredMesh::write(), libMesh::CheckpointIO::write(), libMesh::EquationSystems::write(), libMesh::CheckpointIO::write_bc_names(), libMesh::PltLoader::write_dat(), libMesh::GMVIO::write_discontinuous_gmv(), libMesh::ExodusII_IO::write_element_data_from_discontinuous_nodal_data(), libMesh::EnsightIO::write_geometry_ascii(), libMesh::NameBasedIO::write_nodal_data(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), libMesh::XdrIO::write_serialized_bc_names(), libMesh::XdrIO::write_serialized_subdomain_names(), libMesh::UCDIO::write_soln(), libMesh::CheckpointIO::write_subdomain_names(), libMesh::LibMeshInit::~LibMeshInit(), and libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

43 {
44  std::string its_name;
45 
46  switch (q)
47  {
48 
49  case ASPECT_RATIO:
50  its_name = "Aspect Ratio";
51  break;
52 
53  case SKEW:
54  its_name = "Skew";
55  break;
56 
57  case SHEAR:
58  its_name = "Shear";
59  break;
60 
61  case SHAPE:
62  its_name = "Shape";
63  break;
64 
65  case MAX_ANGLE:
66  its_name = "Maximum Angle";
67  break;
68 
69  case MIN_ANGLE:
70  its_name = "Minimum Angle";
71  break;
72 
73  case MAX_DIHEDRAL_ANGLE:
74  its_name = "Maximum Dihedral Angle";
75  break;
76 
77  case MIN_DIHEDRAL_ANGLE:
78  its_name = "Minimum Dihedral Angle";
79  break;
80 
81  case CONDITION:
82  its_name = "Condition Number";
83  break;
84 
85  case DISTORTION:
86  its_name = "Distortion";
87  break;
88 
89  case TAPER:
90  its_name = "Taper";
91  break;
92 
93  case WARP:
94  its_name = "Warp";
95  break;
96 
97  case STRETCH:
98  its_name = "Stretch";
99  break;
100 
101  case DIAGONAL:
102  its_name = "Diagonal";
103  break;
104 
105  case ASPECT_RATIO_BETA:
106  its_name = "AR Beta";
107  break;
108 
109  case ASPECT_RATIO_GAMMA:
110  its_name = "AR Gamma";
111  break;
112 
113  case SIZE:
114  its_name = "Size";
115  break;
116 
117  case JACOBIAN:
118  its_name = "Jacobian";
119  break;
120 
121  case SCALED_JACOBIAN:
122  its_name = "Scaled Jacobian";
123  break;
124 
125  default:
126  its_name = "Unknown";
127  break;
128  }
129 
130  return its_name;
131 }

◆ valid()

std::vector< ElemQuality > libMesh::Quality::valid ( const ElemType  t)
Returns
The "valid" ElemQuality metrics for a given ElemType element type. Valid metrics are those which have Elem::qual_bounds() defined. Not all "valid" metrics are actually implemented in the code.

Definition at line 347 of file elem_quality.C.

References libMesh::ASPECT_RATIO, libMesh::ASPECT_RATIO_BETA, libMesh::ASPECT_RATIO_GAMMA, libMesh::CONDITION, libMesh::DIAGONAL, libMesh::DISTORTION, libMesh::EDGE2, libMesh::EDGE3, libMesh::EDGE4, libMesh::EDGE_LENGTH_RATIO, libMesh::HEX20, libMesh::HEX27, libMesh::HEX8, libMesh::INFEDGE2, libMesh::INFHEX16, libMesh::INFHEX18, libMesh::INFHEX8, libMesh::INFPRISM12, libMesh::INFPRISM6, libMesh::INFQUAD4, libMesh::INFQUAD6, libMesh::JACOBIAN, libMesh::MAX_ANGLE, libMesh::MAX_DIHEDRAL_ANGLE, libMesh::MIN_ANGLE, libMesh::MIN_DIHEDRAL_ANGLE, libMesh::PRISM18, libMesh::PRISM20, libMesh::PRISM21, libMesh::PRISM6, libMesh::PYRAMID13, libMesh::PYRAMID14, libMesh::PYRAMID18, libMesh::PYRAMID5, libMesh::QUAD4, libMesh::QUAD8, libMesh::QUAD9, libMesh::QUADSHELL4, libMesh::QUADSHELL8, libMesh::QUADSHELL9, libMesh::SCALED_JACOBIAN, libMesh::SHAPE, libMesh::SHEAR, libMesh::SIZE, libMesh::SKEW, libMesh::STRETCH, libMesh::TAPER, libMesh::TET10, libMesh::TET14, libMesh::TET4, libMesh::TRI3, libMesh::TRI6, libMesh::TRI7, libMesh::TRISHELL3, and libMesh::WARP.

348 {
349  std::vector<ElemQuality> v;
350 
351  switch (t)
352  {
353  case EDGE2:
354  case EDGE3:
355  case EDGE4:
356  {
357  // None yet
358  break;
359  }
360 
361  case TRI3:
362  case TRISHELL3:
363  case TRI6:
364  case TRI7:
365  {
366  v = {
367  CONDITION,
368  DISTORTION,
369  EDGE_LENGTH_RATIO,
370  JACOBIAN,
371  SCALED_JACOBIAN,
372  MAX_ANGLE,
373  MIN_ANGLE,
374  MAX_DIHEDRAL_ANGLE,
375  MIN_DIHEDRAL_ANGLE,
376  SHAPE,
377  SIZE
378  };
379 
380  break;
381  }
382 
383  case QUAD4:
384  case QUADSHELL4:
385  case QUAD8:
386  case QUADSHELL8:
387  case QUAD9:
388  case QUADSHELL9:
389  {
390  v = {
391  ASPECT_RATIO,
392  CONDITION,
393  DISTORTION,
394  EDGE_LENGTH_RATIO,
395  JACOBIAN,
396  SCALED_JACOBIAN,
397  MAX_ANGLE,
398  MIN_ANGLE,
399  MAX_DIHEDRAL_ANGLE,
400  MIN_DIHEDRAL_ANGLE,
401  SHAPE,
402  SHEAR,
403  SIZE,
404  SKEW,
405  STRETCH,
406  TAPER,
407  WARP
408  };
409 
410  break;
411  }
412 
413  case TET4:
414  case TET10:
415  case TET14:
416  {
417  v = {
418  ASPECT_RATIO_BETA,
419  ASPECT_RATIO_GAMMA,
420  CONDITION,
421  DISTORTION,
422  JACOBIAN,
423  SCALED_JACOBIAN,
424  MAX_ANGLE,
425  MIN_ANGLE,
426  MAX_DIHEDRAL_ANGLE,
427  MIN_DIHEDRAL_ANGLE,
428  SHAPE,
429  SIZE
430  };
431 
432  break;
433  }
434 
435  case HEX8:
436  case HEX20:
437  case HEX27:
438  {
439  v = {
440  ASPECT_RATIO,
441  CONDITION,
442  DIAGONAL,
443  DISTORTION,
444  JACOBIAN,
445  SCALED_JACOBIAN,
446  MAX_ANGLE,
447  MIN_ANGLE,
448  MAX_DIHEDRAL_ANGLE,
449  MIN_DIHEDRAL_ANGLE,
450  SHAPE,
451  SHEAR,
452  SIZE,
453  SKEW,
454  STRETCH,
455  TAPER
456  };
457 
458  break;
459  }
460 
461  case PRISM6:
462  case PRISM18:
463  case PRISM20:
464  case PRISM21:
465  {
466  v = {
467  EDGE_LENGTH_RATIO,
468  MAX_ANGLE,
469  MIN_ANGLE,
470  MAX_DIHEDRAL_ANGLE,
471  MIN_DIHEDRAL_ANGLE,
472  };
473 
474  break;
475  }
476 
477  case PYRAMID5:
478  case PYRAMID13:
479  case PYRAMID14:
480  case PYRAMID18:
481  {
482  v = {
483  EDGE_LENGTH_RATIO,
484  MAX_ANGLE,
485  MIN_ANGLE,
486  MAX_DIHEDRAL_ANGLE,
487  MIN_DIHEDRAL_ANGLE,
488  };
489 
490  break;
491  }
492 
493 
494 
495 #ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
496 
497  case INFEDGE2:
498  {
499  // None yet
500  break;
501  }
502 
503  case INFQUAD4:
504  case INFQUAD6:
505  case INFHEX8:
506  case INFHEX16:
507  case INFHEX18:
508  case INFPRISM6:
509  case INFPRISM12:
510  {
511  v = {
512  MAX_ANGLE,
513  MIN_ANGLE,
514  MAX_DIHEDRAL_ANGLE,
515  MIN_DIHEDRAL_ANGLE,
516  };
517 
518  break;
519  }
520 
521 #endif
522 
523 
524  default:
525  libmesh_error_msg("Undefined element type!");
526  }
527 
528  return v;
529 }

Variable Documentation

◆ num_quals

const unsigned int libMesh::Quality::num_quals = 16

The number of element quality types we have defined.

This needs to be updated if you add one.

Definition at line 48 of file elem_quality.h.

Generated on Wed Jul 16 2025 13:54:28 for libMesh by   doxygen 1.8.14