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
<code>.msh</code> file as described above. This is the output from grid_4():
<table width="60%" align="center">
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
*/
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;
# 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.
*
/**
* 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
* several example files. If the reader does not grok your files, it should be
* fairly simple to extend it.
*
- * <li> <tt>Gmsh 1.0 mesh</tt> format: this format is used by the @p Gmsh mesh
- * generator (see http://gmsh.info/). The documentation in the @p Gmsh
+ * <li> <tt>%Gmsh 1.0 mesh</tt> 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.
*
- * <li> <tt>Gmsh 2.0 mesh</tt> format: this is a variant of the above format.
+ * <li> <tt>%Gmsh 2.0 mesh</tt> 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.
*
/**
* 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);
/**
* 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
set_flags(const GridOutFlags::DX &flags);
/**
- * Set flags for Gmsh output
+ * Set flags for %Gmsh output
*/
void
set_flags(const GridOutFlags::Msh &flags);
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;
* 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
*
* @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
* 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
*
* @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
projects / dealii.git / commitdiff