From: Luel Emishaw Date: Wed, 7 Aug 2019 23:19:07 +0000 (-0400) Subject: Describe input and output parameters for flatten_triangulation() X-Git-Tag: v9.2.0-rc1~1275^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=48cbe2e9c8c1e75cb9afb8ae9c5c5346fd5f1c43;p=dealii.git Describe input and output parameters for flatten_triangulation() --- diff --git a/doc/news/changes/minor/20190708LuelEmishaw b/doc/news/changes/minor/20190708LuelEmishaw new file mode 100644 index 0000000000..dae4662c72 --- /dev/null +++ b/doc/news/changes/minor/20190708LuelEmishaw @@ -0,0 +1,5 @@ +Improved: flatten_triangulation() description by adding parameter inputs. + +Luel Emishaw (2019/09/08) + + diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 1c51c127dc..dd2fb3d627 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -1535,6 +1535,10 @@ namespace GridGenerator * parallel::distributed::Triangulation, as well as when the input * Triangulation contains hanging nodes. * + * @param[in] in_tria The base input for a new flat triangulation. + * @param[out] out_tria The desired flattened triangulation constructed from + * the in_tria. + * * @note Since @p input and @p output have different spatial dimensions no * manifold objects are copied by this function: you must attach new * manifold objects to @p out_tria.