www.mooseframework.org
ElementQualityChecker.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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<MooseEnum>("failure_type",
47  "The way how the failure of quality metric check should respond");
48  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
49 
50  return params;
51 }
52 
54  : ElementUserObject(parameters),
55  _m_type(getParam<MooseEnum>("metric_type").getEnum<ElemQuality>()),
56  _has_upper_bound(isParamValid("upper_bound")),
57  _has_lower_bound(isParamValid("lower_bound")),
58  _upper_bound(_has_upper_bound ? getParam<Real>("upper_bound") : 0.0),
59  _lower_bound(_has_lower_bound ? getParam<Real>("lower_bound") : 0.0),
60  _m_min(0),
61  _m_max(0),
62  _m_sum(0),
63  _failure_type(getParam<MooseEnum>("failure_type").getEnum<FailureType>())
64 {
65 }
66 
67 void
69 {
70  _m_min = 0;
71  _m_max = 0;
72  _m_sum = 0;
74  _elem_ids.clear();
75  _bypassed = false;
76  _bypassed_elem_type.clear();
77 }
78 
79 void
81 {
82  // obtain the available quality metric for current ElemType
83  std::vector<ElemQuality> metrics_avail = libMesh::Quality::valid(_current_elem->type());
84 
85  // check whether the provided quality metric is applicable to current ElemType
86  if (!checkMetricApplicability(_m_type, metrics_avail))
87  {
88  _bypassed = true;
89  _bypassed_elem_type.insert(Utility::enum_to_string(_current_elem->type()));
90 
91  return;
92  }
93 
94  std::pair<Real, Real> default_bounds = _current_elem->qual_bounds(_m_type);
95  std::pair<Real, Real> actual_bounds;
97  {
99  mooseError("Provided lower bound should be less than provided upper bound!");
100 
101  actual_bounds = std::make_pair(_lower_bound, _upper_bound);
102  }
103  else if (_has_lower_bound)
104  {
105  if (_lower_bound >= default_bounds.second)
106  mooseError("Provided lower bound should less than the default upper bound: ",
107  default_bounds.second);
108 
109  actual_bounds = std::make_pair(_lower_bound, default_bounds.second);
110  }
111  else if (_has_upper_bound)
112  {
113  if (_upper_bound <= default_bounds.first)
114  mooseError("Provided upper bound should larger than the default lower bound: ",
115  default_bounds.first);
116 
117  actual_bounds = std::make_pair(default_bounds.first, _upper_bound);
118  }
119  else
120  actual_bounds = default_bounds;
121 
122  // calculate and save quality metric value for current element
123  Real mv = _current_elem->quality(_m_type);
124 
125  _checked_elem_num += 1;
126  _m_sum += mv;
127  if (mv > _m_max)
128  _m_max = mv;
129  else if (mv < _m_min)
130  _m_min = mv;
131 
132  // check element quality metric, save ids of elements whose quality metrics exceeds the preset
133  // bounds
134  if (mv < actual_bounds.first || mv > actual_bounds.second)
135  _elem_ids.insert(_current_elem->id());
136 }
137 
138 void
140 {
141  const auto & eqc = static_cast<const ElementQualityChecker &>(uo);
142  _elem_ids.insert(eqc._elem_ids.begin(), eqc._elem_ids.end());
143  _bypassed_elem_type.insert(eqc._bypassed_elem_type.begin(), eqc._bypassed_elem_type.end());
144  _bypassed |= eqc._bypassed;
145  _m_sum += eqc._m_sum;
146  _checked_elem_num += eqc._checked_elem_num;
147 
148  if (_m_min > eqc._m_min)
149  _m_min = eqc._m_min;
150  if (_m_max < eqc._m_max)
151  _m_max = eqc._m_max;
152 }
153 
154 void
156 {
164 
165  if (_bypassed)
166  mooseWarning("Provided quality metric doesn't apply to following element type: " +
168 
169  _console << libMesh::Quality::name(_m_type) << " Metric values:"
170  << "\n";
171  _console << " Minimum: " << _m_min << "\n";
172  _console << " Maximum: " << _m_max << "\n";
173  _console << " Average: " << _m_sum / _checked_elem_num << "\n";
174 
175  if (!_elem_ids.empty())
176  {
177  switch (_failure_type)
178  {
180  {
181  mooseWarning("List of failed element IDs: ", Moose::stringify(_elem_ids));
182  break;
183  }
184 
185  case FailureType::ERROR:
186  {
187  mooseError("List of failed element IDs: ", Moose::stringify(_elem_ids));
188  break;
189  }
190 
191  default:
192  mooseError("Unknown failure type!");
193  }
194  }
195 
196  _console << std::flush;
197 }
198 
199 bool
201  const std::vector<ElemQuality> & elem_metrics)
202 {
203  bool has_metric = false;
204 
205  for (unsigned int i = 0; i < elem_metrics.size(); ++i)
206  if (elem_metric == elem_metrics[i])
207  has_metric = true;
208 
209  return has_metric;
210 }
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
static InputParameters validParams()
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.
bool checkMetricApplicability(const ElemQuality &elem_metric, const std::vector< ElemQuality > &elem_metrics)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const Parallel::Communicator & _communicator
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()
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:31
static MooseEnum FailureMessageType()
ElemQuality
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:62
void threadJoin(const UserObject &uo) override
Must override.
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 option parameter and a documentation string to the InputParameters object...
std::set< std::string > _bypassed_elem_type
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
std::vector< ElemQuality > valid(const ElemType t)
Base class for user-specific data.
Definition: UserObject.h:39
void set_union(T &data, const unsigned int root_id) const
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:28