From 324b1fd123c9abade72401a0ae56fda68ffa191a Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Fri, 7 Feb 2020 18:20:43 -0500 Subject: [PATCH] Fix more Gmsh references --- examples/step-49/doc/intro.dox | 2 +- include/deal.II/gmsh/utilities.h | 10 +++++----- include/deal.II/grid/grid_in.h | 14 +++++++------- include/deal.II/grid/grid_out.h | 14 +++++++------- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/examples/step-49/doc/intro.dox b/examples/step-49/doc/intro.dox index f6d7c14813..3217716161 100644 --- a/examples/step-49/doc/intro.dox +++ b/examples/step-49/doc/intro.dox @@ -279,7 +279,7 @@ GridGenerator::extrude_triangulation(). See the grid_4() function in this tutorial for an example. Note that for this particular case, the given result could also be achieved using the 3d version of GridGenerator::hyper_cube_with_cylindrical_hole(). The main usage is a 2d -mesh, generated for example with Gmsh, that is read in from a +mesh, generated for example with %Gmsh, that is read in from a .msh file as described above. This is the output from grid_4(): diff --git a/include/deal.II/gmsh/utilities.h b/include/deal.II/gmsh/utilities.h index cf73198ed3..239d52ec50 100644 --- a/include/deal.II/gmsh/utilities.h +++ b/include/deal.II/gmsh/utilities.h @@ -37,14 +37,14 @@ DEAL_II_NAMESPACE_OPEN /** - * A collection of Gmsh related utilities and classes. + * A collection of %Gmsh related utilities and classes. * * @author Luca Heltai, Dirk Peschka, 2018 */ namespace Gmsh { /** - * A parameter class used to pass options to the Gmsh executable. + * A parameter class used to pass options to the %Gmsh executable. * * @author Luca Heltai, 2018 */ @@ -64,9 +64,9 @@ namespace Gmsh add_parameters(ParameterHandler &prm); /** - * The characteristic length used for the definition of the Gmsh grid. + * The characteristic length used for the definition of the %Gmsh grid. * - * Gmsh will try to make sure that the size of each edge is as close as + * %Gmsh will try to make sure that the size of each edge is as close as * possible to this value. */ double characteristic_length = 1.0; @@ -83,7 +83,7 @@ namespace Gmsh # ifdef DEAL_II_WITH_OPENCASCADE /** * Given a smooth closed curve, create a triangulation from it using - * Gmsh. + * %Gmsh. * * The input curve @p boundary should be closed. * diff --git a/include/deal.II/grid/grid_in.h b/include/deal.II/grid/grid_in.h index b8a4fd59b6..04dadbf15a 100644 --- a/include/deal.II/grid/grid_in.h +++ b/include/deal.II/grid/grid_in.h @@ -40,7 +40,7 @@ struct CellData; /** * This class implements an input mechanism for grid data. It allows to read a * grid structure into a triangulation object. At present, UCD (unstructured - * cell data), DB Mesh, XDA, Gmsh, Tecplot, NetCDF, UNV, VTK, ASSIMP, and Cubit + * cell data), DB Mesh, XDA, %Gmsh, Tecplot, NetCDF, UNV, VTK, ASSIMP, and Cubit * are supported as input format for grid data. Any numerical data other than * geometric (vertex locations) and topological (how vertices form cells, * faces, and edges) information is ignored, but the readers for the various @@ -145,14 +145,14 @@ struct CellData; * several example files. If the reader does not grok your files, it should be * fairly simple to extend it. * - *
  • Gmsh 1.0 mesh format: this format is used by the @p Gmsh mesh - * generator (see http://gmsh.info/). The documentation in the @p Gmsh + *
  • %Gmsh 1.0 mesh format: this format is used by the @p %Gmsh mesh + * generator (see http://gmsh.info/). The documentation in the @p %Gmsh * manual explains how to generate meshes compatible with the deal.II library - * (i.e. quads rather than triangles). In order to use this format, Gmsh has + * (i.e. quads rather than triangles). In order to use this format, %Gmsh has * to output the file in the old format 1.0. This is done adding the line * "Mesh.MshFileVersion = 1" to the input file. * - *
  • Gmsh 2.0 mesh format: this is a variant of the above format. + *
  • %Gmsh 2.0 mesh format: this is a variant of the above format. * The read_msh() function automatically determines whether an input file is * version 1 or version 2. * @@ -484,12 +484,12 @@ public: /** * Read grid data from an msh file, either version 1 or version 2 of that - * file format. The Gmsh formats are documented at + * file format. The %Gmsh formats are documented at * http://www.gmsh.info/. * * @note The input function of deal.II does not distinguish between newline * and other whitespace. Therefore, deal.II will be able to read files in a - * slightly more general format than Gmsh. + * slightly more general format than %Gmsh. */ void read_msh(std::istream &in); diff --git a/include/deal.II/grid/grid_out.h b/include/deal.II/grid/grid_out.h index 958f06e3c6..1093b47256 100644 --- a/include/deal.II/grid/grid_out.h +++ b/include/deal.II/grid/grid_out.h @@ -1079,7 +1079,7 @@ public: /** * Write the triangulation in the msh format. * - * Msh is the format used by Gmsh and it is described in the Gmsh user's + * Msh is the format used by %Gmsh and it is described in the %Gmsh user's * guide. Besides the usual output of the grid only, you can decide through * additional flags (see below, and the documentation of the * GridOutFlags::Msh() class) whether boundary faces with non-zero boundary @@ -1359,7 +1359,7 @@ public: set_flags(const GridOutFlags::DX &flags); /** - * Set flags for Gmsh output + * Set flags for %Gmsh output */ void set_flags(const GridOutFlags::Msh &flags); @@ -1508,7 +1508,7 @@ private: GridOutFlags::DX dx_flags; /** - * Flags for Gmsh output. Can be changed by using the set_flags(const + * Flags for %Gmsh output. Can be changed by using the set_flags(const * GridOutFlags::Msh&) function. */ GridOutFlags::Msh msh_flags; @@ -1573,7 +1573,7 @@ private: * printed which are on the boundary and which have a boundary indicator not * equal to zero, since the latter is the default for boundary faces. * - * Since, in Gmsh, geometric elements are continuously numbered, this + * Since, in %Gmsh, geometric elements are continuously numbered, this * function requires a parameter @p next_element_index providing the next * geometric element number. This index should have a numerical value equal * to one more than the index previously used to write a geometric element @@ -1583,7 +1583,7 @@ private: * * @warning @p next_element_index should be (at least) one larger than the * current number of triangulation elements (lines, cells, faces) that have - * been written to @p out. Gmsh will not load the saved file correctly if + * been written to @p out. %Gmsh will not load the saved file correctly if * there are repeated indices. * * This function unfortunately can not be included in the regular @p @@ -1626,7 +1626,7 @@ private: * printed which are on the boundary and which have a boundary indicator not * equal to zero, since the latter is the default for boundary faces. * - * Since, in Gmsh, geometric elements are continuously numbered, this + * Since, in %Gmsh, geometric elements are continuously numbered, this * function requires a parameter @p next_element_index providing the next * geometric element number. This index should have a numerical value equal * to one more than the index previously used to write a geometric element @@ -1636,7 +1636,7 @@ private: * * @warning @p next_element_index should be (at least) one larger than the * current number of triangulation elements (lines, cells, faces) that have - * been written to @p out. Gmsh will not load the saved file correctly if + * been written to @p out. %Gmsh will not load the saved file correctly if * there are repeated indices. * * This function unfortunately can not be included in the regular @p -- 2.39.5