https://mooseframework.inl.gov
SurfaceDelaunayGeneratorBase.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 
11 
14 {
16 
17  params.addParam<bool>("use_auto_area_func",
18  false,
19  "Use the automatic area function for the triangle meshing region.");
20  params.addParam<Real>(
21  "auto_area_func_default_size",
22  0,
23  "Background size for automatic area function, or 0 to use non background size");
24  params.addParam<Real>("auto_area_func_default_size_dist",
25  -1.0,
26  "Effective distance of background size for automatic area "
27  "function, or negative to use non background size");
28  params.addParam<unsigned int>("auto_area_function_num_points",
29  10,
30  "Maximum number of nearest points used for the inverse distance "
31  "interpolation algorithm for automatic area function calculation.");
32  params.addRangeCheckedParam<Real>(
33  "auto_area_function_power",
34  1.0,
35  "auto_area_function_power>0",
36  "Polynomial power of the inverse distance interpolation algorithm for automatic area "
37  "function calculation.");
38 
39  params.addClassDescription("Base class for Delaunay mesh generators applied to a surface.");
40 
41  params.addParamNamesToGroup(
42  "use_auto_area_func auto_area_func_default_size auto_area_func_default_size_dist "
43  "auto_area_function_num_points auto_area_function_power",
44  "Automatic triangle meshing area control");
45 
46  return params;
47 }
48 
50  : MeshGenerator(parameters),
51  _use_auto_area_func(getParam<bool>("use_auto_area_func")),
52  _auto_area_func_default_size(getParam<Real>("auto_area_func_default_size")),
53  _auto_area_func_default_size_dist(getParam<Real>("auto_area_func_default_size_dist")),
54  _auto_area_function_num_points(getParam<unsigned int>("auto_area_function_num_points")),
55  _auto_area_function_power(getParam<Real>("auto_area_function_power"))
56 {
57 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Definition: MeshGenerator.C:23
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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...
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)
SurfaceDelaunayGeneratorBase(const InputParameters &parameters)
MeshGenerators are objects that can modify or add to an existing mesh.
Definition: MeshGenerator.h:32
void ErrorVector unsigned int
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...