Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
grid_generator_from_name.cc
Go to the documentation of this file.
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2019 - 2020 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #include <deal.II/base/mutable_bind.h>
17 
18 #include <deal.II/grid/grid_generator.h>
19 
20 DEAL_II_NAMESPACE_OPEN
21 
22 namespace GridGenerator
23 {
24  namespace
25  {
32  template <int dim, int spacedim, class... Arguments>
33  void
34  parse_and_create(void (*generator)(Triangulation<dim, spacedim> &,
35  Arguments...),
36  const std::string & arguments,
37  Triangulation<dim, spacedim> &tria)
38  {
39  std::function<void(Arguments...)> wrapper =
40  [&tria, &generator](Arguments... args) { generator(tria, args...); };
41  auto bound_function = Utilities::mutable_bind(wrapper);
42  bound_function.parse_arguments(arguments);
43  bound_function();
44  }
45 
46 
52  template <int dim, int spacedim>
53  typename std::enable_if<dim != spacedim, bool>::type
54  generate_codimension_zero_grid(const std::string &,
55  const std::string &,
56  Triangulation<dim, spacedim> &)
57  {
58  return false;
59  }
60 
66  template <int dim>
67  bool
68  generate_codimension_zero_grid(const std::string & name,
69  const std::string & arguments,
70  Triangulation<dim> &tria)
71  {
72  if (name == "simplex")
73  parse_and_create<dim, dim, const std::vector<Point<dim>> &>(simplex,
74  arguments,
75  tria);
76  else if (name == "subdivided_hyper_rectangle")
77  {
78  // subdivided_hyper_rectangle is polymorphic, and can be called with
79  // different sets of arguments. We support two of these function
80  // calls. We try the first one, and if parsing fails, we go to the
81  // second one.
82  try
83  {
84  parse_and_create<dim,
85  dim,
86  const std::vector<unsigned int> &,
87  const Point<dim> &,
88  const Point<dim> &,
89  bool>(subdivided_hyper_rectangle,
90  arguments,
91  tria);
92  }
93  catch (Patterns::Tools::ExcNoMatch &)
94  {
95  parse_and_create<dim,
96  dim,
97  const std::vector<std::vector<double>> &,
98  const Point<dim> &,
99  const Point<dim> &,
100  bool>(subdivided_hyper_rectangle,
101  arguments,
102  tria);
103  }
104  }
105  else if (name == "plate_with_a_hole")
106  parse_and_create<dim,
107  dim,
108  double,
109  double,
110  double,
111  double,
112  double,
113  double,
114  const Point<dim>,
115  types::manifold_id,
116  types::manifold_id,
117  double,
118  unsigned int,
119  bool>(plate_with_a_hole, arguments, tria);
120  else if (name == "channel_with_cylinder")
121  parse_and_create<dim, dim, double, unsigned int, double, bool>(
122  channel_with_cylinder, arguments, tria);
123 
124  else if (name == "enclosed_hyper_cube")
125  parse_and_create<dim, dim, double, double, double, bool>(
126  enclosed_hyper_cube, arguments, tria);
127 
128  else if (name == "hyper_ball")
129  parse_and_create<dim, dim, const Point<dim> &, double, bool>(hyper_ball,
130  arguments,
131  tria);
132 
133  else if (name == "quarter_hyper_ball")
134  parse_and_create<dim, dim, const Point<dim> &, double>(
135  quarter_hyper_ball, arguments, tria);
136 
137  else if (name == "half_hyper_ball")
138  parse_and_create<dim, dim, const Point<dim> &, double>(half_hyper_ball,
139  arguments,
140  tria);
141 
142  else if (name == "cylinder")
143  parse_and_create<dim, dim, double, double>(cylinder, arguments, tria);
144 
145  else if (name == "truncated_cone")
146  parse_and_create<dim, dim, double, double, double>(truncated_cone,
147  arguments,
148  tria);
149 
150  else if (name == "hyper_L")
151  parse_and_create<dim, dim, double, double, bool>(hyper_L,
152  arguments,
153  tria);
154 
155  else if (name == "hyper_cube_slit")
156  parse_and_create<dim, dim, double, double, bool>(hyper_cube_slit,
157  arguments,
158  tria);
159 
160  else if (name == "hyper_shell")
161  parse_and_create<dim,
162  dim,
163  const Point<dim> &,
164  double,
165  double,
166  unsigned int,
167  bool>(hyper_shell, arguments, tria);
168 
169  else if (name == "half_hyper_shell")
170  parse_and_create<dim,
171  dim,
172  const Point<dim> &,
173  double,
174  double,
175  unsigned int,
176  bool>(half_hyper_shell, arguments, tria);
177 
178  else if (name == "quarter_hyper_shell")
179  parse_and_create<dim,
180  dim,
181  const Point<dim> &,
182  double,
183  double,
184  unsigned int,
185  bool>(quarter_hyper_shell, arguments, tria);
186 
187  else if (name == "cylinder_shell")
188  parse_and_create<dim,
189  dim,
190  double,
191  double,
192  double,
193  unsigned int,
194  unsigned int>(cylinder_shell, arguments, tria);
195 
196  else if (name == "hyper_cube_with_cylindrical_hole")
197  parse_and_create<dim, dim, double, double, double, unsigned int, bool>(
198  hyper_cube_with_cylindrical_hole, arguments, tria);
199 
200  else if (name == "concentric_hyper_shells")
201  parse_and_create<dim,
202  dim,
203  const Point<dim> &,
204  double,
205  double,
206  unsigned int,
207  double,
208  unsigned int,
209  bool>(concentric_hyper_shells, arguments, tria);
210  else
211  return false;
212 
213  return true;
214  }
215 
216 
222  template <int dim, int spacedim>
223  typename std::enable_if<dim != spacedim - 1, bool>::type
224  generate_codimension_one_grid(const std::string &,
225  const std::string &,
226  Triangulation<dim, spacedim> &)
227  {
228  return false;
229  }
230 
236  template <int dim>
237  bool
238  generate_codimension_one_grid(const std::string & name,
239  const std::string & arguments,
240  Triangulation<dim, dim + 1> &tria)
241  {
242  if (name == "hyper_sphere")
243  parse_and_create<dim, dim + 1, const Point<dim + 1> &, double>(
244  hyper_sphere, arguments, tria);
245  else
246  return false;
247  return true;
248  }
249 
255  template <int dim, int spacedim>
256  bool
257  generate_special(const std::string &,
258  const std::string &,
259  Triangulation<dim, spacedim> &)
260  {
261  return false;
262  }
263 
269  bool
270  generate_special(const std::string & name,
271  const std::string & arguments,
272  Triangulation<3, 3> &tria)
273  {
274  if (name == "moebius")
275  parse_and_create<3, 3, unsigned int, unsigned int, double, double>(
276  moebius, arguments, tria);
277  else if (name == "torus")
278  parse_and_create<3, 3, double, double, unsigned int, double>(torus,
279  arguments,
280  tria);
281  else
282  {
283  return false;
284  }
285  return true;
286  }
287 
293  bool
294  generate_special(const std::string & name,
295  const std::string & arguments,
296  Triangulation<2, 3> &tria)
297  {
298  if (name == "torus")
299  parse_and_create<2, 3, double, double, unsigned int, double>(torus,
300  arguments,
301  tria);
302  else
303  {
304  return false;
305  }
306  return true;
307  }
308  } // namespace
309 
310 
311 
312  template <int dim, int spacedim>
313  void
314  generate_from_name_and_arguments(Triangulation<dim, spacedim> &tria,
315  const std::string & name,
316  const std::string & arguments)
317  {
318  // We begin with all function calls that are implemented for all
319  // combinations of dim and spacedim.
320  if (name == "hyper_cube")
321  parse_and_create<dim, spacedim, double, double, bool>(hyper_cube,
322  arguments,
323  tria);
324  else if (name == "subdivided_hyper_cube")
325  parse_and_create<dim, spacedim, unsigned int, double, double, bool>(
326  subdivided_hyper_cube, arguments, tria);
327  else if (name == "hyper_rectangle")
328  parse_and_create<dim,
329  spacedim,
330  const Point<dim> &,
331  const Point<dim> &,
332  bool>(hyper_rectangle, arguments, tria);
333  else if (name == "cheese")
334  parse_and_create<dim, spacedim, const std::vector<unsigned int> &>(
335  cheese, arguments, tria);
336  else if (name == "general_cell")
337  parse_and_create<dim,
338  spacedim,
339  const std::vector<Point<spacedim>> &,
340  bool>(general_cell, arguments, tria);
341  else if (name == "hyper_cross")
342  parse_and_create<dim, spacedim, const std::vector<unsigned int> &, bool>(
343  hyper_cross, arguments, tria);
344  // If none of the above worked, than we try with more specific function
345  // calls. First we try to call functions that are only implemented when
346  // dim == spacedim, then when dim == spacedim-1, and lastly, we try to see
347  // if the name, dim, and spacedim match some of the very special grid
348  // generator functions, like torus, moebius, etc.
349  //
350  // If one of the function call succeeds, we skip the rest and return.
351  else if (generate_codimension_zero_grid(name, arguments, tria))
352  {}
353  else if (generate_codimension_one_grid(name, arguments, tria))
354  {}
355  else if (generate_special(name, arguments, tria))
356  {}
357  else
358  // If we got here, we really have no idea what grid the user wants to
359  // generate.
360  AssertThrow(false,
361  ExcMessage(name + "(" + arguments + ") not implemented"));
362  }
363 } // namespace GridGenerator
364 
365 #include "grid_generator_from_name.inst"
366 
367 DEAL_II_NAMESPACE_CLOSE
GridGenerator::hyper_cube_with_cylindrical_hole
void hyper_cube_with_cylindrical_hole(Triangulation< dim > &triangulation, const double inner_radius=.25, const double outer_radius=.5, const double L=.5, const unsigned int repetitions=1, const bool colorize=false)
GridGenerator::subdivided_hyper_cube
void subdivided_hyper_cube(Triangulation< dim, spacedim > &tria, const unsigned int repetitions, const double left=0., const double right=1., const bool colorize=false)
GridGenerator::simplex
void simplex(Triangulation< dim, dim > &tria, const std::vector< Point< dim >> &vertices)
Triangulation
Definition: tria.h:1109
GridGenerator::enclosed_hyper_cube
void enclosed_hyper_cube(Triangulation< dim > &tria, const double left=0., const double right=1., const double thickness=1., const bool colorize=false)
GridGenerator::concentric_hyper_shells
void concentric_hyper_shells(Triangulation< dim > &triangulation, const Point< dim > &center, const double inner_radius=0.125, const double outer_radius=0.25, const unsigned int n_shells=1, const double skewness=0.1, const unsigned int n_cells_per_shell=0, const bool colorize=false)
GridGenerator::general_cell
void general_cell(Triangulation< dim, spacedim > &tria, const std::vector< Point< spacedim >> &vertices, const bool colorize=false)
GridGenerator::truncated_cone
void truncated_cone(Triangulation< dim > &tria, const double radius_0=1.0, const double radius_1=0.5, const double half_length=1.0)
GridGenerator::torus
void torus(Triangulation< dim, spacedim > &tria, const double R, const double r, const unsigned int n_cells_toroidal=6, const double phi=2.0 *numbers::PI)
GridGenerator::quarter_hyper_shell
void quarter_hyper_shell(Triangulation< dim > &tria, const Point< dim > &center, const double inner_radius, const double outer_radius, const unsigned int n_cells=0, const bool colorize=false)
GridGenerator::channel_with_cylinder
void channel_with_cylinder(Triangulation< dim > &tria, const double shell_region_width=0.03, const unsigned int n_shells=2, const double skewness=2.0, const bool colorize=false)
GridGenerator::hyper_rectangle
void hyper_rectangle(Triangulation< dim, spacedim > &tria, const Point< dim > &p1, const Point< dim > &p2, const bool colorize=false)
GridGenerator::half_hyper_ball
void half_hyper_ball(Triangulation< dim > &tria, const Point< dim > &center=Point< dim >(), const double radius=1.)
GridGenerator::moebius
void moebius(Triangulation< 3, 3 > &tria, const unsigned int n_cells, const unsigned int n_rotations, const double R, const double r)
GridGenerator::cylinder
void cylinder(Triangulation< dim > &tria, const double radius=1., const double half_length=1.)
GridGenerator::hyper_L
void hyper_L(Triangulation< dim > &tria, const double left=-1., const double right=1., const bool colorize=false)
GridGenerator::cylinder_shell
void cylinder_shell(Triangulation< dim > &tria, const double length, const double inner_radius, const double outer_radius, const unsigned int n_radial_cells=0, const unsigned int n_axial_cells=0)
GridGenerator::quarter_hyper_ball
void quarter_hyper_ball(Triangulation< dim > &tria, const Point< dim > &center=Point< dim >(), const double radius=1.)
StandardExceptions::ExcMessage
static ::ExceptionBase & ExcMessage(std::string arg1)
GridGenerator::hyper_shell
void hyper_shell(Triangulation< dim > &tria, const Point< dim > &center, const double inner_radius, const double outer_radius, const unsigned int n_cells=0, bool colorize=false)
double
GridGenerator::hyper_sphere
void hyper_sphere(Triangulation< spacedim - 1, spacedim > &tria, const Point< spacedim > &center=Point< spacedim >(), const double radius=1.)
GridGenerator::hyper_cross
void hyper_cross(Triangulation< dim, spacedim > &tria, const std::vector< unsigned int > &sizes, const bool colorize_cells=false)
A center cell with stacks of cell protruding from each surface.
GridGenerator::subdivided_hyper_rectangle
void subdivided_hyper_rectangle(Triangulation< dim, spacedim > &tria, const std::vector< unsigned int > &repetitions, const Point< dim > &p1, const Point< dim > &p2, const bool colorize=false)
DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:358
GridGenerator::hyper_cube_slit
void hyper_cube_slit(Triangulation< dim > &tria, const double left=0., const double right=1., const bool colorize=false)
GridGenerator
Definition: grid_generator.h:57
types::manifold_id
unsigned int manifold_id
Definition: types.h:141
GridGenerator::hyper_ball
void hyper_ball(Triangulation< dim > &tria, const Point< dim > &center=Point< dim >(), const double radius=1., const bool attach_spherical_manifold_on_boundary_cells=false)
GridGenerator::hyper_cube
void hyper_cube(Triangulation< dim, spacedim > &tria, const double left=0., const double right=1., const bool colorize=false)
GridGenerator::cheese
void cheese(Triangulation< dim, spacedim > &tria, const std::vector< unsigned int > &holes)
Rectangular domain with rectangular pattern of holes.
GridGenerator::half_hyper_shell
void half_hyper_shell(Triangulation< dim > &tria, const Point< dim > &center, const double inner_radius, const double outer_radius, const unsigned int n_cells=0, const bool colorize=false)
grid_generator.h
Point< dim >
GridGenerator::plate_with_a_hole
void plate_with_a_hole(Triangulation< dim > &tria, const double inner_radius=0.4, const double outer_radius=1., const double pad_bottom=2., const double pad_top=2., const double pad_left=1., const double pad_right=1., const Point< dim > center=Point< dim >(), const types::manifold_id polar_manifold_id=0, const types::manifold_id tfi_manifold_id=1, const double L=1., const unsigned int n_slices=2, const bool colorize=false)
Rectangular plate with an (offset) cylindrical hole.
GridGenerator::generate_from_name_and_arguments
void generate_from_name_and_arguments(Triangulation< dim, spacedim > &tria, const std::string &grid_generator_function_name, const std::string &grid_generator_function_arguments)
Definition: grid_generator_from_name.cc:314
mutable_bind.h
DEAL_II_NAMESPACE_CLOSE
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:359
AssertThrow
#define AssertThrow(cond, exc)
Definition: exceptions.h:1531
int
Patterns::Tools::ExcNoMatch
static ::ExceptionBase & ExcNoMatch(std::string arg1, std::string arg2)
Utilities::mutable_bind
MutableBind< ReturnType, FunctionArgs... > mutable_bind(ReturnType(*function)(FunctionArgs...), typename identity< FunctionArgs >::type &&... arguments)
Generated by   doxygen 1.8.17