From c8b73eb7dc69090486bb03af6157c9dbff9e830b Mon Sep 17 00:00:00 2001 From: Christophe Geuzaine <cgeuzaine@ulg.ac.be> Date: Fri, 27 Dec 2019 17:40:04 +0100 Subject: [PATCH] print full namespace in API doc for each function, to make the doc easier to search --- api/GenApi.py | 2 +- api/api.texi | 508 +++++++++++++++++++++---------------------- doc/texinfo/api.texi | 508 +++++++++++++++++++++---------------------- utils/docker/README | 9 +- 4 files changed, 514 insertions(+), 513 deletions(-) diff --git a/api/GenApi.py b/api/GenApi.py index 4a76607b3b..f3022ce509 100644 --- a/api/GenApi.py +++ b/api/GenApi.py @@ -1421,7 +1421,7 @@ class API: f.write("@section Namespace @code{" + path + "}: " + module.doc + "\n\n"); f.write("@ftable @code\n"); for rtype, name, args, doc, special in module.fs: - f.write("@item " + name + "\n"); + f.write("@item " + path + '/' + name + "\n"); tdoc = doc.replace("`", "@code{").replace("'", "}") f.write("\n".join(textwrap.wrap(tdoc, 80)) + "\n\n") f.write("@table @asis\n"); diff --git a/api/api.texi b/api/api.texi index 08193707a8..594a52ef05 100644 --- a/api/api.texi +++ b/api/api.texi @@ -21,7 +21,7 @@ @section Namespace @code{gmsh}: top-level functions @ftable @code -@item initialize +@item gmsh/initialize Initialize Gmsh. This must be called before any call to the other functions in the API. If @code{argc} and @code{argv} (or just @code{argv} in Python or Julia) are provided, they will be handled in the same way as the command line arguments @@ -37,7 +37,7 @@ configuration files (gmshrc and gmsh-options). - @end table -@item finalize +@item gmsh/finalize Finalize Gmsh. This must be called when you are done using the Gmsh API. @table @asis @@ -49,7 +49,7 @@ Finalize Gmsh. This must be called when you are done using the Gmsh API. - @end table -@item open +@item gmsh/open Open a file. Equivalent to the @code{File->Open} menu in the Gmsh app. Handling of the file depends on its extension and/or its contents: opening a file with model data will create a new model. @@ -63,7 +63,7 @@ model data will create a new model. - @end table -@item merge +@item gmsh/merge Merge a file. Equivalent to the @code{File->Merge} menu in the Gmsh app. Handling of the file depends on its extension and/or its contents. Merging a file with model data will add the data to the current model. @@ -77,7 +77,7 @@ file with model data will add the data to the current model. - @end table -@item write +@item gmsh/write Write a file. The export format is determined by the file extension. @table @asis @@ -89,7 +89,7 @@ Write a file. The export format is determined by the file extension. - @end table -@item clear +@item gmsh/clear Clear all loaded models and post-processing data, and add a new empty model. @table @asis @@ -107,7 +107,7 @@ Clear all loaded models and post-processing data, and add a new empty model. @section Namespace @code{gmsh/option}: option handling functions @ftable @code -@item setNumber +@item gmsh/option/setNumber Set a numerical option to @code{value}. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -121,7 +121,7 @@ are listed in the Gmsh reference manual. - @end table -@item getNumber +@item gmsh/option/getNumber Get the @code{value} of a numerical option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -135,7 +135,7 @@ are listed in the Gmsh reference manual. - @end table -@item setString +@item gmsh/option/setString Set a string option to @code{value}. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -149,7 +149,7 @@ are listed in the Gmsh reference manual. - @end table -@item getString +@item gmsh/option/getString Get the @code{value} of a string option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -163,7 +163,7 @@ are listed in the Gmsh reference manual. - @end table -@item setColor +@item gmsh/option/setColor Set a color option to the RGBA value (@code{r}, @code{g}, @code{b}, @code{a}), where where @code{r}, @code{g}, @code{b} and @code{a} should be integers between 0 and 255. @code{name} is of the form "category.option" or @@ -179,7 +179,7 @@ reference manual, with the "Color." middle string removed. - @end table -@item getColor +@item gmsh/option/getColor Get the @code{r}, @code{g}, @code{b}, @code{a} value of a color option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual, with @@ -200,7 +200,7 @@ the "Color." middle string removed. @section Namespace @code{gmsh/model}: model functions @ftable @code -@item add +@item gmsh/model/add Add a new model, with name @code{name}, and set it as the current model. @table @asis @@ -212,7 +212,7 @@ Add a new model, with name @code{name}, and set it as the current model. - @end table -@item remove +@item gmsh/model/remove Remove the current model. @table @asis @@ -224,7 +224,7 @@ Remove the current model. - @end table -@item list +@item gmsh/model/list List the names of all models. @table @asis @@ -236,7 +236,7 @@ List the names of all models. - @end table -@item getCurrent +@item gmsh/model/getCurrent Get the name of the current model. @table @asis @@ -248,7 +248,7 @@ Get the name of the current model. - @end table -@item setCurrent +@item gmsh/model/setCurrent Set the current model to the model with name @code{name}. If several models have the same name, select the one that was added first. @@ -261,7 +261,7 @@ the same name, select the one that was added first. - @end table -@item getEntities +@item gmsh/model/getEntities Get all the entities in the current model. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. points if @code{dim} == 0). The entities are returned as a vector of (dim, tag) integer pairs. @@ -275,7 +275,7 @@ entities are returned as a vector of (dim, tag) integer pairs. - @end table -@item setEntityName +@item gmsh/model/setEntityName Set the name of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -287,7 +287,7 @@ Set the name of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getEntityName +@item gmsh/model/getEntityName Get the name of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -299,7 +299,7 @@ Get the name of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getPhysicalGroups +@item gmsh/model/getPhysicalGroups Get all the physical groups in the current model. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. physical points if @code{dim} == 0). The entities are returned as a vector of (dim, tag) integer pairs. @@ -313,7 +313,7 @@ only the entities of the specified dimension (e.g. physical points if @code{dim} - @end table -@item getEntitiesForPhysicalGroup +@item gmsh/model/getEntitiesForPhysicalGroup Get the tags of the model entities making up the physical group of dimension @code{dim} and tag @code{tag}. @@ -326,7 +326,7 @@ Get the tags of the model entities making up the physical group of dimension - @end table -@item getPhysicalGroupsForEntity +@item gmsh/model/getPhysicalGroupsForEntity Get the tags of the physical groups (if any) to which the model entity of dimension @code{dim} and tag @code{tag} belongs. @@ -339,7 +339,7 @@ dimension @code{dim} and tag @code{tag} belongs. - @end table -@item addPhysicalGroup +@item gmsh/model/addPhysicalGroup Add a physical group of dimension @code{dim}, grouping the model entities with tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if @code{tag} is positive, or a new tag if @code{tag} < 0. @@ -353,7 +353,7 @@ tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if integer value @end table -@item setPhysicalName +@item gmsh/model/setPhysicalName Set the name of the physical group of dimension @code{dim} and tag @code{tag}. @table @asis @@ -365,7 +365,7 @@ Set the name of the physical group of dimension @code{dim} and tag @code{tag}. - @end table -@item getPhysicalName +@item gmsh/model/getPhysicalName Get the name of the physical group of dimension @code{dim} and tag @code{tag}. @table @asis @@ -377,7 +377,7 @@ Get the name of the physical group of dimension @code{dim} and tag @code{tag}. - @end table -@item getBoundary +@item gmsh/model/getBoundary Get the boundary of the model entities @code{dimTags}. Return in @code{outDimTags} the boundary of the individual entities (if @code{combined} is false) or the boundary of the combined geometrical shape formed by all input @@ -394,7 +394,7 @@ recursively down to dimension 0 (i.e. to points) if @code{recursive} is true. - @end table -@item getEntitiesInBoundingBox +@item gmsh/model/getEntitiesInBoundingBox Get the model entities in the bounding box defined by the two points (@code{xmin}, @code{ymin}, @code{zmin}) and (@code{xmax}, @code{ymax}, @code{zmax}). If @code{dim} is >= 0, return only the entities of the specified @@ -409,7 +409,7 @@ dimension (e.g. points if @code{dim} == 0). - @end table -@item getBoundingBox +@item gmsh/model/getBoundingBox Get the bounding box (@code{xmin}, @code{ymin}, @code{zmin}), (@code{xmax}, @code{ymax}, @code{zmax}) of the model entity of dimension @code{dim} and tag @code{tag}. If @code{dim} and @code{tag} are negative, get the bounding box of @@ -424,7 +424,7 @@ the whole model. - @end table -@item getDimension +@item gmsh/model/getDimension Get the geometrical dimension of the current model. @table @asis @@ -436,7 +436,7 @@ Get the geometrical dimension of the current model. integer value @end table -@item addDiscreteEntity +@item gmsh/model/addDiscreteEntity Add a discrete model entity (defined by a mesh) of dimension @code{dim} in the current model. Return the tag of the new discrete entity, equal to @code{tag} if @code{tag} is positive, or a new tag if @code{tag} < 0. @code{boundary} @@ -453,7 +453,7 @@ overall model. integer value @end table -@item removeEntities +@item gmsh/model/removeEntities Remove the entities @code{dimTags} of the current model. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -466,7 +466,7 @@ true, remove all the entities on their boundaries, down to dimension 0. - @end table -@item removeEntityName +@item gmsh/model/removeEntityName Remove the entity name @code{name} from the current model. @table @asis @@ -478,7 +478,7 @@ Remove the entity name @code{name} from the current model. - @end table -@item removePhysicalGroups +@item gmsh/model/removePhysicalGroups Remove the physical groups @code{dimTags} of the current model. If @code{dimTags} is empty, remove all groups. @@ -491,7 +491,7 @@ Remove the physical groups @code{dimTags} of the current model. If - @end table -@item removePhysicalName +@item gmsh/model/removePhysicalName Remove the physical name @code{name} from the current model. @table @asis @@ -503,7 +503,7 @@ Remove the physical name @code{name} from the current model. - @end table -@item getType +@item gmsh/model/getType Get the type of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -515,7 +515,7 @@ Get the type of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getParent +@item gmsh/model/getParent In a partitioned model, get the parent of the entity of dimension @code{dim} and tag @code{tag}, i.e. from which the entity is a part of, if any. @code{parentDim} and @code{parentTag} are set to -1 if the entity has no parent. @@ -529,7 +529,7 @@ tag @code{tag}, i.e. from which the entity is a part of, if any. - @end table -@item getPartitions +@item gmsh/model/getPartitions In a partitioned model, return the tags of the partition(s) to which the entity belongs. @@ -542,7 +542,7 @@ belongs. - @end table -@item getValue +@item gmsh/model/getValue Evaluate the parametrization of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 0 (with empty @code{parametricCoord}), 1 (with @@ -560,7 +560,7 @@ coordinates in @code{points}, concatenated: [p1x, p1y, p1z, p2x, ...]. - @end table -@item getDerivative +@item gmsh/model/getDerivative Evaluate the derivative of the parametrization of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 1 (with @@ -581,7 +581,7 @@ derivate with respect to u and v: [d1ux, d1uy, d1uz, d1vx, d1vy, d1vz, d2ux, - @end table -@item getCurvature +@item gmsh/model/getCurvature Evaluate the (maximum) curvature of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 1 (with @code{parametricCoord} containing parametric @@ -597,7 +597,7 @@ u, v parametric coordinates on the surface, concatenated: [p1u, p1v, p2u, ...]). - @end table -@item getPrincipalCurvatures +@item gmsh/model/getPrincipalCurvatures Evaluate the principal curvatures of the surface with tag @code{tag} at the parametric coordinates @code{parametricCoord}, as well as their respective directions. @code{parametricCoord} are given by pair of u and v coordinates, @@ -612,7 +612,7 @@ concatenated: [p1u, p1v, p2u, ...]. - @end table -@item getNormal +@item gmsh/model/getNormal Get the normal to the surface with tag @code{tag} at the parametric coordinates @code{parametricCoord}. @code{parametricCoord} are given by pairs of u and v coordinates, concatenated: [p1u, p1v, p2u, ...]. @code{normals} are returned as @@ -627,7 +627,7 @@ triplets of x, y, z components, concatenated: [n1x, n1y, n1z, n2x, ...]. - @end table -@item getParametrization +@item gmsh/model/getParametrization Get the parametric coordinates @code{parametricCoord} for the points @code{points} on the entity of dimension @code{dim} and tag @code{tag}. @code{points} are given as triplets of x, y, z coordinates, concatenated: [p1x, @@ -644,7 +644,7 @@ the surface (if @code{dim} = 2), i.e. [p1t, p2t, ...] or [p1u, p1v, p2u, ...]. - @end table -@item setVisibility +@item gmsh/model/setVisibility Set the visibility of the model entities @code{dimTags} to @code{value}. Apply the visibility setting recursively if @code{recursive} is true. @@ -657,7 +657,7 @@ the visibility setting recursively if @code{recursive} is true. - @end table -@item getVisibility +@item gmsh/model/getVisibility Get the visibility of the model entity of dimension @code{dim} and tag @code{tag}. @@ -670,7 +670,7 @@ Get the visibility of the model entity of dimension @code{dim} and tag - @end table -@item setColor +@item gmsh/model/setColor Set the color of the model entities @code{dimTags} to the RGBA value (@code{r}, @code{g}, @code{b}, @code{a}), where @code{r}, @code{g}, @code{b} and @code{a} should be integers between 0 and 255. Apply the color setting recursively if @@ -685,7 +685,7 @@ should be integers between 0 and 255. Apply the color setting recursively if - @end table -@item getColor +@item gmsh/model/getColor Get the color of the model entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -697,7 +697,7 @@ Get the color of the model entity of dimension @code{dim} and tag @code{tag}. - @end table -@item setCoordinates +@item gmsh/model/setCoordinates Set the @code{x}, @code{y}, @code{z} coordinates of a geometrical point. @table @asis @@ -715,7 +715,7 @@ Set the @code{x}, @code{y}, @code{z} coordinates of a geometrical point. @section Namespace @code{gmsh/model/mesh}: mesh functions @ftable @code -@item generate +@item gmsh/model/mesh/generate Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). @table @asis @@ -727,7 +727,7 @@ Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). - @end table -@item partition +@item gmsh/model/mesh/partition Partition the mesh of the current model into @code{numPart} partitions. @table @asis @@ -739,7 +739,7 @@ Partition the mesh of the current model into @code{numPart} partitions. - @end table -@item unpartition +@item gmsh/model/mesh/unpartition Unpartition the mesh of the current model. @table @asis @@ -751,7 +751,7 @@ Unpartition the mesh of the current model. - @end table -@item optimize +@item gmsh/model/mesh/optimize Optimize the mesh of the current model using @code{method} (empty for default tetrahedral mesh optimizer, "Netgen" for Netgen optimizer, "HighOrder" for direct high-order mesh optimizer, "HighOrderElastic" for high-order elastic @@ -769,7 +769,7 @@ Laplace smoothing, "Relocate2D" and "Relocate3D" for node relocation). If - @end table -@item recombine +@item gmsh/model/mesh/recombine Recombine the mesh of the current model. @table @asis @@ -781,7 +781,7 @@ Recombine the mesh of the current model. - @end table -@item refine +@item gmsh/model/mesh/refine Refine the mesh of the current model by uniformly splitting the elements. @table @asis @@ -793,7 +793,7 @@ Refine the mesh of the current model by uniformly splitting the elements. - @end table -@item setOrder +@item gmsh/model/mesh/setOrder Set the order of the elements in the mesh of the current model to @code{order}. @table @asis @@ -805,7 +805,7 @@ Set the order of the elements in the mesh of the current model to @code{order}. - @end table -@item getLastEntityError +@item gmsh/model/mesh/getLastEntityError Get the last entities (if any) where a meshing error occurred. Currently only populated by the new 3D meshing algorithms. @@ -818,7 +818,7 @@ populated by the new 3D meshing algorithms. - @end table -@item getLastNodeError +@item gmsh/model/mesh/getLastNodeError Get the last nodes (if any) where a meshing error occurred. Currently only populated by the new 3D meshing algorithms. @@ -831,7 +831,7 @@ populated by the new 3D meshing algorithms. - @end table -@item clear +@item gmsh/model/mesh/clear Clear the mesh, i.e. delete all the nodes and elements. @table @asis @@ -843,7 +843,7 @@ Clear the mesh, i.e. delete all the nodes and elements. - @end table -@item getNodes +@item gmsh/model/mesh/getNodes Get the nodes classified on the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the nodes for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the nodes in the @@ -867,7 +867,7 @@ the entity if @code{dim} >= 0 in order to compute their parametric coordinates). - @end table -@item getNodesByElementType +@item gmsh/model/mesh/getNodesByElementType Get the nodes classified on the entity of tag @code{tag}, for all the elements of type @code{elementType}. The other arguments are treated as in @code{getNodes}. @@ -881,7 +881,7 @@ of type @code{elementType}. The other arguments are treated as in - @end table -@item getNode +@item gmsh/model/mesh/getNode Get the coordinates and the parametric coordinates (if any) of the node with tag @code{tag}. This is a sometimes useful but inefficient way of accessing nodes, as it relies on a cache stored in the model. For large meshes all the nodes in @@ -898,7 +898,7 @@ vector; otherwise it uses a map). - @end table -@item setNode +@item gmsh/model/mesh/setNode Set the coordinates and the parametric coordinates (if any) of the node with tag @code{tag}. This is a sometimes useful but inefficient way of accessing nodes, as it relies on a cache stored in the model. For large meshes all the nodes in @@ -914,7 +914,7 @@ from 1 to N. - @end table -@item rebuildNodeCache +@item gmsh/model/mesh/rebuildNodeCache Rebuild the node cache. @table @asis @@ -926,7 +926,7 @@ Rebuild the node cache. - @end table -@item getNodesForPhysicalGroup +@item gmsh/model/mesh/getNodesForPhysicalGroup Get the nodes from all the elements belonging to the physical group of dimension @code{dim} and tag @code{tag}. @code{nodeTags} contains the node tags; @code{coord} is a vector of length 3 times the length of @code{nodeTags} that @@ -942,7 +942,7 @@ n2x, ...]. - @end table -@item addNodes +@item gmsh/model/mesh/addNodes Add nodes classified on the model entity of dimension @code{dim} and tag @code{tag}. @code{nodeTags} contains the node tags (their unique, strictly positive identification numbers). @code{coord} is a vector of length 3 times the @@ -962,7 +962,7 @@ automatically assigned to the nodes. - @end table -@item reclassifyNodes +@item gmsh/model/mesh/reclassifyNodes Reclassify all nodes on their associated model entity, based on the elements. Can be used when importing nodes in bulk (e.g. by associating them all to a single volume), to reclassify them correctly on model surfaces, curves, etc. @@ -977,7 +977,7 @@ after the elements have been set. - @end table -@item relocateNodes +@item gmsh/model/mesh/relocateNodes Relocate the nodes classified on the entity of dimension @code{dim} and tag @code{tag} using their parametric coordinates. If @code{tag} < 0, relocate the nodes for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are @@ -992,7 +992,7 @@ negative, relocate all the nodes in the mesh. - @end table -@item getElements +@item gmsh/model/mesh/getElements Get the elements classified on the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the elements for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the elements in @@ -1016,7 +1016,7 @@ that contains the node tags of all the elements of the given type, concatenated: - @end table -@item getElement +@item gmsh/model/mesh/getElement Get the type and node tags of the element with tag @code{tag}. This is a sometimes useful but inefficient way of accessing elements, as it relies on a cache stored in the model. For large meshes all the elements in the model should @@ -1033,7 +1033,7 @@ uses a map). - @end table -@item getElementByCoordinates +@item gmsh/model/mesh/getElementByCoordinates Search the mesh for an element located at coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, as it relies on a search in a spatial octree. If an element is found, return its @@ -1051,7 +1051,7 @@ set, use a tolerance to find elements near the search location. - @end table -@item getElementsByCoordinates +@item gmsh/model/mesh/getElementsByCoordinates Search the mesh for element(s) located at coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, as it relies on a search in a spatial octree. Return the tags of all found @@ -1070,7 +1070,7 @@ location. - @end table -@item getLocalCoordinatesInElement +@item gmsh/model/mesh/getLocalCoordinatesInElement Return the local coordinates (@code{u}, @code{v}, @code{w}) within the element @code{elementTag} corresponding to the model coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, @@ -1085,7 +1085,7 @@ as it relies on a cache stored in the model. - @end table -@item getElementTypes +@item gmsh/model/mesh/getElementTypes Get the types of elements in the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the types for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the types in the @@ -1100,7 +1100,7 @@ mesh. - @end table -@item getElementType +@item gmsh/model/mesh/getElementType Return an element type given its family name @code{familyName} ("point", "line", "triangle", "quadrangle", "tetrahedron", "pyramid", "prism", "hexahedron") and polynomial order @code{order}. If @code{serendip} is true, return the @@ -1115,7 +1115,7 @@ corresponding serendip element type (element without interior nodes). integer value @end table -@item getElementProperties +@item gmsh/model/mesh/getElementProperties Get the properties of an element of type @code{elementType}: its name (@code{elementName}), dimension (@code{dim}), order (@code{order}), number of nodes (@code{numNodes}), coordinates of the nodes in the reference element @@ -1131,7 +1131,7 @@ of primary (first order) nodes (@code{numPrimaryNodes}). - @end table -@item getElementsByType +@item gmsh/model/mesh/getElementsByType Get the elements of type @code{elementType} classified on the entity of tag @code{tag}. If @code{tag} < 0, get the elements for all entities. @code{elementTags} is a vector containing the tags (unique, strictly positive @@ -1151,7 +1151,7 @@ indexed by @code{task}. - @end table -@item preallocateElementsByType +@item gmsh/model/mesh/preallocateElementsByType Preallocate data before calling @code{getElementsByType} with @code{numTasks} > 1. For C and C++ only. @@ -1164,7 +1164,7 @@ Preallocate data before calling @code{getElementsByType} with @code{numTasks} > - @end table -@item addElements +@item gmsh/model/mesh/addElements Add elements classified on the entity of dimension @code{dim} and tag @code{tag}. @code{types} contains the MSH types of the elements (e.g. @code{2} for 3-node triangles: see the Gmsh reference manual). @code{elementTags} is a @@ -1185,7 +1185,7 @@ e1nN, e2n1, ...]. - @end table -@item addElementsByType +@item gmsh/model/mesh/addElementsByType Add elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{elementTags} contains the tags (unique, strictly positive identifiers) of the elements of the corresponding type. @code{nodeTags} is a @@ -1203,7 +1203,7 @@ are automatically assigned to the elements. - @end table -@item getIntegrationPoints +@item gmsh/model/mesh/getIntegrationPoints Get the numerical quadrature information for the given element type @code{elementType} and integration rule @code{integrationType} (e.g. "Gauss4" for a Gauss quadrature suited for integrating 4th order polynomials). @@ -1220,7 +1220,7 @@ points in the reference element: [g1u, g1v, g1w, ..., gGu, gGv, gGw]. - @end table -@item getJacobians +@item gmsh/model/mesh/getJacobians Get the Jacobians of all the elements of type @code{elementType} classified on the entity of tag @code{tag}, at the G integration points @code{integrationPoints} given as concatenated triplets of coordinates in the @@ -1245,7 +1245,7 @@ and return the part of the data indexed by @code{task}. - @end table -@item preallocateJacobians +@item gmsh/model/mesh/preallocateJacobians Preallocate data before calling @code{getJacobians} with @code{numTasks} > 1. For C and C++ only. @@ -1258,7 +1258,7 @@ For C and C++ only. - @end table -@item getBasisFunctions +@item gmsh/model/mesh/getBasisFunctions Get the basis functions of the element of type @code{elementType} at the integration points @code{integrationPoints} (given as concatenated triplets of coordinates in the reference element [g1u, g1v, g1w, ..., gGu, gGv, gGw]), for @@ -1278,7 +1278,7 @@ when C == 1 or [g1f1u, g1f1v, g1f1w, g1f2u, ..., g1fNw, g2f1u, ...] when C == 3. - @end table -@item getBasisFunctionsForElements +@item gmsh/model/mesh/getBasisFunctionsForElements Get the element-dependent basis functions of the elements of type @code{elementType} in the entity of tag @code{tag}at the integration points @code{integrationPoints} (given as concatenated triplets of coordinates in the @@ -1303,7 +1303,7 @@ return the part of the data indexed by @code{task}. - @end table -@item preallocateBasisFunctions +@item gmsh/model/mesh/preallocateBasisFunctions Preallocate data before calling @code{getBasisFunctionsForElements} with @code{numTasks} > 1. For C and C++ only. @@ -1316,7 +1316,7 @@ Preallocate data before calling @code{getBasisFunctionsForElements} with - @end table -@item getKeysForElements +@item gmsh/model/mesh/getKeysForElements Generate the @code{keys} for the elements of type @code{elementType} in the entity of tag @code{tag}, for the @code{functionSpaceType} function space. Each key uniquely identifies a basis function in the function space. If @@ -1333,7 +1333,7 @@ experimental feature and will probably change in a future release. - @end table -@item getNumberOfKeysForElements +@item gmsh/model/mesh/getNumberOfKeysForElements Get the number of keys by elements of type @code{elementType} for function space named @code{functionSpaceType}. @@ -1346,7 +1346,7 @@ named @code{functionSpaceType}. integer value @end table -@item getInformationForElements +@item gmsh/model/mesh/getInformationForElements Get information about the @code{keys}. @code{infoKeys} returns information about the functions associated with the @code{keys}. @code{infoKeys[0].first} describes the type of function (0 for vertex function, 1 for edge function, 2 @@ -1363,7 +1363,7 @@ experimental feature and will probably change in a future release. - @end table -@item precomputeBasisFunctions +@item gmsh/model/mesh/precomputeBasisFunctions Precomputes the basis functions corresponding to @code{elementType}. @table @asis @@ -1375,7 +1375,7 @@ Precomputes the basis functions corresponding to @code{elementType}. - @end table -@item getBarycenters +@item gmsh/model/mesh/getBarycenters Get the barycenters of all elements of type @code{elementType} classified on the entity of tag @code{tag}. If @code{primary} is set, only the primary nodes of the elements are taken into account for the barycenter calculation. If @@ -1393,7 +1393,7 @@ the part of the data indexed by @code{task}. - @end table -@item preallocateBarycenters +@item gmsh/model/mesh/preallocateBarycenters Preallocate data before calling @code{getBarycenters} with @code{numTasks} > 1. For C and C++ only. @@ -1406,7 +1406,7 @@ For C and C++ only. - @end table -@item getElementEdgeNodes +@item gmsh/model/mesh/getElementEdgeNodes Get the nodes on the edges of all elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the edges for all the elements: [e1a1n1, e1a1n2, e1a2n1, ...]. Data is returned by @@ -1425,7 +1425,7 @@ indexed by @code{task}. - @end table -@item getElementFaceNodes +@item gmsh/model/mesh/getElementFaceNodes Get the nodes on the faces of type @code{faceType} (3 for triangular faces, 4 for quadrangular faces) of all elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the @@ -1445,7 +1445,7 @@ the data indexed by @code{task}. - @end table -@item getGhostElements +@item gmsh/model/mesh/getGhostElements Get the ghost elements @code{elementTags} and their associated @code{partitions} stored in the ghost entity of dimension @code{dim} and tag @code{tag}. @@ -1458,7 +1458,7 @@ stored in the ghost entity of dimension @code{dim} and tag @code{tag}. - @end table -@item setSize +@item gmsh/model/mesh/setSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -1471,7 +1471,7 @@ entities of dimension 0 (points) are handled. - @end table -@item setTransfiniteCurve +@item gmsh/model/mesh/setTransfiniteCurve Set a transfinite meshing constraint on the curve @code{tag}, with @code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. Currently supported types are "Progression" (geometrical progression with power @@ -1486,7 +1486,7 @@ Currently supported types are "Progression" (geometrical progression with power - @end table -@item setTransfiniteSurface +@item gmsh/model/mesh/setTransfiniteSurface Set a transfinite meshing constraint on the surface @code{tag}. @code{arrangement} describes the arrangement of the triangles when the surface is not flagged as recombined: currently supported values are "Left", "Right", @@ -1504,7 +1504,7 @@ its boundary. - @end table -@item setTransfiniteVolume +@item gmsh/model/mesh/setTransfiniteVolume Set a transfinite meshing constraint on the surface @code{tag}. @code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite interpolation explicitly. @@ -1518,7 +1518,7 @@ interpolation explicitly. - @end table -@item setRecombine +@item gmsh/model/mesh/setRecombine Set a recombination meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to recombine triangles into quadrangles) are supported. @@ -1532,7 +1532,7 @@ recombine triangles into quadrangles) are supported. - @end table -@item setSmoothing +@item gmsh/model/mesh/setSmoothing Set a smoothing meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. @@ -1545,7 +1545,7 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @end table -@item setReverse +@item gmsh/model/mesh/setReverse Set a reverse meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed with respect to the natural mesh orientation (i.e. the orientation consistent @@ -1561,7 +1561,7 @@ as-is. - @end table -@item setAlgorithm +@item gmsh/model/mesh/setAlgorithm Set the meshing algorithm on the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -1574,7 +1574,7 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @end table -@item setSizeFromBoundary +@item gmsh/model/mesh/setSizeFromBoundary Force the mesh size to be extended from the boundary, or not, for the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -1588,7 +1588,7 @@ entity of dimension @code{dim} and tag @code{tag}. Currently only supported for - @end table -@item setCompound +@item gmsh/model/mesh/setCompound Set a compound meshing constraint on the model entities of dimension @code{dim} and tags @code{tags}. During meshing, compound entities are treated as a single discrete entity, which is automatically reparametrized. @@ -1602,7 +1602,7 @@ discrete entity, which is automatically reparametrized. - @end table -@item setOutwardOrientation +@item gmsh/model/mesh/setOutwardOrientation Set meshing constraints on the bounding surfaces of the volume of tag @code{tag} so that all surfaces are oriented with outward pointing normals. Currently only available with the OpenCASCADE kernel, as it relies on the STL triangulation. @@ -1616,7 +1616,7 @@ available with the OpenCASCADE kernel, as it relies on the STL triangulation. - @end table -@item embed +@item gmsh/model/mesh/embed Embed the model entities of dimension @code{dim} and tags @code{tags} in the (@code{inDim}, @code{inTag}) model entity. The dimension @code{dim} can 0, 1 or 2 and must be strictly smaller than @code{inDim}, which must be either 2 or 3. @@ -1632,7 +1632,7 @@ The embedded entities should not be part of the boundary of the entity - @end table -@item removeEmbedded +@item gmsh/model/mesh/removeEmbedded Remove embedded entities from the model entities @code{dimTags}. if @code{dim} is >= 0, only remove embedded entities of the given dimension (e.g. embedded points if @code{dim} == 0). @@ -1646,7 +1646,7 @@ points if @code{dim} == 0). - @end table -@item reorderElements +@item gmsh/model/mesh/reorderElements Reorder the elements of type @code{elementType} classified on the entity of tag @code{tag} according to @code{ordering}. @@ -1659,7 +1659,7 @@ Reorder the elements of type @code{elementType} classified on the entity of tag - @end table -@item renumberNodes +@item gmsh/model/mesh/renumberNodes Renumber the node tags in a continuous sequence. @table @asis @@ -1671,7 +1671,7 @@ Renumber the node tags in a continuous sequence. - @end table -@item renumberElements +@item gmsh/model/mesh/renumberElements Renumber the element tags in a continuous sequence. @table @asis @@ -1683,7 +1683,7 @@ Renumber the element tags in a continuous sequence. - @end table -@item setPeriodic +@item gmsh/model/mesh/setPeriodic Set the meshes of the entities of dimension @code{dim} and tag @code{tags} as periodic copies of the meshes of entities @code{tagsMaster}, using the affine transformation specified in @code{affineTransformation} (16 entries of a 4x4 @@ -1702,7 +1702,7 @@ and @code{dim} == 2. - @end table -@item getPeriodicNodes +@item gmsh/model/mesh/getPeriodicNodes Get the master entity @code{tagMaster}, the node tags @code{nodeTags} and their corresponding master node tags @code{nodeTagsMaster}, and the affine transform @code{affineTransform} for the entity of dimension @code{dim} and tag @@ -1717,7 +1717,7 @@ corresponding master node tags @code{nodeTagsMaster}, and the affine transform - @end table -@item removeDuplicateNodes +@item gmsh/model/mesh/removeDuplicateNodes Remove duplicate nodes in the mesh of the current model. @table @asis @@ -1729,7 +1729,7 @@ Remove duplicate nodes in the mesh of the current model. - @end table -@item splitQuadrangles +@item gmsh/model/mesh/splitQuadrangles Split (into two triangles) all quadrangles in surface @code{tag} whose quality is lower than @code{quality}. If @code{tag} < 0, split quadrangles in all surfaces. @@ -1743,7 +1743,7 @@ surfaces. - @end table -@item classifySurfaces +@item gmsh/model/mesh/classifySurfaces Classify ("color") the surface mesh based on the angle threshold @code{angle} (in radians), and create new discrete surfaces, curves and points accordingly. If @code{boundary} is set, also create discrete curves on the boundary if the @@ -1760,7 +1760,7 @@ less than Pi, also force curves to be split according to @code{curveAngle}. - @end table -@item createGeometry +@item gmsh/model/mesh/createGeometry Create a parametrization for discrete curves and surfaces (i.e. curves and surfaces represented solely by a mesh, without an underlying CAD description), assuming that each can be parametrized with a single map. @@ -1774,7 +1774,7 @@ assuming that each can be parametrized with a single map. - @end table -@item createTopology +@item gmsh/model/mesh/createTopology Create a boundary representation from the mesh if the model does not have one (e.g. when imported from mesh file formats with no BRep representation of the underlying model). @@ -1788,7 +1788,7 @@ underlying model). - @end table -@item computeHomology +@item gmsh/model/mesh/computeHomology Compute a basis representation for homology spaces after a mesh has been generated. The computation domain is given in a list of physical group tags @code{domainTags}; if empty, the whole mesh is the domain. The computation @@ -1807,7 +1807,7 @@ as physical groups in the mesh. - @end table -@item computeCohomology +@item gmsh/model/mesh/computeCohomology Compute a basis representation for cohomology spaces after a mesh has been generated. The computation domain is given in a list of physical group tags @code{domainTags}; if empty, the whole mesh is the domain. The computation @@ -1826,7 +1826,7 @@ stored as physical groups in the mesh. - @end table -@item computeCrossField +@item gmsh/model/mesh/computeCrossField Compute a cross field for the current mesh. The function creates 3 views: the H function, the Theta function and cross directions. Return the tags of the views @@ -1845,7 +1845,7 @@ function, the Theta function and cross directions. Return the tags of the views @section Namespace @code{gmsh/model/mesh/field}: mesh size field functions @ftable @code -@item add +@item gmsh/model/mesh/field/add Add a new mesh size field of type @code{fieldType}. If @code{tag} is positive, assign the tag explicitly; otherwise a new tag is assigned automatically. Return the field tag. @@ -1859,7 +1859,7 @@ the field tag. integer value @end table -@item remove +@item gmsh/model/mesh/field/remove Remove the field with tag @code{tag}. @table @asis @@ -1871,7 +1871,7 @@ Remove the field with tag @code{tag}. - @end table -@item setNumber +@item gmsh/model/mesh/field/setNumber Set the numerical option @code{option} to value @code{value} for field @code{tag}. @@ -1884,7 +1884,7 @@ Set the numerical option @code{option} to value @code{value} for field - @end table -@item setString +@item gmsh/model/mesh/field/setString Set the string option @code{option} to value @code{value} for field @code{tag}. @table @asis @@ -1896,7 +1896,7 @@ Set the string option @code{option} to value @code{value} for field @code{tag}. - @end table -@item setNumbers +@item gmsh/model/mesh/field/setNumbers Set the numerical list option @code{option} to value @code{value} for field @code{tag}. @@ -1909,7 +1909,7 @@ Set the numerical list option @code{option} to value @code{value} for field - @end table -@item setAsBackgroundMesh +@item gmsh/model/mesh/field/setAsBackgroundMesh Set the field @code{tag} as the background mesh size field. @table @asis @@ -1921,7 +1921,7 @@ Set the field @code{tag} as the background mesh size field. - @end table -@item setAsBoundaryLayer +@item gmsh/model/mesh/field/setAsBoundaryLayer Set the field @code{tag} as a boundary layer size field. @table @asis @@ -1939,7 +1939,7 @@ Set the field @code{tag} as a boundary layer size field. @section Namespace @code{gmsh/model/geo}: built-in CAD kernel functions @ftable @code -@item addPoint +@item gmsh/model/geo/addPoint Add a geometrical point in the built-in CAD representation, at coordinates (@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing constraint at that point. If @code{tag} is positive, set the tag explicitly; @@ -1957,7 +1957,7 @@ the geo module.) integer value @end table -@item addLine +@item gmsh/model/geo/addLine Add a straight line segment between the two points with tags @code{startTag} and @code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the line. @@ -1971,7 +1971,7 @@ new tag is selected automatically. Return the tag of the line. integer value @end table -@item addCircleArc +@item gmsh/model/geo/addCircleArc Add a circle arc (strictly smaller than Pi) between the two points with tags @code{startTag} and @code{endTag}, with center @code{centertag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -1987,7 +1987,7 @@ the plane of the circle arc. Return the tag of the circle arc. integer value @end table -@item addEllipseArc +@item gmsh/model/geo/addEllipseArc Add an ellipse arc (strictly smaller than Pi) between the two points @code{startTag} and @code{endTag}, with center @code{centerTag} and major axis point @code{majorTag}. If @code{tag} is positive, set the tag explicitly; @@ -2004,7 +2004,7 @@ tag of the ellipse arc. integer value @end table -@item addSpline +@item gmsh/model/geo/addSpline Add a spline (Catmull-Rom) curve going through the points @code{pointTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Create a periodic curve if the first and last points are the @@ -2019,7 +2019,7 @@ same. Return the tag of the spline curve. integer value @end table -@item addBSpline +@item gmsh/model/geo/addBSpline Add a cubic b-spline curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Creates a periodic curve if the first and last points are the @@ -2034,7 +2034,7 @@ same. Return the tag of the b-spline curve. integer value @end table -@item addBezier +@item gmsh/model/geo/addBezier Add a Bezier curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the Bezier curve. @@ -2048,7 +2048,7 @@ Return the tag of the Bezier curve. integer value @end table -@item addCompoundSpline +@item gmsh/model/geo/addCompoundSpline Add a spline (Catmull-Rom) going through points sampling the curves in @code{curveTags}. The density of sampling points on each curve is governed by @code{numIntervals}. If @code{tag} is positive, set the tag explicitly; @@ -2063,7 +2063,7 @@ otherwise a new tag is selected automatically. Return the tag of the spline. integer value @end table -@item addCompoundBSpline +@item gmsh/model/geo/addCompoundBSpline Add a b-spline with control points sampling the curves in @code{curveTags}. The density of sampling points on each curve is governed by @code{numIntervals}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2078,7 +2078,7 @@ automatically. Return the tag of the b-spline. integer value @end table -@item addCurveLoop +@item gmsh/model/geo/addCurveLoop Add a curve loop (a closed wire) formed by the curves @code{curveTags}. @code{curveTags} should contain (signed) tags of model enties of dimension 1 forming a closed loop: a negative tag signifies that the underlying curve is @@ -2095,7 +2095,7 @@ curve loop. integer value @end table -@item addPlaneSurface +@item gmsh/model/geo/addPlaneSurface Add a plane surface defined by one or more curve loops @code{wireTags}. The first curve loop defines the exterior contour; additional curve loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is @@ -2110,7 +2110,7 @@ selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceFilling +@item gmsh/model/geo/addSurfaceFilling Add a surface filling the curve loops in @code{wireTags}. Currently only a single curve loop is supported; this curve loop should be composed by 3 or 4 curves only. If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2125,7 +2125,7 @@ tag is selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceLoop +@item gmsh/model/geo/addSurfaceLoop Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the shell. @@ -2139,7 +2139,7 @@ automatically. Return the tag of the shell. integer value @end table -@item addVolume +@item gmsh/model/geo/addVolume Add a volume (a region) defined by one or more shells @code{shellTags}. The first surface loop defines the exterior boundary; additional surface loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is @@ -2154,7 +2154,7 @@ selected automatically. Return the tag of the volume. integer value @end table -@item extrude +@item gmsh/model/geo/extrude Extrude the model entities @code{dimTags} by translation along (@code{dx}, @code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If @code{numElements} is not empty, also extrude the mesh: the entries in @@ -2172,7 +2172,7 @@ extruded along their normal. - @end table -@item revolve +@item gmsh/model/geo/revolve Extrude the model entities @code{dimTags} by rotation of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). The angle should @@ -2191,7 +2191,7 @@ normalized to 1. - @end table -@item twist +@item gmsh/model/geo/twist Extrude the model entities @code{dimTags} by a combined translation and rotation of @code{angle} radians, along (@code{dx}, @code{dy}, @code{dz}) and around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the @@ -2211,7 +2211,7 @@ normalized to 1. - @end table -@item translate +@item gmsh/model/geo/translate Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, @code{dz}). @@ -2224,7 +2224,7 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @end table -@item rotate +@item gmsh/model/geo/rotate Rotate the model entities @code{dimTags} of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). @@ -2238,7 +2238,7 @@ direction (@code{ax}, @code{ay}, @code{az}). - @end table -@item dilate +@item gmsh/model/geo/dilate Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and @code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as the center of the homothetic transformation. @@ -2252,7 +2252,7 @@ the center of the homothetic transformation. - @end table -@item symmetrize +@item gmsh/model/geo/symmetrize Apply a symmetry transformation to the model entities @code{dimTag}, with respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. @@ -2266,7 +2266,7 @@ respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + - @end table -@item copy +@item gmsh/model/geo/copy Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags}. @@ -2279,7 +2279,7 @@ Copy the entities @code{dimTags}; the new entities are returned in - @end table -@item remove +@item gmsh/model/geo/remove Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -2292,7 +2292,7 @@ entities on their boundaries, down to dimension 0. - @end table -@item removeAllDuplicates +@item gmsh/model/geo/removeAllDuplicates Remove all duplicate entities (different entities at the same geometrical location). @@ -2305,7 +2305,7 @@ location). - @end table -@item synchronize +@item gmsh/model/geo/synchronize Synchronize the built-in CAD representation with the current Gmsh model. This can be called at any time, but since it involves a non trivial amount of processing, the number of synchronization points should normally be minimized. @@ -2325,7 +2325,7 @@ processing, the number of synchronization points should normally be minimized. @section Namespace @code{gmsh/model/geo/mesh}: built-in CAD kernel meshing constraints @ftable @code -@item setSize +@item gmsh/model/geo/mesh/setSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -2338,7 +2338,7 @@ entities of dimension 0 (points) are handled. - @end table -@item setTransfiniteCurve +@item gmsh/model/geo/mesh/setTransfiniteCurve Set a transfinite meshing constraint on the curve @code{tag}, with @code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. Currently supported types are "Progression" (geometrical progression with power @@ -2353,7 +2353,7 @@ Currently supported types are "Progression" (geometrical progression with power - @end table -@item setTransfiniteSurface +@item gmsh/model/geo/mesh/setTransfiniteSurface Set a transfinite meshing constraint on the surface @code{tag}. @code{arrangement} describes the arrangement of the triangles when the surface is not flagged as recombined: currently supported values are "Left", "Right", @@ -2371,7 +2371,7 @@ its boundary. - @end table -@item setTransfiniteVolume +@item gmsh/model/geo/mesh/setTransfiniteVolume Set a transfinite meshing constraint on the surface @code{tag}. @code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite interpolation explicitly. @@ -2385,7 +2385,7 @@ interpolation explicitly. - @end table -@item setRecombine +@item gmsh/model/geo/mesh/setRecombine Set a recombination meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to recombine triangles into quadrangles) are supported. @@ -2399,7 +2399,7 @@ recombine triangles into quadrangles) are supported. - @end table -@item setSmoothing +@item gmsh/model/geo/mesh/setSmoothing Set a smoothing meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. @@ -2412,7 +2412,7 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @end table -@item setReverse +@item gmsh/model/geo/mesh/setReverse Set a reverse meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed with respect to the natural mesh orientation (i.e. the orientation consistent @@ -2428,7 +2428,7 @@ as-is. - @end table -@item setAlgorithm +@item gmsh/model/geo/mesh/setAlgorithm Set the meshing algorithm on the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -2441,7 +2441,7 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @end table -@item setSizeFromBoundary +@item gmsh/model/geo/mesh/setSizeFromBoundary Force the mesh size to be extended from the boundary, or not, for the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -2461,7 +2461,7 @@ entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @section Namespace @code{gmsh/model/occ}: OpenCASCADE CAD kernel functions @ftable @code -@item addPoint +@item gmsh/model/occ/addPoint Add a geometrical point in the OpenCASCADE CAD representation, at coordinates (@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing constraint at that point. If @code{tag} is positive, set the tag explicitly; @@ -2479,7 +2479,7 @@ the occ module.) integer value @end table -@item addLine +@item gmsh/model/occ/addLine Add a straight line segment between the two points with tags @code{startTag} and @code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the line. @@ -2493,7 +2493,7 @@ new tag is selected automatically. Return the tag of the line. integer value @end table -@item addCircleArc +@item gmsh/model/occ/addCircleArc Add a circle arc between the two points with tags @code{startTag} and @code{endTag}, with center @code{centerTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of @@ -2508,7 +2508,7 @@ the circle arc. integer value @end table -@item addCircle +@item gmsh/model/occ/addCircle Add a circle of center (@code{x}, @code{y}, @code{z}) and radius @code{r}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. If @code{angle1} and @code{angle2} are specified, create a circle @@ -2523,7 +2523,7 @@ arc between the two angles. Return the tag of the circle. integer value @end table -@item addEllipseArc +@item gmsh/model/occ/addEllipseArc Add an ellipse arc between the two points @code{startTag} and @code{endTag}, with center @code{centerTag} and major axis point @code{majorTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2539,7 +2539,7 @@ allow creating ellipse arcs with the major radius smaller than the minor radius. integer value @end table -@item addEllipse +@item gmsh/model/occ/addEllipse Add an ellipse of center (@code{x}, @code{y}, @code{z}) and radii @code{r1} and @code{r2} along the x- and y-axes respectively. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. If @@ -2558,7 +2558,7 @@ in such cases. integer value @end table -@item addSpline +@item gmsh/model/occ/addSpline Add a spline (C2 b-spline) curve going through the points @code{pointTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Create a periodic curve if the first and last points are the @@ -2573,7 +2573,7 @@ same. Return the tag of the spline curve. integer value @end table -@item addBSpline +@item gmsh/model/occ/addBSpline Add a b-spline curve of degree @code{degree} with @code{pointTags} control points. If @code{weights}, @code{knots} or @code{multiplicities} are not provided, default parameters are computed automatically. If @code{tag} is @@ -2590,7 +2590,7 @@ tag of the b-spline curve. integer value @end table -@item addBezier +@item gmsh/model/occ/addBezier Add a Bezier curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the Bezier curve. @@ -2604,7 +2604,7 @@ Return the tag of the Bezier curve. integer value @end table -@item addWire +@item gmsh/model/occ/addWire Add a wire (open or closed) formed by the curves @code{curveTags}. Note that an OpenCASCADE wire can be made of curves that share geometrically identical (but topologically different) points. If @code{tag} is positive, set the tag @@ -2620,7 +2620,7 @@ wire. integer value @end table -@item addCurveLoop +@item gmsh/model/occ/addCurveLoop Add a curve loop (a closed wire) formed by the curves @code{curveTags}. @code{curveTags} should contain tags of curves forming a closed loop. Note that an OpenCASCADE curve loop can be made of curves that share geometrically @@ -2637,7 +2637,7 @@ tag of the curve loop. integer value @end table -@item addRectangle +@item gmsh/model/occ/addRectangle Add a rectangle with lower left corner at (@code{x}, @code{y}, @code{z}) and upper right corner at (@code{x} + @code{dx}, @code{y} + @code{dy}, @code{z}). If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2653,7 +2653,7 @@ tag of the rectangle. integer value @end table -@item addDisk +@item gmsh/model/occ/addDisk Add a disk with center (@code{xc}, @code{yc}, @code{zc}) and radius @code{rx} along the x-axis and @code{ry} along the y-axis. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the @@ -2668,7 +2668,7 @@ tag of the disk. integer value @end table -@item addPlaneSurface +@item gmsh/model/occ/addPlaneSurface Add a plane surface defined by one or more curve loops (or closed wires) @code{wireTags}. The first curve loop defines the exterior contour; additional curve loop define holes. If @code{tag} is positive, set the tag explicitly; @@ -2683,7 +2683,7 @@ otherwise a new tag is selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceFilling +@item gmsh/model/occ/addSurfaceFilling Add a surface filling the curve loops in @code{wireTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the surface. If @code{pointTags} are provided, force the @@ -2698,7 +2698,7 @@ surface to pass through the given points. integer value @end table -@item addSurfaceLoop +@item gmsh/model/occ/addSurfaceLoop Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the surface loop. Setting @code{sewing} allows @@ -2714,7 +2714,7 @@ topologically different) curves. integer value @end table -@item addVolume +@item gmsh/model/occ/addVolume Add a volume (a region) defined by one or more surface loops @code{shellTags}. The first surface loop defines the exterior boundary; additional surface loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2729,7 +2729,7 @@ tag is selected automatically. Return the tag of the volume. integer value @end table -@item addSphere +@item gmsh/model/occ/addSphere Add a sphere of center (@code{xc}, @code{yc}, @code{zc}) and radius @code{r}. The optional @code{angle1} and @code{angle2} arguments define the polar angle opening (from -Pi/2 to Pi/2). The optional @code{angle3} argument defines the @@ -2746,7 +2746,7 @@ sphere. integer value @end table -@item addBox +@item gmsh/model/occ/addBox Add a parallelepipedic box defined by a point (@code{x}, @code{y}, @code{z}) and the extents along the x-, y- and z-axes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the @@ -2761,7 +2761,7 @@ box. integer value @end table -@item addCylinder +@item gmsh/model/occ/addCylinder Add a cylinder, defined by the center (@code{x}, @code{y}, @code{z}) of its first circular face, the 3 components (@code{dx}, @code{dy}, @code{dz}) of the vector defining its axis and its radius @code{r}. The optional @code{angle} @@ -2778,7 +2778,7 @@ Return the tag of the cylinder. integer value @end table -@item addCone +@item gmsh/model/occ/addCone Add a cone, defined by the center (@code{x}, @code{y}, @code{z}) of its first circular face, the 3 components of the vector (@code{dx}, @code{dy}, @code{dz}) defining its axis and the two radii @code{r1} and @code{r2} of the faces (these @@ -2795,7 +2795,7 @@ opening (from 0 to 2*Pi). Return the tag of the cone. integer value @end table -@item addWedge +@item gmsh/model/occ/addWedge Add a right angular wedge, defined by the right-angle point (@code{x}, @code{y}, @code{z}) and the 3 extends along the x-, y- and z-axes (@code{dx}, @code{dy}, @code{dz}). If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2811,7 +2811,7 @@ extent along the x-axis. Return the tag of the wedge. integer value @end table -@item addTorus +@item gmsh/model/occ/addTorus Add a torus, defined by its center (@code{x}, @code{y}, @code{z}) and its 2 radii @code{r} and @code{r2}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. The optional argument @@ -2827,7 +2827,7 @@ wedge. integer value @end table -@item addThruSections +@item gmsh/model/occ/addThruSections Add a volume (if the optional argument @code{makeSolid} is set) or surfaces defined through the open or closed wires @code{wireTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. @@ -2844,7 +2844,7 @@ ruled surfaces. - @end table -@item addThickSolid +@item gmsh/model/occ/addThickSolid Add a hollowed volume built from an initial volume @code{volumeTag} and a set of faces from this volume @code{excludeSurfaceTags}, which are to be removed. The remaining faces of the volume become the walls of the hollowed solid, with @@ -2860,7 +2860,7 @@ otherwise a new tag is selected automatically. - @end table -@item extrude +@item gmsh/model/occ/extrude Extrude the model entities @code{dimTags} by translation along (@code{dx}, @code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If @code{numElements} is not empty, also extrude the mesh: the entries in @@ -2877,7 +2877,7 @@ normalized to 1. - @end table -@item revolve +@item gmsh/model/occ/revolve Extrude the model entities @code{dimTags} by rotation of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). Return extruded @@ -2896,7 +2896,7 @@ strictly smaller than 2*Pi. - @end table -@item addPipe +@item gmsh/model/occ/addPipe Add a pipe by extruding the entities @code{dimTags} along the wire @code{wireTag}. Return the pipe in @code{outDimTags}. @@ -2909,7 +2909,7 @@ Add a pipe by extruding the entities @code{dimTags} along the wire - @end table -@item fillet +@item gmsh/model/occ/fillet Fillet the volumes @code{volumeTags} on the curves @code{curveTags} with radii @code{radii}. The @code{radii} vector can either contain a single radius, as many radii as @code{curveTags}, or twice as many as @code{curveTags} (in which @@ -2926,7 +2926,7 @@ Return the filleted entities in @code{outDimTags}. Remove the original volume if - @end table -@item chamfer +@item gmsh/model/occ/chamfer Chamfer the volumes @code{volumeTags} on the curves @code{curveTags} with distances @code{distances} measured on surfaces @code{surfaceTags}. The @code{distances} vector can either contain a single distance, as many distances @@ -2945,7 +2945,7 @@ original volume if @code{removeVolume} is set. - @end table -@item fuse +@item gmsh/model/occ/fuse Compute the boolean union (the fusion) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly (only valid if the boolean @@ -2961,7 +2961,7 @@ is set. Remove the tool if @code{removeTool} is set. - @end table -@item intersect +@item gmsh/model/occ/intersect Compute the boolean intersection (the common parts) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly @@ -2978,7 +2978,7 @@ set. - @end table -@item cut +@item gmsh/model/occ/cut Compute the boolean difference between the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly (only valid if the boolean @@ -2994,7 +2994,7 @@ is set. Remove the tool if @code{removeTool} is set. - @end table -@item fragment +@item gmsh/model/occ/fragment Compute the boolean fragments (general fuse) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly @@ -3011,7 +3011,7 @@ set. - @end table -@item translate +@item gmsh/model/occ/translate Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, @code{dz}). @@ -3024,7 +3024,7 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @end table -@item rotate +@item gmsh/model/occ/rotate Rotate the model entities @code{dimTags} of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). @@ -3038,7 +3038,7 @@ direction (@code{ax}, @code{ay}, @code{az}). - @end table -@item dilate +@item gmsh/model/occ/dilate Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and @code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as the center of the homothetic transformation. @@ -3052,7 +3052,7 @@ the center of the homothetic transformation. - @end table -@item symmetrize +@item gmsh/model/occ/symmetrize Apply a symmetry transformation to the model entities @code{dimTag}, with respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. @@ -3066,7 +3066,7 @@ respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + - @end table -@item affineTransform +@item gmsh/model/occ/affineTransform Apply a general affine transformation matrix @code{a} (16 entries of a 4x4 matrix, by row; only the 12 first can be provided for convenience) to the model entities @code{dimTag}. @@ -3080,7 +3080,7 @@ entities @code{dimTag}. - @end table -@item copy +@item gmsh/model/occ/copy Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags}. @@ -3093,7 +3093,7 @@ Copy the entities @code{dimTags}; the new entities are returned in - @end table -@item remove +@item gmsh/model/occ/remove Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -3106,7 +3106,7 @@ entities on their boundaries, down to dimension 0. - @end table -@item removeAllDuplicates +@item gmsh/model/occ/removeAllDuplicates Remove all duplicate entities (different entities at the same geometrical location) after intersecting (using boolean fragments) all highest dimensional entities. @@ -3120,7 +3120,7 @@ entities. - @end table -@item healShapes +@item gmsh/model/occ/healShapes Apply various healing procedures to the entities @code{dimTags} (or to all the entities in the model if @code{dimTags} is empty). Return the healed entities in @code{outDimTags}. Available healing options are listed in the Gmsh reference @@ -3135,7 +3135,7 @@ manual. - @end table -@item importShapes +@item gmsh/model/occ/importShapes Import BREP, STEP or IGES shapes from the file @code{fileName}. The imported entities are returned in @code{outDimTags}. If the optional argument @code{highestDimOnly} is set, only import the highest dimensional entities in @@ -3151,7 +3151,7 @@ the file (currently "brep", "step" or "iges"). - @end table -@item importShapesNativePointer +@item gmsh/model/occ/importShapesNativePointer Imports an OpenCASCADE @code{shape} by providing a pointer to a native OpenCASCADE @code{TopoDS_Shape} object (passed as a pointer to void). The imported entities are returned in @code{outDimTags}. If the optional argument @@ -3168,7 +3168,7 @@ an invalid pointer will lead to undefined behavior. - @end table -@item setMeshSize +@item gmsh/model/occ/setMeshSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -3181,7 +3181,7 @@ entities of dimension 0 (points) are handled. - @end table -@item getMass +@item gmsh/model/occ/getMass Get the mass of the model entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -3193,7 +3193,7 @@ Get the mass of the model entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getCenterOfMass +@item gmsh/model/occ/getCenterOfMass Get the center of mass of the model entity of dimension @code{dim} and tag @code{tag}. @@ -3206,7 +3206,7 @@ Get the center of mass of the model entity of dimension @code{dim} and tag - @end table -@item getMatrixOfInertia +@item gmsh/model/occ/getMatrixOfInertia Get the matrix of inertia (by row) of the model entity of dimension @code{dim} and tag @code{tag}. @@ -3219,7 +3219,7 @@ and tag @code{tag}. - @end table -@item synchronize +@item gmsh/model/occ/synchronize Synchronize the OpenCASCADE CAD representation with the current Gmsh model. This can be called at any time, but since it involves a non trivial amount of processing, the number of synchronization points should normally be minimized. @@ -3239,7 +3239,7 @@ processing, the number of synchronization points should normally be minimized. @section Namespace @code{gmsh/view}: post-processing view functions @ftable @code -@item add +@item gmsh/view/add Add a new post-processing view, with name @code{name}. If @code{tag} is positive use it (and remove the view with that tag if it already exists), otherwise associate a new tag. Return the view tag. @@ -3253,7 +3253,7 @@ associate a new tag. Return the view tag. integer value @end table -@item remove +@item gmsh/view/remove Remove the view with tag @code{tag}. @table @asis @@ -3265,7 +3265,7 @@ Remove the view with tag @code{tag}. - @end table -@item getIndex +@item gmsh/view/getIndex Get the index of the view with tag @code{tag} in the list of currently loaded views. This dynamic index (it can change when views are removed) is used to access view options. @@ -3279,7 +3279,7 @@ access view options. integer value @end table -@item getTags +@item gmsh/view/getTags Get the tags of all views. @table @asis @@ -3291,7 +3291,7 @@ Get the tags of all views. - @end table -@item addModelData +@item gmsh/view/addModelData Add model-based post-processing data to the view with tag @code{tag}. @code{modelName} identifies the model the data is attached to. @code{dataType} specifies the type of data, currently either "NodeData", "ElementData" or @@ -3314,7 +3314,7 @@ data. @code{partition} allows to specify data in several sub-sets. - @end table -@item getModelData +@item gmsh/view/getModelData Get model-based post-processing data from the view with tag @code{tag} at step @code{step}. Return the @code{data} associated to the nodes or the elements with tags @code{tags}, as well as the @code{dataType} and the number of components @@ -3329,7 +3329,7 @@ tags @code{tags}, as well as the @code{dataType} and the number of components - @end table -@item addListData +@item gmsh/view/addListData Add list-based post-processing data to the view with tag @code{tag}. @code{dataType} identifies the data: "SP" for scalar points, "VP", for vector points, etc. @code{numEle} gives the number of elements in the data. @code{data} @@ -3344,7 +3344,7 @@ contains the data for the @code{numEle} elements. - @end table -@item getListData +@item gmsh/view/getListData Get list-based post-processing data from the view with tag @code{tag}. Return the types @code{dataTypes}, the number of elements @code{numElements} for each data type and the @code{data} for each data type. @@ -3358,7 +3358,7 @@ data type and the @code{data} for each data type. - @end table -@item addAlias +@item gmsh/view/addAlias Add a post-processing view as an @code{alias} of the reference view with tag @code{refTag}. If @code{copyOptions} is set, copy the options of the reference view. If @code{tag} is positive use it (and remove the view with that tag if it @@ -3373,7 +3373,7 @@ already exists), otherwise associate a new tag. Return the view tag. integer value @end table -@item copyOptions +@item gmsh/view/copyOptions Copy the options from the view with tag @code{refTag} to the view with tag @code{tag}. @@ -3386,7 +3386,7 @@ Copy the options from the view with tag @code{refTag} to the view with tag - @end table -@item combine +@item gmsh/view/combine Combine elements (if @code{what} == "elements") or steps (if @code{what} == "steps") of all views (@code{how} == "all"), all visible views (@code{how} == "visible") or all views having the same name (@code{how} == "name"). Remove @@ -3401,7 +3401,7 @@ original views if @code{remove} is set. - @end table -@item probe +@item gmsh/view/probe Probe the view @code{tag} for its @code{value} at point (@code{x}, @code{y}, @code{z}). Return only the value at step @code{step} is @code{step} is positive. Return only values with @code{numComp} if @code{numComp} is positive. Return the @@ -3420,7 +3420,7 @@ its coordinates if @code{xElementCoord}, @code{yElementCoord} and - @end table -@item write +@item gmsh/view/write Write the view to a file @code{fileName}. The export format is determined by the file extension. Append to the file if @code{append} is set. @@ -3439,7 +3439,7 @@ file extension. Append to the file if @code{append} is set. @section Namespace @code{gmsh/plugin}: plugin functions @ftable @code -@item setNumber +@item gmsh/plugin/setNumber Set the numerical option @code{option} to the value @code{value} for plugin @code{name}. @@ -3452,7 +3452,7 @@ Set the numerical option @code{option} to the value @code{value} for plugin - @end table -@item setString +@item gmsh/plugin/setString Set the string option @code{option} to the value @code{value} for plugin @code{name}. @@ -3465,7 +3465,7 @@ Set the string option @code{option} to the value @code{value} for plugin - @end table -@item run +@item gmsh/plugin/run Run the plugin @code{name}. @table @asis @@ -3483,7 +3483,7 @@ Run the plugin @code{name}. @section Namespace @code{gmsh/graphics}: graphics functions @ftable @code -@item draw +@item gmsh/graphics/draw Draw all the OpenGL scenes. @table @asis @@ -3501,7 +3501,7 @@ Draw all the OpenGL scenes. @section Namespace @code{gmsh/fltk}: FLTK graphical user interface functions @ftable @code -@item initialize +@item gmsh/fltk/initialize Create the FLTK graphical user interface. Can only be called in the main thread. @table @asis @@ -3513,7 +3513,7 @@ Create the FLTK graphical user interface. Can only be called in the main thread. - @end table -@item wait +@item gmsh/fltk/wait Wait at most @code{time} seconds for user interface events and return. If @code{time} < 0, wait indefinitely. First automatically create the user interface if it has not yet been initialized. Can only be called in the main @@ -3528,7 +3528,7 @@ thread. - @end table -@item update +@item gmsh/fltk/update Update the user interface (potentially creating new widgets and windows). First automatically create the user interface if it has not yet been initialized. Can only be called in the main thread: use @code{awake("update")} to trigger an @@ -3543,7 +3543,7 @@ update of the user interface from another thread. - @end table -@item awake +@item gmsh/fltk/awake Awake the main user interface thread and process pending events, and optionally perform an action (currently the only @code{action} allowed is "update"). @@ -3556,7 +3556,7 @@ perform an action (currently the only @code{action} allowed is "update"). - @end table -@item lock +@item gmsh/fltk/lock Block the current thread until it can safely modify the user interface. @table @asis @@ -3568,7 +3568,7 @@ Block the current thread until it can safely modify the user interface. - @end table -@item unlock +@item gmsh/fltk/unlock Release the lock that was set using lock. @table @asis @@ -3580,7 +3580,7 @@ Release the lock that was set using lock. - @end table -@item run +@item gmsh/fltk/run Run the event loop of the graphical user interface, i.e. repeatedly call @code{wait()}. First automatically create the user interface if it has not yet been initialized. Can only be called in the main thread. @@ -3594,7 +3594,7 @@ been initialized. Can only be called in the main thread. - @end table -@item isAvailable +@item gmsh/fltk/isAvailable Check if the user interface is available (e.g. to detect if it has been closed). @table @asis @@ -3606,7 +3606,7 @@ Check if the user interface is available (e.g. to detect if it has been closed). integer value @end table -@item selectEntities +@item gmsh/fltk/selectEntities Select entities in the user interface. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. points if @code{dim} == 0). @@ -3619,7 +3619,7 @@ entities of the specified dimension (e.g. points if @code{dim} == 0). integer value @end table -@item selectElements +@item gmsh/fltk/selectElements Select elements in the user interface. @table @asis @@ -3631,7 +3631,7 @@ Select elements in the user interface. integer value @end table -@item selectViews +@item gmsh/fltk/selectViews Select views in the user interface. @table @asis @@ -3649,7 +3649,7 @@ integer value @section Namespace @code{gmsh/onelab}: ONELAB server functions @ftable @code -@item set +@item gmsh/onelab/set Set one or more parameters in the ONELAB database, encoded in @code{format}. @table @asis @@ -3661,7 +3661,7 @@ Set one or more parameters in the ONELAB database, encoded in @code{format}. - @end table -@item get +@item gmsh/onelab/get Get all the parameters (or a single one if @code{name} is specified) from the ONELAB database, encoded in @code{format}. @@ -3674,7 +3674,7 @@ ONELAB database, encoded in @code{format}. - @end table -@item setNumber +@item gmsh/onelab/setNumber Set the value of the number parameter @code{name} in the ONELAB database. Create the parameter if it does not exist; update the value if the parameter exists. @@ -3687,7 +3687,7 @@ the parameter if it does not exist; update the value if the parameter exists. - @end table -@item setString +@item gmsh/onelab/setString Set the value of the string parameter @code{name} in the ONELAB database. Create the parameter if it does not exist; update the value if the parameter exists. @@ -3700,7 +3700,7 @@ the parameter if it does not exist; update the value if the parameter exists. - @end table -@item getNumber +@item gmsh/onelab/getNumber Get the value of the number parameter @code{name} from the ONELAB database. Return an empty vector if the parameter does not exist. @@ -3713,7 +3713,7 @@ Return an empty vector if the parameter does not exist. - @end table -@item getString +@item gmsh/onelab/getString Get the value of the string parameter @code{name} from the ONELAB database. Return an empty vector if the parameter does not exist. @@ -3726,7 +3726,7 @@ Return an empty vector if the parameter does not exist. - @end table -@item clear +@item gmsh/onelab/clear Clear the ONELAB database, or remove a single parameter if @code{name} is given. @table @asis @@ -3738,7 +3738,7 @@ Clear the ONELAB database, or remove a single parameter if @code{name} is given. - @end table -@item run +@item gmsh/onelab/run Run a ONELAB client. If @code{name} is provided, create a new ONELAB client with name @code{name} and executes @code{command}. If not, try to run a client that might be linked to the processed input files. @@ -3758,7 +3758,7 @@ might be linked to the processed input files. @section Namespace @code{gmsh/logger}: information logging functions @ftable @code -@item write +@item gmsh/logger/write Write a @code{message}. @code{level} can be "info", "warning" or "error". @table @asis @@ -3770,7 +3770,7 @@ Write a @code{message}. @code{level} can be "info", "warning" or "error". - @end table -@item start +@item gmsh/logger/start Start logging messages. @table @asis @@ -3782,7 +3782,7 @@ Start logging messages. - @end table -@item get +@item gmsh/logger/get Get logged messages. @table @asis @@ -3794,7 +3794,7 @@ Get logged messages. - @end table -@item stop +@item gmsh/logger/stop Stop logging messages. @table @asis @@ -3806,7 +3806,7 @@ Stop logging messages. - @end table -@item getWallTime +@item gmsh/logger/getWallTime Return wall clock time. @table @asis @@ -3818,7 +3818,7 @@ Return wall clock time. floating point value @end table -@item getCpuTime +@item gmsh/logger/getCpuTime Return CPU time. @table @asis diff --git a/doc/texinfo/api.texi b/doc/texinfo/api.texi index 08193707a8..594a52ef05 100644 --- a/doc/texinfo/api.texi +++ b/doc/texinfo/api.texi @@ -21,7 +21,7 @@ @section Namespace @code{gmsh}: top-level functions @ftable @code -@item initialize +@item gmsh/initialize Initialize Gmsh. This must be called before any call to the other functions in the API. If @code{argc} and @code{argv} (or just @code{argv} in Python or Julia) are provided, they will be handled in the same way as the command line arguments @@ -37,7 +37,7 @@ configuration files (gmshrc and gmsh-options). - @end table -@item finalize +@item gmsh/finalize Finalize Gmsh. This must be called when you are done using the Gmsh API. @table @asis @@ -49,7 +49,7 @@ Finalize Gmsh. This must be called when you are done using the Gmsh API. - @end table -@item open +@item gmsh/open Open a file. Equivalent to the @code{File->Open} menu in the Gmsh app. Handling of the file depends on its extension and/or its contents: opening a file with model data will create a new model. @@ -63,7 +63,7 @@ model data will create a new model. - @end table -@item merge +@item gmsh/merge Merge a file. Equivalent to the @code{File->Merge} menu in the Gmsh app. Handling of the file depends on its extension and/or its contents. Merging a file with model data will add the data to the current model. @@ -77,7 +77,7 @@ file with model data will add the data to the current model. - @end table -@item write +@item gmsh/write Write a file. The export format is determined by the file extension. @table @asis @@ -89,7 +89,7 @@ Write a file. The export format is determined by the file extension. - @end table -@item clear +@item gmsh/clear Clear all loaded models and post-processing data, and add a new empty model. @table @asis @@ -107,7 +107,7 @@ Clear all loaded models and post-processing data, and add a new empty model. @section Namespace @code{gmsh/option}: option handling functions @ftable @code -@item setNumber +@item gmsh/option/setNumber Set a numerical option to @code{value}. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -121,7 +121,7 @@ are listed in the Gmsh reference manual. - @end table -@item getNumber +@item gmsh/option/getNumber Get the @code{value} of a numerical option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -135,7 +135,7 @@ are listed in the Gmsh reference manual. - @end table -@item setString +@item gmsh/option/setString Set a string option to @code{value}. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -149,7 +149,7 @@ are listed in the Gmsh reference manual. - @end table -@item getString +@item gmsh/option/getString Get the @code{value} of a string option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual. @@ -163,7 +163,7 @@ are listed in the Gmsh reference manual. - @end table -@item setColor +@item gmsh/option/setColor Set a color option to the RGBA value (@code{r}, @code{g}, @code{b}, @code{a}), where where @code{r}, @code{g}, @code{b} and @code{a} should be integers between 0 and 255. @code{name} is of the form "category.option" or @@ -179,7 +179,7 @@ reference manual, with the "Color." middle string removed. - @end table -@item getColor +@item gmsh/option/getColor Get the @code{r}, @code{g}, @code{b}, @code{a} value of a color option. @code{name} is of the form "category.option" or "category[num].option". Available categories and options are listed in the Gmsh reference manual, with @@ -200,7 +200,7 @@ the "Color." middle string removed. @section Namespace @code{gmsh/model}: model functions @ftable @code -@item add +@item gmsh/model/add Add a new model, with name @code{name}, and set it as the current model. @table @asis @@ -212,7 +212,7 @@ Add a new model, with name @code{name}, and set it as the current model. - @end table -@item remove +@item gmsh/model/remove Remove the current model. @table @asis @@ -224,7 +224,7 @@ Remove the current model. - @end table -@item list +@item gmsh/model/list List the names of all models. @table @asis @@ -236,7 +236,7 @@ List the names of all models. - @end table -@item getCurrent +@item gmsh/model/getCurrent Get the name of the current model. @table @asis @@ -248,7 +248,7 @@ Get the name of the current model. - @end table -@item setCurrent +@item gmsh/model/setCurrent Set the current model to the model with name @code{name}. If several models have the same name, select the one that was added first. @@ -261,7 +261,7 @@ the same name, select the one that was added first. - @end table -@item getEntities +@item gmsh/model/getEntities Get all the entities in the current model. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. points if @code{dim} == 0). The entities are returned as a vector of (dim, tag) integer pairs. @@ -275,7 +275,7 @@ entities are returned as a vector of (dim, tag) integer pairs. - @end table -@item setEntityName +@item gmsh/model/setEntityName Set the name of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -287,7 +287,7 @@ Set the name of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getEntityName +@item gmsh/model/getEntityName Get the name of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -299,7 +299,7 @@ Get the name of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getPhysicalGroups +@item gmsh/model/getPhysicalGroups Get all the physical groups in the current model. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. physical points if @code{dim} == 0). The entities are returned as a vector of (dim, tag) integer pairs. @@ -313,7 +313,7 @@ only the entities of the specified dimension (e.g. physical points if @code{dim} - @end table -@item getEntitiesForPhysicalGroup +@item gmsh/model/getEntitiesForPhysicalGroup Get the tags of the model entities making up the physical group of dimension @code{dim} and tag @code{tag}. @@ -326,7 +326,7 @@ Get the tags of the model entities making up the physical group of dimension - @end table -@item getPhysicalGroupsForEntity +@item gmsh/model/getPhysicalGroupsForEntity Get the tags of the physical groups (if any) to which the model entity of dimension @code{dim} and tag @code{tag} belongs. @@ -339,7 +339,7 @@ dimension @code{dim} and tag @code{tag} belongs. - @end table -@item addPhysicalGroup +@item gmsh/model/addPhysicalGroup Add a physical group of dimension @code{dim}, grouping the model entities with tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if @code{tag} is positive, or a new tag if @code{tag} < 0. @@ -353,7 +353,7 @@ tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if integer value @end table -@item setPhysicalName +@item gmsh/model/setPhysicalName Set the name of the physical group of dimension @code{dim} and tag @code{tag}. @table @asis @@ -365,7 +365,7 @@ Set the name of the physical group of dimension @code{dim} and tag @code{tag}. - @end table -@item getPhysicalName +@item gmsh/model/getPhysicalName Get the name of the physical group of dimension @code{dim} and tag @code{tag}. @table @asis @@ -377,7 +377,7 @@ Get the name of the physical group of dimension @code{dim} and tag @code{tag}. - @end table -@item getBoundary +@item gmsh/model/getBoundary Get the boundary of the model entities @code{dimTags}. Return in @code{outDimTags} the boundary of the individual entities (if @code{combined} is false) or the boundary of the combined geometrical shape formed by all input @@ -394,7 +394,7 @@ recursively down to dimension 0 (i.e. to points) if @code{recursive} is true. - @end table -@item getEntitiesInBoundingBox +@item gmsh/model/getEntitiesInBoundingBox Get the model entities in the bounding box defined by the two points (@code{xmin}, @code{ymin}, @code{zmin}) and (@code{xmax}, @code{ymax}, @code{zmax}). If @code{dim} is >= 0, return only the entities of the specified @@ -409,7 +409,7 @@ dimension (e.g. points if @code{dim} == 0). - @end table -@item getBoundingBox +@item gmsh/model/getBoundingBox Get the bounding box (@code{xmin}, @code{ymin}, @code{zmin}), (@code{xmax}, @code{ymax}, @code{zmax}) of the model entity of dimension @code{dim} and tag @code{tag}. If @code{dim} and @code{tag} are negative, get the bounding box of @@ -424,7 +424,7 @@ the whole model. - @end table -@item getDimension +@item gmsh/model/getDimension Get the geometrical dimension of the current model. @table @asis @@ -436,7 +436,7 @@ Get the geometrical dimension of the current model. integer value @end table -@item addDiscreteEntity +@item gmsh/model/addDiscreteEntity Add a discrete model entity (defined by a mesh) of dimension @code{dim} in the current model. Return the tag of the new discrete entity, equal to @code{tag} if @code{tag} is positive, or a new tag if @code{tag} < 0. @code{boundary} @@ -453,7 +453,7 @@ overall model. integer value @end table -@item removeEntities +@item gmsh/model/removeEntities Remove the entities @code{dimTags} of the current model. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -466,7 +466,7 @@ true, remove all the entities on their boundaries, down to dimension 0. - @end table -@item removeEntityName +@item gmsh/model/removeEntityName Remove the entity name @code{name} from the current model. @table @asis @@ -478,7 +478,7 @@ Remove the entity name @code{name} from the current model. - @end table -@item removePhysicalGroups +@item gmsh/model/removePhysicalGroups Remove the physical groups @code{dimTags} of the current model. If @code{dimTags} is empty, remove all groups. @@ -491,7 +491,7 @@ Remove the physical groups @code{dimTags} of the current model. If - @end table -@item removePhysicalName +@item gmsh/model/removePhysicalName Remove the physical name @code{name} from the current model. @table @asis @@ -503,7 +503,7 @@ Remove the physical name @code{name} from the current model. - @end table -@item getType +@item gmsh/model/getType Get the type of the entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -515,7 +515,7 @@ Get the type of the entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getParent +@item gmsh/model/getParent In a partitioned model, get the parent of the entity of dimension @code{dim} and tag @code{tag}, i.e. from which the entity is a part of, if any. @code{parentDim} and @code{parentTag} are set to -1 if the entity has no parent. @@ -529,7 +529,7 @@ tag @code{tag}, i.e. from which the entity is a part of, if any. - @end table -@item getPartitions +@item gmsh/model/getPartitions In a partitioned model, return the tags of the partition(s) to which the entity belongs. @@ -542,7 +542,7 @@ belongs. - @end table -@item getValue +@item gmsh/model/getValue Evaluate the parametrization of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 0 (with empty @code{parametricCoord}), 1 (with @@ -560,7 +560,7 @@ coordinates in @code{points}, concatenated: [p1x, p1y, p1z, p2x, ...]. - @end table -@item getDerivative +@item gmsh/model/getDerivative Evaluate the derivative of the parametrization of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 1 (with @@ -581,7 +581,7 @@ derivate with respect to u and v: [d1ux, d1uy, d1uz, d1vx, d1vy, d1vz, d2ux, - @end table -@item getCurvature +@item gmsh/model/getCurvature Evaluate the (maximum) curvature of the entity of dimension @code{dim} and tag @code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for @code{dim} equal to 1 (with @code{parametricCoord} containing parametric @@ -597,7 +597,7 @@ u, v parametric coordinates on the surface, concatenated: [p1u, p1v, p2u, ...]). - @end table -@item getPrincipalCurvatures +@item gmsh/model/getPrincipalCurvatures Evaluate the principal curvatures of the surface with tag @code{tag} at the parametric coordinates @code{parametricCoord}, as well as their respective directions. @code{parametricCoord} are given by pair of u and v coordinates, @@ -612,7 +612,7 @@ concatenated: [p1u, p1v, p2u, ...]. - @end table -@item getNormal +@item gmsh/model/getNormal Get the normal to the surface with tag @code{tag} at the parametric coordinates @code{parametricCoord}. @code{parametricCoord} are given by pairs of u and v coordinates, concatenated: [p1u, p1v, p2u, ...]. @code{normals} are returned as @@ -627,7 +627,7 @@ triplets of x, y, z components, concatenated: [n1x, n1y, n1z, n2x, ...]. - @end table -@item getParametrization +@item gmsh/model/getParametrization Get the parametric coordinates @code{parametricCoord} for the points @code{points} on the entity of dimension @code{dim} and tag @code{tag}. @code{points} are given as triplets of x, y, z coordinates, concatenated: [p1x, @@ -644,7 +644,7 @@ the surface (if @code{dim} = 2), i.e. [p1t, p2t, ...] or [p1u, p1v, p2u, ...]. - @end table -@item setVisibility +@item gmsh/model/setVisibility Set the visibility of the model entities @code{dimTags} to @code{value}. Apply the visibility setting recursively if @code{recursive} is true. @@ -657,7 +657,7 @@ the visibility setting recursively if @code{recursive} is true. - @end table -@item getVisibility +@item gmsh/model/getVisibility Get the visibility of the model entity of dimension @code{dim} and tag @code{tag}. @@ -670,7 +670,7 @@ Get the visibility of the model entity of dimension @code{dim} and tag - @end table -@item setColor +@item gmsh/model/setColor Set the color of the model entities @code{dimTags} to the RGBA value (@code{r}, @code{g}, @code{b}, @code{a}), where @code{r}, @code{g}, @code{b} and @code{a} should be integers between 0 and 255. Apply the color setting recursively if @@ -685,7 +685,7 @@ should be integers between 0 and 255. Apply the color setting recursively if - @end table -@item getColor +@item gmsh/model/getColor Get the color of the model entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -697,7 +697,7 @@ Get the color of the model entity of dimension @code{dim} and tag @code{tag}. - @end table -@item setCoordinates +@item gmsh/model/setCoordinates Set the @code{x}, @code{y}, @code{z} coordinates of a geometrical point. @table @asis @@ -715,7 +715,7 @@ Set the @code{x}, @code{y}, @code{z} coordinates of a geometrical point. @section Namespace @code{gmsh/model/mesh}: mesh functions @ftable @code -@item generate +@item gmsh/model/mesh/generate Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). @table @asis @@ -727,7 +727,7 @@ Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). - @end table -@item partition +@item gmsh/model/mesh/partition Partition the mesh of the current model into @code{numPart} partitions. @table @asis @@ -739,7 +739,7 @@ Partition the mesh of the current model into @code{numPart} partitions. - @end table -@item unpartition +@item gmsh/model/mesh/unpartition Unpartition the mesh of the current model. @table @asis @@ -751,7 +751,7 @@ Unpartition the mesh of the current model. - @end table -@item optimize +@item gmsh/model/mesh/optimize Optimize the mesh of the current model using @code{method} (empty for default tetrahedral mesh optimizer, "Netgen" for Netgen optimizer, "HighOrder" for direct high-order mesh optimizer, "HighOrderElastic" for high-order elastic @@ -769,7 +769,7 @@ Laplace smoothing, "Relocate2D" and "Relocate3D" for node relocation). If - @end table -@item recombine +@item gmsh/model/mesh/recombine Recombine the mesh of the current model. @table @asis @@ -781,7 +781,7 @@ Recombine the mesh of the current model. - @end table -@item refine +@item gmsh/model/mesh/refine Refine the mesh of the current model by uniformly splitting the elements. @table @asis @@ -793,7 +793,7 @@ Refine the mesh of the current model by uniformly splitting the elements. - @end table -@item setOrder +@item gmsh/model/mesh/setOrder Set the order of the elements in the mesh of the current model to @code{order}. @table @asis @@ -805,7 +805,7 @@ Set the order of the elements in the mesh of the current model to @code{order}. - @end table -@item getLastEntityError +@item gmsh/model/mesh/getLastEntityError Get the last entities (if any) where a meshing error occurred. Currently only populated by the new 3D meshing algorithms. @@ -818,7 +818,7 @@ populated by the new 3D meshing algorithms. - @end table -@item getLastNodeError +@item gmsh/model/mesh/getLastNodeError Get the last nodes (if any) where a meshing error occurred. Currently only populated by the new 3D meshing algorithms. @@ -831,7 +831,7 @@ populated by the new 3D meshing algorithms. - @end table -@item clear +@item gmsh/model/mesh/clear Clear the mesh, i.e. delete all the nodes and elements. @table @asis @@ -843,7 +843,7 @@ Clear the mesh, i.e. delete all the nodes and elements. - @end table -@item getNodes +@item gmsh/model/mesh/getNodes Get the nodes classified on the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the nodes for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the nodes in the @@ -867,7 +867,7 @@ the entity if @code{dim} >= 0 in order to compute their parametric coordinates). - @end table -@item getNodesByElementType +@item gmsh/model/mesh/getNodesByElementType Get the nodes classified on the entity of tag @code{tag}, for all the elements of type @code{elementType}. The other arguments are treated as in @code{getNodes}. @@ -881,7 +881,7 @@ of type @code{elementType}. The other arguments are treated as in - @end table -@item getNode +@item gmsh/model/mesh/getNode Get the coordinates and the parametric coordinates (if any) of the node with tag @code{tag}. This is a sometimes useful but inefficient way of accessing nodes, as it relies on a cache stored in the model. For large meshes all the nodes in @@ -898,7 +898,7 @@ vector; otherwise it uses a map). - @end table -@item setNode +@item gmsh/model/mesh/setNode Set the coordinates and the parametric coordinates (if any) of the node with tag @code{tag}. This is a sometimes useful but inefficient way of accessing nodes, as it relies on a cache stored in the model. For large meshes all the nodes in @@ -914,7 +914,7 @@ from 1 to N. - @end table -@item rebuildNodeCache +@item gmsh/model/mesh/rebuildNodeCache Rebuild the node cache. @table @asis @@ -926,7 +926,7 @@ Rebuild the node cache. - @end table -@item getNodesForPhysicalGroup +@item gmsh/model/mesh/getNodesForPhysicalGroup Get the nodes from all the elements belonging to the physical group of dimension @code{dim} and tag @code{tag}. @code{nodeTags} contains the node tags; @code{coord} is a vector of length 3 times the length of @code{nodeTags} that @@ -942,7 +942,7 @@ n2x, ...]. - @end table -@item addNodes +@item gmsh/model/mesh/addNodes Add nodes classified on the model entity of dimension @code{dim} and tag @code{tag}. @code{nodeTags} contains the node tags (their unique, strictly positive identification numbers). @code{coord} is a vector of length 3 times the @@ -962,7 +962,7 @@ automatically assigned to the nodes. - @end table -@item reclassifyNodes +@item gmsh/model/mesh/reclassifyNodes Reclassify all nodes on their associated model entity, based on the elements. Can be used when importing nodes in bulk (e.g. by associating them all to a single volume), to reclassify them correctly on model surfaces, curves, etc. @@ -977,7 +977,7 @@ after the elements have been set. - @end table -@item relocateNodes +@item gmsh/model/mesh/relocateNodes Relocate the nodes classified on the entity of dimension @code{dim} and tag @code{tag} using their parametric coordinates. If @code{tag} < 0, relocate the nodes for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are @@ -992,7 +992,7 @@ negative, relocate all the nodes in the mesh. - @end table -@item getElements +@item gmsh/model/mesh/getElements Get the elements classified on the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the elements for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the elements in @@ -1016,7 +1016,7 @@ that contains the node tags of all the elements of the given type, concatenated: - @end table -@item getElement +@item gmsh/model/mesh/getElement Get the type and node tags of the element with tag @code{tag}. This is a sometimes useful but inefficient way of accessing elements, as it relies on a cache stored in the model. For large meshes all the elements in the model should @@ -1033,7 +1033,7 @@ uses a map). - @end table -@item getElementByCoordinates +@item gmsh/model/mesh/getElementByCoordinates Search the mesh for an element located at coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, as it relies on a search in a spatial octree. If an element is found, return its @@ -1051,7 +1051,7 @@ set, use a tolerance to find elements near the search location. - @end table -@item getElementsByCoordinates +@item gmsh/model/mesh/getElementsByCoordinates Search the mesh for element(s) located at coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, as it relies on a search in a spatial octree. Return the tags of all found @@ -1070,7 +1070,7 @@ location. - @end table -@item getLocalCoordinatesInElement +@item gmsh/model/mesh/getLocalCoordinatesInElement Return the local coordinates (@code{u}, @code{v}, @code{w}) within the element @code{elementTag} corresponding to the model coordinates (@code{x}, @code{y}, @code{z}). This is a sometimes useful but inefficient way of accessing elements, @@ -1085,7 +1085,7 @@ as it relies on a cache stored in the model. - @end table -@item getElementTypes +@item gmsh/model/mesh/getElementTypes Get the types of elements in the entity of dimension @code{dim} and tag @code{tag}. If @code{tag} < 0, get the types for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are negative, get all the types in the @@ -1100,7 +1100,7 @@ mesh. - @end table -@item getElementType +@item gmsh/model/mesh/getElementType Return an element type given its family name @code{familyName} ("point", "line", "triangle", "quadrangle", "tetrahedron", "pyramid", "prism", "hexahedron") and polynomial order @code{order}. If @code{serendip} is true, return the @@ -1115,7 +1115,7 @@ corresponding serendip element type (element without interior nodes). integer value @end table -@item getElementProperties +@item gmsh/model/mesh/getElementProperties Get the properties of an element of type @code{elementType}: its name (@code{elementName}), dimension (@code{dim}), order (@code{order}), number of nodes (@code{numNodes}), coordinates of the nodes in the reference element @@ -1131,7 +1131,7 @@ of primary (first order) nodes (@code{numPrimaryNodes}). - @end table -@item getElementsByType +@item gmsh/model/mesh/getElementsByType Get the elements of type @code{elementType} classified on the entity of tag @code{tag}. If @code{tag} < 0, get the elements for all entities. @code{elementTags} is a vector containing the tags (unique, strictly positive @@ -1151,7 +1151,7 @@ indexed by @code{task}. - @end table -@item preallocateElementsByType +@item gmsh/model/mesh/preallocateElementsByType Preallocate data before calling @code{getElementsByType} with @code{numTasks} > 1. For C and C++ only. @@ -1164,7 +1164,7 @@ Preallocate data before calling @code{getElementsByType} with @code{numTasks} > - @end table -@item addElements +@item gmsh/model/mesh/addElements Add elements classified on the entity of dimension @code{dim} and tag @code{tag}. @code{types} contains the MSH types of the elements (e.g. @code{2} for 3-node triangles: see the Gmsh reference manual). @code{elementTags} is a @@ -1185,7 +1185,7 @@ e1nN, e2n1, ...]. - @end table -@item addElementsByType +@item gmsh/model/mesh/addElementsByType Add elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{elementTags} contains the tags (unique, strictly positive identifiers) of the elements of the corresponding type. @code{nodeTags} is a @@ -1203,7 +1203,7 @@ are automatically assigned to the elements. - @end table -@item getIntegrationPoints +@item gmsh/model/mesh/getIntegrationPoints Get the numerical quadrature information for the given element type @code{elementType} and integration rule @code{integrationType} (e.g. "Gauss4" for a Gauss quadrature suited for integrating 4th order polynomials). @@ -1220,7 +1220,7 @@ points in the reference element: [g1u, g1v, g1w, ..., gGu, gGv, gGw]. - @end table -@item getJacobians +@item gmsh/model/mesh/getJacobians Get the Jacobians of all the elements of type @code{elementType} classified on the entity of tag @code{tag}, at the G integration points @code{integrationPoints} given as concatenated triplets of coordinates in the @@ -1245,7 +1245,7 @@ and return the part of the data indexed by @code{task}. - @end table -@item preallocateJacobians +@item gmsh/model/mesh/preallocateJacobians Preallocate data before calling @code{getJacobians} with @code{numTasks} > 1. For C and C++ only. @@ -1258,7 +1258,7 @@ For C and C++ only. - @end table -@item getBasisFunctions +@item gmsh/model/mesh/getBasisFunctions Get the basis functions of the element of type @code{elementType} at the integration points @code{integrationPoints} (given as concatenated triplets of coordinates in the reference element [g1u, g1v, g1w, ..., gGu, gGv, gGw]), for @@ -1278,7 +1278,7 @@ when C == 1 or [g1f1u, g1f1v, g1f1w, g1f2u, ..., g1fNw, g2f1u, ...] when C == 3. - @end table -@item getBasisFunctionsForElements +@item gmsh/model/mesh/getBasisFunctionsForElements Get the element-dependent basis functions of the elements of type @code{elementType} in the entity of tag @code{tag}at the integration points @code{integrationPoints} (given as concatenated triplets of coordinates in the @@ -1303,7 +1303,7 @@ return the part of the data indexed by @code{task}. - @end table -@item preallocateBasisFunctions +@item gmsh/model/mesh/preallocateBasisFunctions Preallocate data before calling @code{getBasisFunctionsForElements} with @code{numTasks} > 1. For C and C++ only. @@ -1316,7 +1316,7 @@ Preallocate data before calling @code{getBasisFunctionsForElements} with - @end table -@item getKeysForElements +@item gmsh/model/mesh/getKeysForElements Generate the @code{keys} for the elements of type @code{elementType} in the entity of tag @code{tag}, for the @code{functionSpaceType} function space. Each key uniquely identifies a basis function in the function space. If @@ -1333,7 +1333,7 @@ experimental feature and will probably change in a future release. - @end table -@item getNumberOfKeysForElements +@item gmsh/model/mesh/getNumberOfKeysForElements Get the number of keys by elements of type @code{elementType} for function space named @code{functionSpaceType}. @@ -1346,7 +1346,7 @@ named @code{functionSpaceType}. integer value @end table -@item getInformationForElements +@item gmsh/model/mesh/getInformationForElements Get information about the @code{keys}. @code{infoKeys} returns information about the functions associated with the @code{keys}. @code{infoKeys[0].first} describes the type of function (0 for vertex function, 1 for edge function, 2 @@ -1363,7 +1363,7 @@ experimental feature and will probably change in a future release. - @end table -@item precomputeBasisFunctions +@item gmsh/model/mesh/precomputeBasisFunctions Precomputes the basis functions corresponding to @code{elementType}. @table @asis @@ -1375,7 +1375,7 @@ Precomputes the basis functions corresponding to @code{elementType}. - @end table -@item getBarycenters +@item gmsh/model/mesh/getBarycenters Get the barycenters of all elements of type @code{elementType} classified on the entity of tag @code{tag}. If @code{primary} is set, only the primary nodes of the elements are taken into account for the barycenter calculation. If @@ -1393,7 +1393,7 @@ the part of the data indexed by @code{task}. - @end table -@item preallocateBarycenters +@item gmsh/model/mesh/preallocateBarycenters Preallocate data before calling @code{getBarycenters} with @code{numTasks} > 1. For C and C++ only. @@ -1406,7 +1406,7 @@ For C and C++ only. - @end table -@item getElementEdgeNodes +@item gmsh/model/mesh/getElementEdgeNodes Get the nodes on the edges of all elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the edges for all the elements: [e1a1n1, e1a1n2, e1a2n1, ...]. Data is returned by @@ -1425,7 +1425,7 @@ indexed by @code{task}. - @end table -@item getElementFaceNodes +@item gmsh/model/mesh/getElementFaceNodes Get the nodes on the faces of type @code{faceType} (3 for triangular faces, 4 for quadrangular faces) of all elements of type @code{elementType} classified on the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the @@ -1445,7 +1445,7 @@ the data indexed by @code{task}. - @end table -@item getGhostElements +@item gmsh/model/mesh/getGhostElements Get the ghost elements @code{elementTags} and their associated @code{partitions} stored in the ghost entity of dimension @code{dim} and tag @code{tag}. @@ -1458,7 +1458,7 @@ stored in the ghost entity of dimension @code{dim} and tag @code{tag}. - @end table -@item setSize +@item gmsh/model/mesh/setSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -1471,7 +1471,7 @@ entities of dimension 0 (points) are handled. - @end table -@item setTransfiniteCurve +@item gmsh/model/mesh/setTransfiniteCurve Set a transfinite meshing constraint on the curve @code{tag}, with @code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. Currently supported types are "Progression" (geometrical progression with power @@ -1486,7 +1486,7 @@ Currently supported types are "Progression" (geometrical progression with power - @end table -@item setTransfiniteSurface +@item gmsh/model/mesh/setTransfiniteSurface Set a transfinite meshing constraint on the surface @code{tag}. @code{arrangement} describes the arrangement of the triangles when the surface is not flagged as recombined: currently supported values are "Left", "Right", @@ -1504,7 +1504,7 @@ its boundary. - @end table -@item setTransfiniteVolume +@item gmsh/model/mesh/setTransfiniteVolume Set a transfinite meshing constraint on the surface @code{tag}. @code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite interpolation explicitly. @@ -1518,7 +1518,7 @@ interpolation explicitly. - @end table -@item setRecombine +@item gmsh/model/mesh/setRecombine Set a recombination meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to recombine triangles into quadrangles) are supported. @@ -1532,7 +1532,7 @@ recombine triangles into quadrangles) are supported. - @end table -@item setSmoothing +@item gmsh/model/mesh/setSmoothing Set a smoothing meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. @@ -1545,7 +1545,7 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @end table -@item setReverse +@item gmsh/model/mesh/setReverse Set a reverse meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed with respect to the natural mesh orientation (i.e. the orientation consistent @@ -1561,7 +1561,7 @@ as-is. - @end table -@item setAlgorithm +@item gmsh/model/mesh/setAlgorithm Set the meshing algorithm on the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -1574,7 +1574,7 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @end table -@item setSizeFromBoundary +@item gmsh/model/mesh/setSizeFromBoundary Force the mesh size to be extended from the boundary, or not, for the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -1588,7 +1588,7 @@ entity of dimension @code{dim} and tag @code{tag}. Currently only supported for - @end table -@item setCompound +@item gmsh/model/mesh/setCompound Set a compound meshing constraint on the model entities of dimension @code{dim} and tags @code{tags}. During meshing, compound entities are treated as a single discrete entity, which is automatically reparametrized. @@ -1602,7 +1602,7 @@ discrete entity, which is automatically reparametrized. - @end table -@item setOutwardOrientation +@item gmsh/model/mesh/setOutwardOrientation Set meshing constraints on the bounding surfaces of the volume of tag @code{tag} so that all surfaces are oriented with outward pointing normals. Currently only available with the OpenCASCADE kernel, as it relies on the STL triangulation. @@ -1616,7 +1616,7 @@ available with the OpenCASCADE kernel, as it relies on the STL triangulation. - @end table -@item embed +@item gmsh/model/mesh/embed Embed the model entities of dimension @code{dim} and tags @code{tags} in the (@code{inDim}, @code{inTag}) model entity. The dimension @code{dim} can 0, 1 or 2 and must be strictly smaller than @code{inDim}, which must be either 2 or 3. @@ -1632,7 +1632,7 @@ The embedded entities should not be part of the boundary of the entity - @end table -@item removeEmbedded +@item gmsh/model/mesh/removeEmbedded Remove embedded entities from the model entities @code{dimTags}. if @code{dim} is >= 0, only remove embedded entities of the given dimension (e.g. embedded points if @code{dim} == 0). @@ -1646,7 +1646,7 @@ points if @code{dim} == 0). - @end table -@item reorderElements +@item gmsh/model/mesh/reorderElements Reorder the elements of type @code{elementType} classified on the entity of tag @code{tag} according to @code{ordering}. @@ -1659,7 +1659,7 @@ Reorder the elements of type @code{elementType} classified on the entity of tag - @end table -@item renumberNodes +@item gmsh/model/mesh/renumberNodes Renumber the node tags in a continuous sequence. @table @asis @@ -1671,7 +1671,7 @@ Renumber the node tags in a continuous sequence. - @end table -@item renumberElements +@item gmsh/model/mesh/renumberElements Renumber the element tags in a continuous sequence. @table @asis @@ -1683,7 +1683,7 @@ Renumber the element tags in a continuous sequence. - @end table -@item setPeriodic +@item gmsh/model/mesh/setPeriodic Set the meshes of the entities of dimension @code{dim} and tag @code{tags} as periodic copies of the meshes of entities @code{tagsMaster}, using the affine transformation specified in @code{affineTransformation} (16 entries of a 4x4 @@ -1702,7 +1702,7 @@ and @code{dim} == 2. - @end table -@item getPeriodicNodes +@item gmsh/model/mesh/getPeriodicNodes Get the master entity @code{tagMaster}, the node tags @code{nodeTags} and their corresponding master node tags @code{nodeTagsMaster}, and the affine transform @code{affineTransform} for the entity of dimension @code{dim} and tag @@ -1717,7 +1717,7 @@ corresponding master node tags @code{nodeTagsMaster}, and the affine transform - @end table -@item removeDuplicateNodes +@item gmsh/model/mesh/removeDuplicateNodes Remove duplicate nodes in the mesh of the current model. @table @asis @@ -1729,7 +1729,7 @@ Remove duplicate nodes in the mesh of the current model. - @end table -@item splitQuadrangles +@item gmsh/model/mesh/splitQuadrangles Split (into two triangles) all quadrangles in surface @code{tag} whose quality is lower than @code{quality}. If @code{tag} < 0, split quadrangles in all surfaces. @@ -1743,7 +1743,7 @@ surfaces. - @end table -@item classifySurfaces +@item gmsh/model/mesh/classifySurfaces Classify ("color") the surface mesh based on the angle threshold @code{angle} (in radians), and create new discrete surfaces, curves and points accordingly. If @code{boundary} is set, also create discrete curves on the boundary if the @@ -1760,7 +1760,7 @@ less than Pi, also force curves to be split according to @code{curveAngle}. - @end table -@item createGeometry +@item gmsh/model/mesh/createGeometry Create a parametrization for discrete curves and surfaces (i.e. curves and surfaces represented solely by a mesh, without an underlying CAD description), assuming that each can be parametrized with a single map. @@ -1774,7 +1774,7 @@ assuming that each can be parametrized with a single map. - @end table -@item createTopology +@item gmsh/model/mesh/createTopology Create a boundary representation from the mesh if the model does not have one (e.g. when imported from mesh file formats with no BRep representation of the underlying model). @@ -1788,7 +1788,7 @@ underlying model). - @end table -@item computeHomology +@item gmsh/model/mesh/computeHomology Compute a basis representation for homology spaces after a mesh has been generated. The computation domain is given in a list of physical group tags @code{domainTags}; if empty, the whole mesh is the domain. The computation @@ -1807,7 +1807,7 @@ as physical groups in the mesh. - @end table -@item computeCohomology +@item gmsh/model/mesh/computeCohomology Compute a basis representation for cohomology spaces after a mesh has been generated. The computation domain is given in a list of physical group tags @code{domainTags}; if empty, the whole mesh is the domain. The computation @@ -1826,7 +1826,7 @@ stored as physical groups in the mesh. - @end table -@item computeCrossField +@item gmsh/model/mesh/computeCrossField Compute a cross field for the current mesh. The function creates 3 views: the H function, the Theta function and cross directions. Return the tags of the views @@ -1845,7 +1845,7 @@ function, the Theta function and cross directions. Return the tags of the views @section Namespace @code{gmsh/model/mesh/field}: mesh size field functions @ftable @code -@item add +@item gmsh/model/mesh/field/add Add a new mesh size field of type @code{fieldType}. If @code{tag} is positive, assign the tag explicitly; otherwise a new tag is assigned automatically. Return the field tag. @@ -1859,7 +1859,7 @@ the field tag. integer value @end table -@item remove +@item gmsh/model/mesh/field/remove Remove the field with tag @code{tag}. @table @asis @@ -1871,7 +1871,7 @@ Remove the field with tag @code{tag}. - @end table -@item setNumber +@item gmsh/model/mesh/field/setNumber Set the numerical option @code{option} to value @code{value} for field @code{tag}. @@ -1884,7 +1884,7 @@ Set the numerical option @code{option} to value @code{value} for field - @end table -@item setString +@item gmsh/model/mesh/field/setString Set the string option @code{option} to value @code{value} for field @code{tag}. @table @asis @@ -1896,7 +1896,7 @@ Set the string option @code{option} to value @code{value} for field @code{tag}. - @end table -@item setNumbers +@item gmsh/model/mesh/field/setNumbers Set the numerical list option @code{option} to value @code{value} for field @code{tag}. @@ -1909,7 +1909,7 @@ Set the numerical list option @code{option} to value @code{value} for field - @end table -@item setAsBackgroundMesh +@item gmsh/model/mesh/field/setAsBackgroundMesh Set the field @code{tag} as the background mesh size field. @table @asis @@ -1921,7 +1921,7 @@ Set the field @code{tag} as the background mesh size field. - @end table -@item setAsBoundaryLayer +@item gmsh/model/mesh/field/setAsBoundaryLayer Set the field @code{tag} as a boundary layer size field. @table @asis @@ -1939,7 +1939,7 @@ Set the field @code{tag} as a boundary layer size field. @section Namespace @code{gmsh/model/geo}: built-in CAD kernel functions @ftable @code -@item addPoint +@item gmsh/model/geo/addPoint Add a geometrical point in the built-in CAD representation, at coordinates (@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing constraint at that point. If @code{tag} is positive, set the tag explicitly; @@ -1957,7 +1957,7 @@ the geo module.) integer value @end table -@item addLine +@item gmsh/model/geo/addLine Add a straight line segment between the two points with tags @code{startTag} and @code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the line. @@ -1971,7 +1971,7 @@ new tag is selected automatically. Return the tag of the line. integer value @end table -@item addCircleArc +@item gmsh/model/geo/addCircleArc Add a circle arc (strictly smaller than Pi) between the two points with tags @code{startTag} and @code{endTag}, with center @code{centertag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -1987,7 +1987,7 @@ the plane of the circle arc. Return the tag of the circle arc. integer value @end table -@item addEllipseArc +@item gmsh/model/geo/addEllipseArc Add an ellipse arc (strictly smaller than Pi) between the two points @code{startTag} and @code{endTag}, with center @code{centerTag} and major axis point @code{majorTag}. If @code{tag} is positive, set the tag explicitly; @@ -2004,7 +2004,7 @@ tag of the ellipse arc. integer value @end table -@item addSpline +@item gmsh/model/geo/addSpline Add a spline (Catmull-Rom) curve going through the points @code{pointTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Create a periodic curve if the first and last points are the @@ -2019,7 +2019,7 @@ same. Return the tag of the spline curve. integer value @end table -@item addBSpline +@item gmsh/model/geo/addBSpline Add a cubic b-spline curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Creates a periodic curve if the first and last points are the @@ -2034,7 +2034,7 @@ same. Return the tag of the b-spline curve. integer value @end table -@item addBezier +@item gmsh/model/geo/addBezier Add a Bezier curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the Bezier curve. @@ -2048,7 +2048,7 @@ Return the tag of the Bezier curve. integer value @end table -@item addCompoundSpline +@item gmsh/model/geo/addCompoundSpline Add a spline (Catmull-Rom) going through points sampling the curves in @code{curveTags}. The density of sampling points on each curve is governed by @code{numIntervals}. If @code{tag} is positive, set the tag explicitly; @@ -2063,7 +2063,7 @@ otherwise a new tag is selected automatically. Return the tag of the spline. integer value @end table -@item addCompoundBSpline +@item gmsh/model/geo/addCompoundBSpline Add a b-spline with control points sampling the curves in @code{curveTags}. The density of sampling points on each curve is governed by @code{numIntervals}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2078,7 +2078,7 @@ automatically. Return the tag of the b-spline. integer value @end table -@item addCurveLoop +@item gmsh/model/geo/addCurveLoop Add a curve loop (a closed wire) formed by the curves @code{curveTags}. @code{curveTags} should contain (signed) tags of model enties of dimension 1 forming a closed loop: a negative tag signifies that the underlying curve is @@ -2095,7 +2095,7 @@ curve loop. integer value @end table -@item addPlaneSurface +@item gmsh/model/geo/addPlaneSurface Add a plane surface defined by one or more curve loops @code{wireTags}. The first curve loop defines the exterior contour; additional curve loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is @@ -2110,7 +2110,7 @@ selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceFilling +@item gmsh/model/geo/addSurfaceFilling Add a surface filling the curve loops in @code{wireTags}. Currently only a single curve loop is supported; this curve loop should be composed by 3 or 4 curves only. If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2125,7 +2125,7 @@ tag is selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceLoop +@item gmsh/model/geo/addSurfaceLoop Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the shell. @@ -2139,7 +2139,7 @@ automatically. Return the tag of the shell. integer value @end table -@item addVolume +@item gmsh/model/geo/addVolume Add a volume (a region) defined by one or more shells @code{shellTags}. The first surface loop defines the exterior boundary; additional surface loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is @@ -2154,7 +2154,7 @@ selected automatically. Return the tag of the volume. integer value @end table -@item extrude +@item gmsh/model/geo/extrude Extrude the model entities @code{dimTags} by translation along (@code{dx}, @code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If @code{numElements} is not empty, also extrude the mesh: the entries in @@ -2172,7 +2172,7 @@ extruded along their normal. - @end table -@item revolve +@item gmsh/model/geo/revolve Extrude the model entities @code{dimTags} by rotation of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). The angle should @@ -2191,7 +2191,7 @@ normalized to 1. - @end table -@item twist +@item gmsh/model/geo/twist Extrude the model entities @code{dimTags} by a combined translation and rotation of @code{angle} radians, along (@code{dx}, @code{dy}, @code{dz}) and around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the @@ -2211,7 +2211,7 @@ normalized to 1. - @end table -@item translate +@item gmsh/model/geo/translate Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, @code{dz}). @@ -2224,7 +2224,7 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @end table -@item rotate +@item gmsh/model/geo/rotate Rotate the model entities @code{dimTags} of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). @@ -2238,7 +2238,7 @@ direction (@code{ax}, @code{ay}, @code{az}). - @end table -@item dilate +@item gmsh/model/geo/dilate Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and @code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as the center of the homothetic transformation. @@ -2252,7 +2252,7 @@ the center of the homothetic transformation. - @end table -@item symmetrize +@item gmsh/model/geo/symmetrize Apply a symmetry transformation to the model entities @code{dimTag}, with respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. @@ -2266,7 +2266,7 @@ respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + - @end table -@item copy +@item gmsh/model/geo/copy Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags}. @@ -2279,7 +2279,7 @@ Copy the entities @code{dimTags}; the new entities are returned in - @end table -@item remove +@item gmsh/model/geo/remove Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -2292,7 +2292,7 @@ entities on their boundaries, down to dimension 0. - @end table -@item removeAllDuplicates +@item gmsh/model/geo/removeAllDuplicates Remove all duplicate entities (different entities at the same geometrical location). @@ -2305,7 +2305,7 @@ location). - @end table -@item synchronize +@item gmsh/model/geo/synchronize Synchronize the built-in CAD representation with the current Gmsh model. This can be called at any time, but since it involves a non trivial amount of processing, the number of synchronization points should normally be minimized. @@ -2325,7 +2325,7 @@ processing, the number of synchronization points should normally be minimized. @section Namespace @code{gmsh/model/geo/mesh}: built-in CAD kernel meshing constraints @ftable @code -@item setSize +@item gmsh/model/geo/mesh/setSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -2338,7 +2338,7 @@ entities of dimension 0 (points) are handled. - @end table -@item setTransfiniteCurve +@item gmsh/model/geo/mesh/setTransfiniteCurve Set a transfinite meshing constraint on the curve @code{tag}, with @code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. Currently supported types are "Progression" (geometrical progression with power @@ -2353,7 +2353,7 @@ Currently supported types are "Progression" (geometrical progression with power - @end table -@item setTransfiniteSurface +@item gmsh/model/geo/mesh/setTransfiniteSurface Set a transfinite meshing constraint on the surface @code{tag}. @code{arrangement} describes the arrangement of the triangles when the surface is not flagged as recombined: currently supported values are "Left", "Right", @@ -2371,7 +2371,7 @@ its boundary. - @end table -@item setTransfiniteVolume +@item gmsh/model/geo/mesh/setTransfiniteVolume Set a transfinite meshing constraint on the surface @code{tag}. @code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite interpolation explicitly. @@ -2385,7 +2385,7 @@ interpolation explicitly. - @end table -@item setRecombine +@item gmsh/model/geo/mesh/setRecombine Set a recombination meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to recombine triangles into quadrangles) are supported. @@ -2399,7 +2399,7 @@ recombine triangles into quadrangles) are supported. - @end table -@item setSmoothing +@item gmsh/model/geo/mesh/setSmoothing Set a smoothing meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. @@ -2412,7 +2412,7 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @end table -@item setReverse +@item gmsh/model/geo/mesh/setReverse Set a reverse meshing constraint on the model entity of dimension @code{dim} and tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed with respect to the natural mesh orientation (i.e. the orientation consistent @@ -2428,7 +2428,7 @@ as-is. - @end table -@item setAlgorithm +@item gmsh/model/geo/mesh/setAlgorithm Set the meshing algorithm on the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -2441,7 +2441,7 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @end table -@item setSizeFromBoundary +@item gmsh/model/geo/mesh/setSizeFromBoundary Force the mesh size to be extended from the boundary, or not, for the model entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @code{dim} == 2. @@ -2461,7 +2461,7 @@ entity of dimension @code{dim} and tag @code{tag}. Currently only supported for @section Namespace @code{gmsh/model/occ}: OpenCASCADE CAD kernel functions @ftable @code -@item addPoint +@item gmsh/model/occ/addPoint Add a geometrical point in the OpenCASCADE CAD representation, at coordinates (@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing constraint at that point. If @code{tag} is positive, set the tag explicitly; @@ -2479,7 +2479,7 @@ the occ module.) integer value @end table -@item addLine +@item gmsh/model/occ/addLine Add a straight line segment between the two points with tags @code{startTag} and @code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the line. @@ -2493,7 +2493,7 @@ new tag is selected automatically. Return the tag of the line. integer value @end table -@item addCircleArc +@item gmsh/model/occ/addCircleArc Add a circle arc between the two points with tags @code{startTag} and @code{endTag}, with center @code{centerTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of @@ -2508,7 +2508,7 @@ the circle arc. integer value @end table -@item addCircle +@item gmsh/model/occ/addCircle Add a circle of center (@code{x}, @code{y}, @code{z}) and radius @code{r}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. If @code{angle1} and @code{angle2} are specified, create a circle @@ -2523,7 +2523,7 @@ arc between the two angles. Return the tag of the circle. integer value @end table -@item addEllipseArc +@item gmsh/model/occ/addEllipseArc Add an ellipse arc between the two points @code{startTag} and @code{endTag}, with center @code{centerTag} and major axis point @code{majorTag}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2539,7 +2539,7 @@ allow creating ellipse arcs with the major radius smaller than the minor radius. integer value @end table -@item addEllipse +@item gmsh/model/occ/addEllipse Add an ellipse of center (@code{x}, @code{y}, @code{z}) and radii @code{r1} and @code{r2} along the x- and y-axes respectively. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. If @@ -2558,7 +2558,7 @@ in such cases. integer value @end table -@item addSpline +@item gmsh/model/occ/addSpline Add a spline (C2 b-spline) curve going through the points @code{pointTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Create a periodic curve if the first and last points are the @@ -2573,7 +2573,7 @@ same. Return the tag of the spline curve. integer value @end table -@item addBSpline +@item gmsh/model/occ/addBSpline Add a b-spline curve of degree @code{degree} with @code{pointTags} control points. If @code{weights}, @code{knots} or @code{multiplicities} are not provided, default parameters are computed automatically. If @code{tag} is @@ -2590,7 +2590,7 @@ tag of the b-spline curve. integer value @end table -@item addBezier +@item gmsh/model/occ/addBezier Add a Bezier curve with @code{pointTags} control points. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the Bezier curve. @@ -2604,7 +2604,7 @@ Return the tag of the Bezier curve. integer value @end table -@item addWire +@item gmsh/model/occ/addWire Add a wire (open or closed) formed by the curves @code{curveTags}. Note that an OpenCASCADE wire can be made of curves that share geometrically identical (but topologically different) points. If @code{tag} is positive, set the tag @@ -2620,7 +2620,7 @@ wire. integer value @end table -@item addCurveLoop +@item gmsh/model/occ/addCurveLoop Add a curve loop (a closed wire) formed by the curves @code{curveTags}. @code{curveTags} should contain tags of curves forming a closed loop. Note that an OpenCASCADE curve loop can be made of curves that share geometrically @@ -2637,7 +2637,7 @@ tag of the curve loop. integer value @end table -@item addRectangle +@item gmsh/model/occ/addRectangle Add a rectangle with lower left corner at (@code{x}, @code{y}, @code{z}) and upper right corner at (@code{x} + @code{dx}, @code{y} + @code{dy}, @code{z}). If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected @@ -2653,7 +2653,7 @@ tag of the rectangle. integer value @end table -@item addDisk +@item gmsh/model/occ/addDisk Add a disk with center (@code{xc}, @code{yc}, @code{zc}) and radius @code{rx} along the x-axis and @code{ry} along the y-axis. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the @@ -2668,7 +2668,7 @@ tag of the disk. integer value @end table -@item addPlaneSurface +@item gmsh/model/occ/addPlaneSurface Add a plane surface defined by one or more curve loops (or closed wires) @code{wireTags}. The first curve loop defines the exterior contour; additional curve loop define holes. If @code{tag} is positive, set the tag explicitly; @@ -2683,7 +2683,7 @@ otherwise a new tag is selected automatically. Return the tag of the surface. integer value @end table -@item addSurfaceFilling +@item gmsh/model/occ/addSurfaceFilling Add a surface filling the curve loops in @code{wireTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the surface. If @code{pointTags} are provided, force the @@ -2698,7 +2698,7 @@ surface to pass through the given points. integer value @end table -@item addSurfaceLoop +@item gmsh/model/occ/addSurfaceLoop Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the surface loop. Setting @code{sewing} allows @@ -2714,7 +2714,7 @@ topologically different) curves. integer value @end table -@item addVolume +@item gmsh/model/occ/addVolume Add a volume (a region) defined by one or more surface loops @code{shellTags}. The first surface loop defines the exterior boundary; additional surface loop define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2729,7 +2729,7 @@ tag is selected automatically. Return the tag of the volume. integer value @end table -@item addSphere +@item gmsh/model/occ/addSphere Add a sphere of center (@code{xc}, @code{yc}, @code{zc}) and radius @code{r}. The optional @code{angle1} and @code{angle2} arguments define the polar angle opening (from -Pi/2 to Pi/2). The optional @code{angle3} argument defines the @@ -2746,7 +2746,7 @@ sphere. integer value @end table -@item addBox +@item gmsh/model/occ/addBox Add a parallelepipedic box defined by a point (@code{x}, @code{y}, @code{z}) and the extents along the x-, y- and z-axes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. Return the tag of the @@ -2761,7 +2761,7 @@ box. integer value @end table -@item addCylinder +@item gmsh/model/occ/addCylinder Add a cylinder, defined by the center (@code{x}, @code{y}, @code{z}) of its first circular face, the 3 components (@code{dx}, @code{dy}, @code{dz}) of the vector defining its axis and its radius @code{r}. The optional @code{angle} @@ -2778,7 +2778,7 @@ Return the tag of the cylinder. integer value @end table -@item addCone +@item gmsh/model/occ/addCone Add a cone, defined by the center (@code{x}, @code{y}, @code{z}) of its first circular face, the 3 components of the vector (@code{dx}, @code{dy}, @code{dz}) defining its axis and the two radii @code{r1} and @code{r2} of the faces (these @@ -2795,7 +2795,7 @@ opening (from 0 to 2*Pi). Return the tag of the cone. integer value @end table -@item addWedge +@item gmsh/model/occ/addWedge Add a right angular wedge, defined by the right-angle point (@code{x}, @code{y}, @code{z}) and the 3 extends along the x-, y- and z-axes (@code{dx}, @code{dy}, @code{dz}). If @code{tag} is positive, set the tag explicitly; otherwise a new @@ -2811,7 +2811,7 @@ extent along the x-axis. Return the tag of the wedge. integer value @end table -@item addTorus +@item gmsh/model/occ/addTorus Add a torus, defined by its center (@code{x}, @code{y}, @code{z}) and its 2 radii @code{r} and @code{r2}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. The optional argument @@ -2827,7 +2827,7 @@ wedge. integer value @end table -@item addThruSections +@item gmsh/model/occ/addThruSections Add a volume (if the optional argument @code{makeSolid} is set) or surfaces defined through the open or closed wires @code{wireTags}. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is selected automatically. @@ -2844,7 +2844,7 @@ ruled surfaces. - @end table -@item addThickSolid +@item gmsh/model/occ/addThickSolid Add a hollowed volume built from an initial volume @code{volumeTag} and a set of faces from this volume @code{excludeSurfaceTags}, which are to be removed. The remaining faces of the volume become the walls of the hollowed solid, with @@ -2860,7 +2860,7 @@ otherwise a new tag is selected automatically. - @end table -@item extrude +@item gmsh/model/occ/extrude Extrude the model entities @code{dimTags} by translation along (@code{dx}, @code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If @code{numElements} is not empty, also extrude the mesh: the entries in @@ -2877,7 +2877,7 @@ normalized to 1. - @end table -@item revolve +@item gmsh/model/occ/revolve Extrude the model entities @code{dimTags} by rotation of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). Return extruded @@ -2896,7 +2896,7 @@ strictly smaller than 2*Pi. - @end table -@item addPipe +@item gmsh/model/occ/addPipe Add a pipe by extruding the entities @code{dimTags} along the wire @code{wireTag}. Return the pipe in @code{outDimTags}. @@ -2909,7 +2909,7 @@ Add a pipe by extruding the entities @code{dimTags} along the wire - @end table -@item fillet +@item gmsh/model/occ/fillet Fillet the volumes @code{volumeTags} on the curves @code{curveTags} with radii @code{radii}. The @code{radii} vector can either contain a single radius, as many radii as @code{curveTags}, or twice as many as @code{curveTags} (in which @@ -2926,7 +2926,7 @@ Return the filleted entities in @code{outDimTags}. Remove the original volume if - @end table -@item chamfer +@item gmsh/model/occ/chamfer Chamfer the volumes @code{volumeTags} on the curves @code{curveTags} with distances @code{distances} measured on surfaces @code{surfaceTags}. The @code{distances} vector can either contain a single distance, as many distances @@ -2945,7 +2945,7 @@ original volume if @code{removeVolume} is set. - @end table -@item fuse +@item gmsh/model/occ/fuse Compute the boolean union (the fusion) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly (only valid if the boolean @@ -2961,7 +2961,7 @@ is set. Remove the tool if @code{removeTool} is set. - @end table -@item intersect +@item gmsh/model/occ/intersect Compute the boolean intersection (the common parts) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly @@ -2978,7 +2978,7 @@ set. - @end table -@item cut +@item gmsh/model/occ/cut Compute the boolean difference between the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly (only valid if the boolean @@ -2994,7 +2994,7 @@ is set. Remove the tool if @code{removeTool} is set. - @end table -@item fragment +@item gmsh/model/occ/fragment Compute the boolean fragments (general fuse) of the entities @code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly @@ -3011,7 +3011,7 @@ set. - @end table -@item translate +@item gmsh/model/occ/translate Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, @code{dz}). @@ -3024,7 +3024,7 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @end table -@item rotate +@item gmsh/model/occ/rotate Rotate the model entities @code{dimTags} of @code{angle} radians around the axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). @@ -3038,7 +3038,7 @@ direction (@code{ax}, @code{ay}, @code{az}). - @end table -@item dilate +@item gmsh/model/occ/dilate Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and @code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as the center of the homothetic transformation. @@ -3052,7 +3052,7 @@ the center of the homothetic transformation. - @end table -@item symmetrize +@item gmsh/model/occ/symmetrize Apply a symmetry transformation to the model entities @code{dimTag}, with respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. @@ -3066,7 +3066,7 @@ respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + - @end table -@item affineTransform +@item gmsh/model/occ/affineTransform Apply a general affine transformation matrix @code{a} (16 entries of a 4x4 matrix, by row; only the 12 first can be provided for convenience) to the model entities @code{dimTag}. @@ -3080,7 +3080,7 @@ entities @code{dimTag}. - @end table -@item copy +@item gmsh/model/occ/copy Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags}. @@ -3093,7 +3093,7 @@ Copy the entities @code{dimTags}; the new entities are returned in - @end table -@item remove +@item gmsh/model/occ/remove Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the entities on their boundaries, down to dimension 0. @@ -3106,7 +3106,7 @@ entities on their boundaries, down to dimension 0. - @end table -@item removeAllDuplicates +@item gmsh/model/occ/removeAllDuplicates Remove all duplicate entities (different entities at the same geometrical location) after intersecting (using boolean fragments) all highest dimensional entities. @@ -3120,7 +3120,7 @@ entities. - @end table -@item healShapes +@item gmsh/model/occ/healShapes Apply various healing procedures to the entities @code{dimTags} (or to all the entities in the model if @code{dimTags} is empty). Return the healed entities in @code{outDimTags}. Available healing options are listed in the Gmsh reference @@ -3135,7 +3135,7 @@ manual. - @end table -@item importShapes +@item gmsh/model/occ/importShapes Import BREP, STEP or IGES shapes from the file @code{fileName}. The imported entities are returned in @code{outDimTags}. If the optional argument @code{highestDimOnly} is set, only import the highest dimensional entities in @@ -3151,7 +3151,7 @@ the file (currently "brep", "step" or "iges"). - @end table -@item importShapesNativePointer +@item gmsh/model/occ/importShapesNativePointer Imports an OpenCASCADE @code{shape} by providing a pointer to a native OpenCASCADE @code{TopoDS_Shape} object (passed as a pointer to void). The imported entities are returned in @code{outDimTags}. If the optional argument @@ -3168,7 +3168,7 @@ an invalid pointer will lead to undefined behavior. - @end table -@item setMeshSize +@item gmsh/model/occ/setMeshSize Set a mesh size constraint on the model entities @code{dimTags}. Currently only entities of dimension 0 (points) are handled. @@ -3181,7 +3181,7 @@ entities of dimension 0 (points) are handled. - @end table -@item getMass +@item gmsh/model/occ/getMass Get the mass of the model entity of dimension @code{dim} and tag @code{tag}. @table @asis @@ -3193,7 +3193,7 @@ Get the mass of the model entity of dimension @code{dim} and tag @code{tag}. - @end table -@item getCenterOfMass +@item gmsh/model/occ/getCenterOfMass Get the center of mass of the model entity of dimension @code{dim} and tag @code{tag}. @@ -3206,7 +3206,7 @@ Get the center of mass of the model entity of dimension @code{dim} and tag - @end table -@item getMatrixOfInertia +@item gmsh/model/occ/getMatrixOfInertia Get the matrix of inertia (by row) of the model entity of dimension @code{dim} and tag @code{tag}. @@ -3219,7 +3219,7 @@ and tag @code{tag}. - @end table -@item synchronize +@item gmsh/model/occ/synchronize Synchronize the OpenCASCADE CAD representation with the current Gmsh model. This can be called at any time, but since it involves a non trivial amount of processing, the number of synchronization points should normally be minimized. @@ -3239,7 +3239,7 @@ processing, the number of synchronization points should normally be minimized. @section Namespace @code{gmsh/view}: post-processing view functions @ftable @code -@item add +@item gmsh/view/add Add a new post-processing view, with name @code{name}. If @code{tag} is positive use it (and remove the view with that tag if it already exists), otherwise associate a new tag. Return the view tag. @@ -3253,7 +3253,7 @@ associate a new tag. Return the view tag. integer value @end table -@item remove +@item gmsh/view/remove Remove the view with tag @code{tag}. @table @asis @@ -3265,7 +3265,7 @@ Remove the view with tag @code{tag}. - @end table -@item getIndex +@item gmsh/view/getIndex Get the index of the view with tag @code{tag} in the list of currently loaded views. This dynamic index (it can change when views are removed) is used to access view options. @@ -3279,7 +3279,7 @@ access view options. integer value @end table -@item getTags +@item gmsh/view/getTags Get the tags of all views. @table @asis @@ -3291,7 +3291,7 @@ Get the tags of all views. - @end table -@item addModelData +@item gmsh/view/addModelData Add model-based post-processing data to the view with tag @code{tag}. @code{modelName} identifies the model the data is attached to. @code{dataType} specifies the type of data, currently either "NodeData", "ElementData" or @@ -3314,7 +3314,7 @@ data. @code{partition} allows to specify data in several sub-sets. - @end table -@item getModelData +@item gmsh/view/getModelData Get model-based post-processing data from the view with tag @code{tag} at step @code{step}. Return the @code{data} associated to the nodes or the elements with tags @code{tags}, as well as the @code{dataType} and the number of components @@ -3329,7 +3329,7 @@ tags @code{tags}, as well as the @code{dataType} and the number of components - @end table -@item addListData +@item gmsh/view/addListData Add list-based post-processing data to the view with tag @code{tag}. @code{dataType} identifies the data: "SP" for scalar points, "VP", for vector points, etc. @code{numEle} gives the number of elements in the data. @code{data} @@ -3344,7 +3344,7 @@ contains the data for the @code{numEle} elements. - @end table -@item getListData +@item gmsh/view/getListData Get list-based post-processing data from the view with tag @code{tag}. Return the types @code{dataTypes}, the number of elements @code{numElements} for each data type and the @code{data} for each data type. @@ -3358,7 +3358,7 @@ data type and the @code{data} for each data type. - @end table -@item addAlias +@item gmsh/view/addAlias Add a post-processing view as an @code{alias} of the reference view with tag @code{refTag}. If @code{copyOptions} is set, copy the options of the reference view. If @code{tag} is positive use it (and remove the view with that tag if it @@ -3373,7 +3373,7 @@ already exists), otherwise associate a new tag. Return the view tag. integer value @end table -@item copyOptions +@item gmsh/view/copyOptions Copy the options from the view with tag @code{refTag} to the view with tag @code{tag}. @@ -3386,7 +3386,7 @@ Copy the options from the view with tag @code{refTag} to the view with tag - @end table -@item combine +@item gmsh/view/combine Combine elements (if @code{what} == "elements") or steps (if @code{what} == "steps") of all views (@code{how} == "all"), all visible views (@code{how} == "visible") or all views having the same name (@code{how} == "name"). Remove @@ -3401,7 +3401,7 @@ original views if @code{remove} is set. - @end table -@item probe +@item gmsh/view/probe Probe the view @code{tag} for its @code{value} at point (@code{x}, @code{y}, @code{z}). Return only the value at step @code{step} is @code{step} is positive. Return only values with @code{numComp} if @code{numComp} is positive. Return the @@ -3420,7 +3420,7 @@ its coordinates if @code{xElementCoord}, @code{yElementCoord} and - @end table -@item write +@item gmsh/view/write Write the view to a file @code{fileName}. The export format is determined by the file extension. Append to the file if @code{append} is set. @@ -3439,7 +3439,7 @@ file extension. Append to the file if @code{append} is set. @section Namespace @code{gmsh/plugin}: plugin functions @ftable @code -@item setNumber +@item gmsh/plugin/setNumber Set the numerical option @code{option} to the value @code{value} for plugin @code{name}. @@ -3452,7 +3452,7 @@ Set the numerical option @code{option} to the value @code{value} for plugin - @end table -@item setString +@item gmsh/plugin/setString Set the string option @code{option} to the value @code{value} for plugin @code{name}. @@ -3465,7 +3465,7 @@ Set the string option @code{option} to the value @code{value} for plugin - @end table -@item run +@item gmsh/plugin/run Run the plugin @code{name}. @table @asis @@ -3483,7 +3483,7 @@ Run the plugin @code{name}. @section Namespace @code{gmsh/graphics}: graphics functions @ftable @code -@item draw +@item gmsh/graphics/draw Draw all the OpenGL scenes. @table @asis @@ -3501,7 +3501,7 @@ Draw all the OpenGL scenes. @section Namespace @code{gmsh/fltk}: FLTK graphical user interface functions @ftable @code -@item initialize +@item gmsh/fltk/initialize Create the FLTK graphical user interface. Can only be called in the main thread. @table @asis @@ -3513,7 +3513,7 @@ Create the FLTK graphical user interface. Can only be called in the main thread. - @end table -@item wait +@item gmsh/fltk/wait Wait at most @code{time} seconds for user interface events and return. If @code{time} < 0, wait indefinitely. First automatically create the user interface if it has not yet been initialized. Can only be called in the main @@ -3528,7 +3528,7 @@ thread. - @end table -@item update +@item gmsh/fltk/update Update the user interface (potentially creating new widgets and windows). First automatically create the user interface if it has not yet been initialized. Can only be called in the main thread: use @code{awake("update")} to trigger an @@ -3543,7 +3543,7 @@ update of the user interface from another thread. - @end table -@item awake +@item gmsh/fltk/awake Awake the main user interface thread and process pending events, and optionally perform an action (currently the only @code{action} allowed is "update"). @@ -3556,7 +3556,7 @@ perform an action (currently the only @code{action} allowed is "update"). - @end table -@item lock +@item gmsh/fltk/lock Block the current thread until it can safely modify the user interface. @table @asis @@ -3568,7 +3568,7 @@ Block the current thread until it can safely modify the user interface. - @end table -@item unlock +@item gmsh/fltk/unlock Release the lock that was set using lock. @table @asis @@ -3580,7 +3580,7 @@ Release the lock that was set using lock. - @end table -@item run +@item gmsh/fltk/run Run the event loop of the graphical user interface, i.e. repeatedly call @code{wait()}. First automatically create the user interface if it has not yet been initialized. Can only be called in the main thread. @@ -3594,7 +3594,7 @@ been initialized. Can only be called in the main thread. - @end table -@item isAvailable +@item gmsh/fltk/isAvailable Check if the user interface is available (e.g. to detect if it has been closed). @table @asis @@ -3606,7 +3606,7 @@ Check if the user interface is available (e.g. to detect if it has been closed). integer value @end table -@item selectEntities +@item gmsh/fltk/selectEntities Select entities in the user interface. If @code{dim} is >= 0, return only the entities of the specified dimension (e.g. points if @code{dim} == 0). @@ -3619,7 +3619,7 @@ entities of the specified dimension (e.g. points if @code{dim} == 0). integer value @end table -@item selectElements +@item gmsh/fltk/selectElements Select elements in the user interface. @table @asis @@ -3631,7 +3631,7 @@ Select elements in the user interface. integer value @end table -@item selectViews +@item gmsh/fltk/selectViews Select views in the user interface. @table @asis @@ -3649,7 +3649,7 @@ integer value @section Namespace @code{gmsh/onelab}: ONELAB server functions @ftable @code -@item set +@item gmsh/onelab/set Set one or more parameters in the ONELAB database, encoded in @code{format}. @table @asis @@ -3661,7 +3661,7 @@ Set one or more parameters in the ONELAB database, encoded in @code{format}. - @end table -@item get +@item gmsh/onelab/get Get all the parameters (or a single one if @code{name} is specified) from the ONELAB database, encoded in @code{format}. @@ -3674,7 +3674,7 @@ ONELAB database, encoded in @code{format}. - @end table -@item setNumber +@item gmsh/onelab/setNumber Set the value of the number parameter @code{name} in the ONELAB database. Create the parameter if it does not exist; update the value if the parameter exists. @@ -3687,7 +3687,7 @@ the parameter if it does not exist; update the value if the parameter exists. - @end table -@item setString +@item gmsh/onelab/setString Set the value of the string parameter @code{name} in the ONELAB database. Create the parameter if it does not exist; update the value if the parameter exists. @@ -3700,7 +3700,7 @@ the parameter if it does not exist; update the value if the parameter exists. - @end table -@item getNumber +@item gmsh/onelab/getNumber Get the value of the number parameter @code{name} from the ONELAB database. Return an empty vector if the parameter does not exist. @@ -3713,7 +3713,7 @@ Return an empty vector if the parameter does not exist. - @end table -@item getString +@item gmsh/onelab/getString Get the value of the string parameter @code{name} from the ONELAB database. Return an empty vector if the parameter does not exist. @@ -3726,7 +3726,7 @@ Return an empty vector if the parameter does not exist. - @end table -@item clear +@item gmsh/onelab/clear Clear the ONELAB database, or remove a single parameter if @code{name} is given. @table @asis @@ -3738,7 +3738,7 @@ Clear the ONELAB database, or remove a single parameter if @code{name} is given. - @end table -@item run +@item gmsh/onelab/run Run a ONELAB client. If @code{name} is provided, create a new ONELAB client with name @code{name} and executes @code{command}. If not, try to run a client that might be linked to the processed input files. @@ -3758,7 +3758,7 @@ might be linked to the processed input files. @section Namespace @code{gmsh/logger}: information logging functions @ftable @code -@item write +@item gmsh/logger/write Write a @code{message}. @code{level} can be "info", "warning" or "error". @table @asis @@ -3770,7 +3770,7 @@ Write a @code{message}. @code{level} can be "info", "warning" or "error". - @end table -@item start +@item gmsh/logger/start Start logging messages. @table @asis @@ -3782,7 +3782,7 @@ Start logging messages. - @end table -@item get +@item gmsh/logger/get Get logged messages. @table @asis @@ -3794,7 +3794,7 @@ Get logged messages. - @end table -@item stop +@item gmsh/logger/stop Stop logging messages. @table @asis @@ -3806,7 +3806,7 @@ Stop logging messages. - @end table -@item getWallTime +@item gmsh/logger/getWallTime Return wall clock time. @table @asis @@ -3818,7 +3818,7 @@ Return wall clock time. floating point value @end table -@item getCpuTime +@item gmsh/logger/getCpuTime Return CPU time. @table @asis diff --git a/utils/docker/README b/utils/docker/README index 6a3b57c624..da252702a3 100644 --- a/utils/docker/README +++ b/utils/docker/README @@ -1,9 +1,10 @@ -# build image (add "--build-arg REBUILD_GMSH=yes" to rebuild the Gmsh lib) +# build image (add "--build-arg REBUILD_GMSH=123" to rebuild the Gmsh lib, where +# 123 must be different from build to build) -docker build -f Dockerfile.ubuntu18.10 -t onelab/ubuntu18.10 --build-arg REBUILD_GMSH=yes . -docker build -f Dockerfile.debian.wheezy.64bit -t onelab/debian.wheezy.64bit --build-arg REBUILD_GMSH=yes . -docker build -f Dockerfile.debian.wheezy.32bit -t onelab/debian.wheezy.32bit --build-arg REBUILD_GMSH=yes . +docker build -f Dockerfile.ubuntu18.10 -t onelab/ubuntu18.10 --build-arg REBUILD_GMSH=123 . +docker build -f Dockerfile.debian.wheezy.64bit -t onelab/debian.wheezy.64bit --build-arg REBUILD_GMSH=123 . +docker build -f Dockerfile.debian.wheezy.32bit -t onelab/debian.wheezy.32bit --build-arg REBUILD_GMSH=123 . # push image to docker-hub -- GitLab