https://mooseframework.inl.gov
ElementQualityChecker.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ElementQualityChecker.h"
11 #include "MooseError.h"
12 #include "Conversion.h"
13 
14 #include "libmesh/elem_quality.h"
15 #include "libmesh/enum_elem_quality.h"
16 #include "libmesh/string_to_enum.h"
17 
20 {
21  return MooseEnum("ASPECT_RATIO SKEW SHEAR SHAPE MAX_ANGLE MIN_ANGLE CONDITION DISTORTION TAPER "
22  "WARP STRETCH DIAGONAL ASPECT_RATIO_BETA ASPECT_RATIO_GAMMA SIZE JACOBIAN");
23 }
24 
27 {
28  return MooseEnum("WARNING ERROR", "WARNING");
29 }
30 
32 
35 {
37  params.addClassDescription("Class to check the quality of each element using different metrics "
38  "from libmesh.");
39 
40  params.addRequiredParam<MooseEnum>("metric_type",
42  "Type of quality metric to be checked");
43  params.addParam<Real>("upper_bound", "The upper bound for provided metric type");
44  params.addParam<Real>("lower_bound", "The lower bound for provided metric type");
45  params.addParam<bool>("suppress_invalid_metric_warning",
46  false,
47  "Whether to print the warning related to the quality metric type not being "
48  "applicable to a given element type.");
49  params.addParam<MooseEnum>("failure_type",
51  "The way how the failure of quality metric check should respond");
52  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
53 
54  return params;
55 }
56 
58  : ElementUserObject(parameters),
59  _m_type(getParam<MooseEnum>("metric_type").getEnum<libMesh::ElemQuality>()),
60  _has_upper_bound(isParamValid("upper_bound")),
61  _has_lower_bound(isParamValid("lower_bound")),
62  _upper_bound(_has_upper_bound ? getParam<Real>("upper_bound") : 0.0),
63  _lower_bound(_has_lower_bound ? getParam<Real>("lower_bound") : 0.0),
64  _m_min(0),
65  _m_max(0),
66  _m_sum(0),
67  _suppress_invalid_metric_warning(getParam<bool>("suppress_invalid_metric_warning")),
68  _failure_type(getParam<MooseEnum>("failure_type").getEnum<FailureType>())
69 {
70 }
71 
72 void
74 {
75  _m_min = 0;
76  _m_max = 0;
77  _m_sum = 0;
79  _elem_ids.clear();
80  _bypassed = false;
81  _bypassed_elem_type.clear();
82 }
83 
84 void
86 {
87  // obtain the available quality metric for current ElemType
88  std::vector<libMesh::ElemQuality> metrics_avail = libMesh::Quality::valid(_current_elem->type());
89 
90  // check whether the provided quality metric is applicable to current ElemType
91  if (!checkMetricApplicability(_m_type, metrics_avail))
92  {
93  _bypassed = true;
94  _bypassed_elem_type.insert(Utility::enum_to_string(_current_elem->type()));
95 
96  return;
97  }
98 
99  std::pair<Real, Real> default_bounds = _current_elem->qual_bounds(_m_type);
100  std::pair<Real, Real> actual_bounds;
102  {
103  if (_lower_bound >= _upper_bound)
104  mooseError("Provided lower bound should be less than provided upper bound!");
105 
106  actual_bounds = std::make_pair(_lower_bound, _upper_bound);
107  }
108  else if (_has_lower_bound)
109  {
110  if (_lower_bound >= default_bounds.second)
111  mooseError("Provided lower bound should less than the default upper bound: ",
112  default_bounds.second);
113 
114  actual_bounds = std::make_pair(_lower_bound, default_bounds.second);
115  }
116  else if (_has_upper_bound)
117  {
118  if (_upper_bound <= default_bounds.first)
119  mooseError("Provided upper bound should larger than the default lower bound: ",
120  default_bounds.first);
121 
122  actual_bounds = std::make_pair(default_bounds.first, _upper_bound);
123  }
124  else
125  actual_bounds = default_bounds;
126 
127  // calculate and save quality metric value for current element
128  Real mv = _current_elem->quality(_m_type);
129 
130  _checked_elem_num += 1;
131  _m_sum += mv;
132  if (mv > _m_max)
133  _m_max = mv;
134  else if (mv < _m_min)
135  _m_min = mv;
136 
137  // check element quality metric, save ids of elements whose quality metrics exceeds the preset
138  // bounds
139  if (mv < actual_bounds.first || mv > actual_bounds.second)
140  _elem_ids.insert(_current_elem->id());
141 }
142 
143 void
145 {
146  const auto & eqc = static_cast<const ElementQualityChecker &>(uo);
147  _elem_ids.insert(eqc._elem_ids.begin(), eqc._elem_ids.end());
148  _bypassed_elem_type.insert(eqc._bypassed_elem_type.begin(), eqc._bypassed_elem_type.end());
149  _bypassed |= eqc._bypassed;
150  _m_sum += eqc._m_sum;
151  _checked_elem_num += eqc._checked_elem_num;
152 
153  if (_m_min > eqc._m_min)
154  _m_min = eqc._m_min;
155  if (_m_max < eqc._m_max)
156  _m_max = eqc._m_max;
157 }
158 
159 void
161 {
169 
170  if (_bypassed)
172  mooseWarning("Provided quality metric doesn't apply to following element type: " +
174 
175  _console << libMesh::Quality::name(_m_type) << " Metric values:"
176  << "\n";
177  _console << " Minimum: " << _m_min << "\n";
178  _console << " Maximum: " << _m_max << "\n";
179  _console << " Average: " << _m_sum / _checked_elem_num << "\n";
180 
181  if (!_elem_ids.empty())
182  {
183  switch (_failure_type)
184  {
186  {
187  mooseWarning("List of failed element IDs: ", Moose::stringify(_elem_ids));
188  break;
189  }
190 
191  case FailureType::ERROR:
192  {
193  mooseError("List of failed element IDs: ", Moose::stringify(_elem_ids));
194  break;
195  }
196 
197  default:
198  mooseError("Unknown failure type!");
199  }
200  }
201 
202  _console << std::flush;
203 }
204 
205 bool
207  const libMesh::ElemQuality & elem_metric,
208  const std::vector<libMesh::ElemQuality> & elem_metrics)
209 {
210  bool has_metric = false;
211 
212  for (unsigned int i = 0; i < elem_metrics.size(); ++i)
213  if (elem_metric == elem_metrics[i])
214  has_metric = true;
215 
216  return has_metric;
217 }
std::string name(const ElemQuality q)
void initialize() override
Called before execute() is ever called so that data can be cleared.
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:21
const FailureType _failure_type
void execute() override
Execute method.
std::set< dof_id_type > _elem_ids
set to save ids for all failed elements
static InputParameters validParams()
unsigned int _checked_elem_num
number of checked elements
bool checkMetricApplicability(const libMesh::ElemQuality &elem_metric, const std::vector< libMesh::ElemQuality > &elem_metrics)
void finalize() override
Finalize.
registerMooseObject("MooseApp", ElementQualityChecker)
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const Parallel::Communicator & _communicator
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
void mooseWarning(Args &&... args) const
Emits a warning prefixed with object name and type.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
static InputParameters validParams()
bool _bypassed
whether the element quality check is bypassed or not
void min(const T &r, T &o, Request &req) const
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:33
static MooseEnum FailureMessageType()
ElemQuality
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:64
void threadJoin(const UserObject &uo) override
Must override.
Real _m_min
minimum, maximum and summation of quality metric values of all checked elements
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
ElementQualityChecker(const InputParameters &parameters)
const Elem *const & _current_elem
The current element pointer (available during execute())
void max(const T &r, T &o, Request &req) const
static MooseEnum QualityMetricType()
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...
std::set< std::string > _bypassed_elem_type
set to save bypassed element type
libMesh::ElemQuality _m_type
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
const bool _suppress_invalid_metric_warning
Whether to print element applicability warning for bypassed elements.
std::vector< ElemQuality > valid(const ElemType t)
Base class for user-specific data.
Definition: UserObject.h:40
void set_union(T &data, const unsigned int root_id) const
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:28