diff --git a/api/GenApi.py b/api/GenApi.py index 41dcd1b07ce68ea98916359fe5425dfedbeefe6a..38a121a3c443caf9d6bc9d570b8dd38bd3e362d4 100644 --- a/api/GenApi.py +++ b/api/GenApi.py @@ -8,6 +8,8 @@ import textwrap import string +import os +import re class arg: def __init__(self, name, value, python_value, julia_value, @@ -1429,7 +1431,34 @@ class API: write_module(f, module, "", "", 1) def write_texi(self): - def write_module(module, path, node, node_next, node_prev): + def tryint(s): + try: + return int(s) + except: + return s + def alphanum_key(s): + return [ tryint(c) for c in re.split('([0-9]+)', s) ] + def get_file_data(path, ext): + data = [] + for r, d, f in os.walk(path): + for file in f: + if file.endswith(ext): + filename = os.path.join(r, file) + contents = [] + for line in open(filename, 'r'): + contents.append(line) + data.append([filename, contents]) + data.sort(key=lambda x: alphanum_key(x[0])) + return data + def find_function(name, data): + for file in data: + l = 0 + for line in file[1]: + l = l+1 + if re.search(name, line): + return file[0], l + return '', 0 + def write_module(module, path, node, node_next, node_prev, cpp_data, py_data): f.write("@node " + node + ", " + node_next + ", " + node_prev + ", Gmsh API\n"); f.write("@section Namespace @code{" + path + "}: " + module.doc + "\n\n"); f.write("@ftable @code\n"); @@ -1448,6 +1477,23 @@ class API: if len(oargs) else "-") + "\n") f.write("@item " + "Return:\n" + (rtype.rtexi_type if rtype else "-") + "\n") + cpp_name = path.replace('/', '::') + '::' + name + cpp_file, cpp_line = find_function(cpp_name, cpp_data) + py_name = path.replace('/', '.') + '.' + name + py_file, py_line = find_function(py_name, py_data) + if cpp_file or py_file: + git = 'https://gitlab.onelab.info/gmsh/gmsh/tree/master/' + f.write("@item " + "Examples:\n") + if cpp_file: + f.write('C++ (@url{' + git + cpp_file[3:] + + '#L' + str(cpp_line) + ',' + + os.path.basename(cpp_file) + '})') + if py_file: f.write(', ') + if py_file: + f.write('Python (@url{' + git + py_file[3:] + + '#L' + str(py_line) + ',' + + os.path.basename(py_file) + '})') + f.write('\n') f.write("@end table\n\n"); f.write("@end ftable\n\n"); with open("api.texi", "w") as f: @@ -1467,7 +1513,12 @@ class API: for i in range(N): f.write("* " + node_name(flat[i]) + "::\n") f.write("@end menu\n\n") + cpp_data = get_file_data('../tutorial', '.cpp') + cpp_data.extend(get_file_data('../demos/api', '.cpp')) + py_data = get_file_data('../tutorial', '.py') + py_data.extend(get_file_data('../demos/api', '.py')) for i in range(N): write_module(flat[i][0], flat[i][1], node_name(flat[i]), "" if i == N - 1 else node_name(flat[i+1]), - "" if i == 0 else node_name(flat[i-1])) + "" if i == 0 else node_name(flat[i-1]), + cpp_data, py_data) diff --git a/api/api.texi b/api/api.texi index bf858b3abe93129f9c1477316b75363e70ca9f58..d542d7524268a48cfad94c6f1401b1261657d400 100644 --- a/api/api.texi +++ b/api/api.texi @@ -36,6 +36,8 @@ configuration files (gmshrc and gmsh-options). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L16,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L14,t1.py}) @end table @item gmsh/finalize @@ -48,6 +50,8 @@ Finalize Gmsh. This must be called when you are done using the Gmsh API. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L175,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L170,t1.py}) @end table @item gmsh/open @@ -62,6 +66,8 @@ model data will create a new model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L31,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L29,x1.py}) @end table @item gmsh/merge @@ -76,6 +82,8 @@ file with model data will add the data to the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L38,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L35,t7.py}) @end table @item gmsh/write @@ -88,6 +96,8 @@ Write a file. The export format is determined by the file extension. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L126,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L121,t1.py}) @end table @item gmsh/clear @@ -120,6 +130,8 @@ are listed in the Gmsh reference manual. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L20,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L18,t1.py}) @end table @item gmsh/option/getNumber @@ -134,6 +146,8 @@ are listed in the Gmsh reference manual. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L118,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L149,t8.py}) @end table @item gmsh/option/setString @@ -148,6 +162,8 @@ are listed in the Gmsh reference manual. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L143,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L138,t1.py}) @end table @item gmsh/option/getString @@ -162,6 +178,8 @@ are listed in the Gmsh reference manual. @code{value} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L33,test.py}) @end table @item gmsh/option/setColor @@ -178,6 +196,8 @@ reference manual, with the "Color." middle string removed. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L83,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L80,t3.py}) @end table @item gmsh/option/getColor @@ -193,6 +213,8 @@ the "Color." middle string removed. @code{r}, @code{g}, @code{b}, @code{a} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L91,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L87,t3.py}) @end table @end ftable @@ -211,6 +233,8 @@ Add a new model, with name @code{name}, and set it as the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L22,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L20,t1.py}) @end table @item gmsh/model/remove @@ -223,6 +247,8 @@ Remove the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L91,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L80,t18.py}) @end table @item gmsh/model/list @@ -247,6 +273,8 @@ Get the name of the current model. @code{name} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L12,explore.py}) @end table @item gmsh/model/setCurrent @@ -260,6 +288,8 @@ the same name, select the one that was added first. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L123,x3.py}) @end table @item gmsh/model/getEntities @@ -274,6 +304,8 @@ entities are returned as a vector of (dim, tag) integer pairs. @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L198,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L181,t5.py}) @end table @item gmsh/model/setEntityName @@ -298,6 +330,8 @@ Get the name of the entity of dimension @code{dim} and tag @code{tag}. @code{name} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_assembly.py#L13,step_assembly.py}) @end table @item gmsh/model/getPhysicalGroups @@ -312,6 +346,8 @@ only the entities of the specified dimension (e.g. physical points if @code{dim} @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L103,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L88,x1.py}) @end table @item gmsh/model/getEntitiesForPhysicalGroup @@ -338,6 +374,8 @@ dimension @code{dim} and tag @code{tag} belongs. @code{physicalTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L103,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L88,x1.py}) @end table @item gmsh/model/addPhysicalGroup @@ -352,6 +390,8 @@ tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L109,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L104,t1.py}) @end table @item gmsh/model/setPhysicalName @@ -364,6 +404,8 @@ Set the name of the physical group of dimension @code{dim} and tag @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L111,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L106,t1.py}) @end table @item gmsh/model/getPhysicalName @@ -393,6 +435,8 @@ recursively down to dimension 0 (i.e. to points) if @code{recursive} is true. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L169,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L164,t1.py}) @end table @item gmsh/model/getEntitiesInBoundingBox @@ -408,6 +452,8 @@ dimension (e.g. points if @code{dim} == 0). @code{tags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L125,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L101,t16.py}) @end table @item gmsh/model/getBoundingBox @@ -423,6 +469,8 @@ the whole model. @code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L112,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L101,t18.py}) @end table @item gmsh/model/getDimension @@ -452,6 +500,8 @@ overall model. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L84,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L76,x2.py}) @end table @item gmsh/model/removeEntities @@ -465,6 +515,8 @@ true, remove all the entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L91,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L80,t18.py}) @end table @item gmsh/model/removeEntityName @@ -514,6 +566,8 @@ Get the type of the entity of dimension @code{dim} and tag @code{tag}. @code{entityType} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L115,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L95,t21.py}) @end table @item gmsh/model/getParent @@ -528,6 +582,8 @@ tag @code{tag}, i.e. from which the entity is a part of, if any. @code{parentDim}, @code{parentTag} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L123,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L97,t21.py}) @end table @item gmsh/model/getPartitions @@ -541,6 +597,8 @@ belongs. @code{partitions} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L112,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L93,t21.py}) @end table @item gmsh/model/getValue @@ -559,6 +617,8 @@ coordinates in @code{points}, concatenated: [p1x, p1y, p1z, p2x, ...]. @code{points} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L91,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L87,t2.py}) @end table @item gmsh/model/getDerivative @@ -596,6 +656,8 @@ u, v parametric coordinates on the surface, concatenated: [p1u, p1v, p2u, ...]). @code{curvatures} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L28,normals.py}) @end table @item gmsh/model/getPrincipalCurvatures @@ -626,6 +688,8 @@ triplets of x, y, z components, concatenated: [n1x, n1y, n1z, n2x, ...]. @code{normals} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L26,normals.py}) @end table @item gmsh/model/getParametrization @@ -656,6 +720,8 @@ the visibility setting recursively if @code{recursive} is true. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L199,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L182,t5.py}) @end table @item gmsh/model/getVisibility @@ -684,6 +750,8 @@ should be integers between 0 and 255. Apply the color setting recursively if - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L159,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L157,t4.py}) @end table @item gmsh/model/getColor @@ -696,6 +764,8 @@ Get the color of the model entity of dimension @code{dim} and tag @code{tag}. @code{r}, @code{g}, @code{b}, @code{a} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_boundary_colors.py#L12,step_boundary_colors.py}) @end table @item gmsh/model/setCoordinates @@ -726,6 +796,8 @@ Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L123,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L118,t1.py}) @end table @item gmsh/model/mesh/partition @@ -738,6 +810,8 @@ Partition the mesh of the current model into @code{numPart} partitions. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L86,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L73,t21.py}) @end table @item gmsh/model/mesh/unpartition @@ -768,6 +842,8 @@ Laplace smoothing, "Relocate2D" and "Relocate3D" for node relocation). If - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/opt.py#L13,opt.py}) @end table @item gmsh/model/mesh/recombine @@ -780,6 +856,8 @@ Recombine the mesh of the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L90,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L88,t11.py}) @end table @item gmsh/model/mesh/refine @@ -792,6 +870,8 @@ Refine the mesh of the current model by uniformly splitting the elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L92,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L90,t11.py}) @end table @item gmsh/model/mesh/setOrder @@ -804,6 +884,8 @@ Set the order of the elements in the mesh of the current model to @code{order}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L35,boolean.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L17,periodic.py}) @end table @item gmsh/model/mesh/getLastEntityError @@ -845,6 +927,8 @@ another entity with a non-empty mesh. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L30,flatten.py}) @end table @item gmsh/model/mesh/getNodes @@ -869,6 +953,8 @@ the entity if @code{dim} >= 0 in order to compute their parametric coordinates). @code{nodeTags}, @code{coord}, @code{parametricCoord} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L70,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L66,x1.py}) @end table @item gmsh/model/mesh/getNodesByElementType @@ -898,6 +984,8 @@ often preferable. @code{coord}, @code{parametricCoord} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L70,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L66,x1.py}) @end table @item gmsh/model/mesh/setNode @@ -961,6 +1049,8 @@ automatically assigned to the nodes. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L90,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L82,x2.py}) @end table @item gmsh/model/mesh/reclassifyNodes @@ -976,6 +1066,8 @@ after the elements have been set. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L105,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L96,x2.py}) @end table @item gmsh/model/mesh/relocateNodes @@ -1015,6 +1107,8 @@ that contains the node tags of all the elements of the given type, concatenated: @code{elementTypes}, @code{elementTags}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L75,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L69,x1.py}) @end table @item gmsh/model/mesh/getElement @@ -1029,6 +1123,8 @@ otherwise); for large meshes accessing elements in bulk is often preferable. @code{elementType}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L75,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L69,x1.py}) @end table @item gmsh/model/mesh/getElementByCoordinates @@ -1096,6 +1192,8 @@ mesh. @code{elementTypes} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L33,edges.cpp}) @end table @item gmsh/model/mesh/getElementType @@ -1111,6 +1209,8 @@ corresponding serendip element type (element without interior nodes). - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L33,edges.cpp}) @end table @item gmsh/model/mesh/getElementProperties @@ -1127,6 +1227,8 @@ of primary (first order) nodes (@code{numPrimaryNodes}). @code{elementName}, @code{dim}, @code{order}, @code{numNodes}, @code{nodeCoord}, @code{numPrimaryNodes} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L128,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L100,x1.py}) @end table @item gmsh/model/mesh/getElementsByType @@ -1147,6 +1249,8 @@ indexed by @code{task}. @code{elementTags}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L55,edges.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L19,adapt_mesh.py}) @end table @item gmsh/model/mesh/preallocateElementsByType @@ -1181,6 +1285,8 @@ e1nN, e2n1, ...]. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L96,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L88,x2.py}) @end table @item gmsh/model/mesh/addElementsByType @@ -1199,6 +1305,8 @@ are automatically assigned to the elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L96,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L88,x2.py}) @end table @item gmsh/model/mesh/getIntegrationPoints @@ -1216,6 +1324,8 @@ points in the reference element: [g1u, g1v, g1w, ..., gGu, gGv, gGw]. @code{integrationPoints}, @code{integrationWeights} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L84,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L31,adapt_mesh.py}) @end table @item gmsh/model/mesh/getJacobians @@ -1241,6 +1351,8 @@ and return the part of the data indexed by @code{task}. @code{jacobians}, @code{determinants}, @code{points} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L86,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L32,adapt_mesh.py}) @end table @item gmsh/model/mesh/preallocateJacobians @@ -1279,6 +1391,8 @@ orientations. @code{numComponents}, @code{basisFunctions}, @code{numOrientations} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L91,edges.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L33,adapt_mesh.py}) @end table @item gmsh/model/mesh/getBasisFunctionsOrientationForElements @@ -1434,6 +1548,8 @@ indexed by @code{task}. @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L61,edges.cpp}) @end table @item gmsh/model/mesh/getElementFaceNodes @@ -1454,6 +1570,8 @@ the data indexed by @code{task}. @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L61,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/neighbors.py#L17,neighbors.py}) @end table @item gmsh/model/mesh/getGhostElements @@ -1480,6 +1598,8 @@ entities of dimension 0 (points) are handled. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L117,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L94,t16.py}) @end table @item gmsh/model/mesh/setTransfiniteCurve @@ -1495,6 +1615,8 @@ Currently supported types are "Progression" (geometrical progression with power - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L151,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L141,x2.py}) @end table @item gmsh/model/mesh/setTransfiniteSurface @@ -1513,6 +1635,8 @@ its boundary. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L155,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L143,x2.py}) @end table @item gmsh/model/mesh/setTransfiniteVolume @@ -1527,6 +1651,8 @@ interpolation explicitly. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L159,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L146,x2.py}) @end table @item gmsh/model/mesh/setRecombine @@ -1541,6 +1667,8 @@ recombine triangles into quadrangles) are supported. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L44,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L42,t11.py}) @end table @item gmsh/model/mesh/setSmoothing @@ -1554,6 +1682,8 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L157,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L145,x2.py}) @end table @item gmsh/model/mesh/setReverse @@ -1583,6 +1713,8 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L209,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L192,t5.py}) @end table @item gmsh/model/mesh/setSizeFromBoundary @@ -1611,6 +1743,8 @@ discrete entity, which is automatically reparametrized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t12.cpp#L83,t12.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t12.py#L79,t12.py}) @end table @item gmsh/model/mesh/setOutwardOrientation @@ -1641,6 +1775,8 @@ The embedded entities should not be part of the boundary of the entity - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t15.cpp#L51,t15.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t15.py#L47,t15.py}) @end table @item gmsh/model/mesh/removeEmbedded @@ -1711,6 +1847,8 @@ and @code{dim} == 2. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L39,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L36,t18.py}) @end table @item gmsh/model/mesh/getPeriodicNodes @@ -1726,6 +1864,8 @@ corresponding master node tags @code{nodeTagsMaster}, and the affine transform @code{tagMaster}, @code{nodeTags}, @code{nodeTagsMaster}, @code{affineTransform} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L19,periodic.py}) @end table @item gmsh/model/mesh/removeDuplicateNodes @@ -1738,6 +1878,8 @@ Remove duplicate nodes in the mesh of the current model. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L15,glue_and_remesh_stl.py}) @end table @item gmsh/model/mesh/splitQuadrangles @@ -1769,6 +1911,8 @@ less than Pi, also force curves to be split according to @code{curveAngle}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L46,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L38,t13.py}) @end table @item gmsh/model/mesh/createGeometry @@ -1783,6 +1927,8 @@ assuming that each can be parametrized with a single map. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L53,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L45,t13.py}) @end table @item gmsh/model/mesh/createTopology @@ -1800,6 +1946,8 @@ in CAD kernel. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L27,glue_and_remesh_stl.py}) @end table @item gmsh/model/mesh/computeHomology @@ -1819,6 +1967,8 @@ as physical groups in the mesh. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L111,t14.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L107,t14.py}) @end table @item gmsh/model/mesh/computeCohomology @@ -1838,6 +1988,8 @@ stored as physical groups in the mesh. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L123,t14.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L119,t14.py}) @end table @item gmsh/model/mesh/computeCrossField @@ -1871,6 +2023,8 @@ the field tag. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L47,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L38,t7.py}) @end table @item gmsh/model/mesh/field/remove @@ -1896,6 +2050,8 @@ Set the numerical option @code{option} to value @code{value} for field - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L47,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L45,t10.py}) @end table @item gmsh/model/mesh/field/setString @@ -1908,6 +2064,8 @@ Set the string option @code{option} to value @code{value} for field @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L73,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L70,t10.py}) @end table @item gmsh/model/mesh/field/setNumbers @@ -1921,6 +2079,8 @@ Set the numerical list option @code{option} to value @code{value} for field - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L47,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L45,t10.py}) @end table @item gmsh/model/mesh/field/setAsBackgroundMesh @@ -1933,6 +2093,8 @@ Set the field @code{tag} as the background mesh size field. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L50,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L41,t7.py}) @end table @item gmsh/model/mesh/field/setAsBoundaryLayer @@ -1969,6 +2131,8 @@ the geo module.) - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L32,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L30,t1.py}) @end table @item gmsh/model/geo/addLine @@ -1983,6 +2147,8 @@ new tag is selected automatically. Return the tag of the line. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L71,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L68,t1.py}) @end table @item gmsh/model/geo/addCircleArc @@ -1999,6 +2165,8 @@ the plane of the circle arc. Return the tag of the circle arc. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L26,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L109,t5.py}) @end table @item gmsh/model/geo/addEllipseArc @@ -2031,6 +2199,8 @@ same. Return the tag of the spline curve. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t12.cpp#L67,t12.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t12.py#L63,t12.py}) @end table @item gmsh/model/geo/addBSpline @@ -2107,6 +2277,8 @@ curve loop. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L84,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L80,t1.py}) @end table @item gmsh/model/geo/addPlaneSurface @@ -2122,6 +2294,8 @@ selected automatically. Return the tag of the surface. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L89,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L85,t1.py}) @end table @item gmsh/model/geo/addSurfaceFilling @@ -2137,6 +2311,8 @@ tag is selected automatically. Return the tag of the surface. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L49,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L132,t5.py}) @end table @item gmsh/model/geo/addSurfaceLoop @@ -2151,6 +2327,8 @@ automatically. Return the tag of the shell. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L114,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L110,t2.py}) @end table @item gmsh/model/geo/addVolume @@ -2166,6 +2344,8 @@ selected automatically. Return the tag of the volume. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L115,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L111,t2.py}) @end table @item gmsh/model/geo/extrude @@ -2184,6 +2364,8 @@ extruded along their normal. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L125,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L120,t2.py}) @end table @item gmsh/model/geo/revolve @@ -2203,6 +2385,8 @@ normalized to 1. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L52,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L49,t3.py}) @end table @item gmsh/model/geo/twist @@ -2223,6 +2407,8 @@ normalized to 1. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L62,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L59,t3.py}) @end table @item gmsh/model/geo/translate @@ -2236,6 +2422,8 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L49,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L47,t2.py}) @end table @item gmsh/model/geo/rotate @@ -2250,6 +2438,8 @@ direction (@code{ax}, @code{ay}, @code{az}). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L53,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L51,t2.py}) @end table @item gmsh/model/geo/dilate @@ -2304,6 +2494,8 @@ Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L62,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L59,t2.py}) @end table @item gmsh/model/geo/remove @@ -2317,6 +2509,8 @@ entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L32,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L31,t6.py}) @end table @item gmsh/model/geo/removeAllDuplicates @@ -2357,6 +2551,8 @@ processing, the number of synchronization points should normally be minimized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L115,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L110,t1.py}) @end table @end ftable @@ -2376,6 +2572,8 @@ entities of dimension 0 (points) are handled. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L129,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L124,t2.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteCurve @@ -2391,6 +2589,8 @@ Currently supported types are "Progression" (geometrical progression with power - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L48,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L47,t6.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteSurface @@ -2409,6 +2609,8 @@ its boundary. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L67,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L66,t6.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteVolume @@ -2437,6 +2639,8 @@ recombine triangles into quadrangles) are supported. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L71,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L70,t6.py}) @end table @item gmsh/model/geo/mesh/setSmoothing @@ -2517,6 +2721,8 @@ the occ module.) - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L67,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L59,t19.py}) @end table @item gmsh/model/occ/addLine @@ -2531,6 +2737,8 @@ new tag is selected automatically. Return the tag of the line. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L16,crack.py}) @end table @item gmsh/model/occ/addCircleArc @@ -2561,6 +2769,8 @@ arc between the two angles. Return the tag of the circle. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L25,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L23,t19.py}) @end table @item gmsh/model/occ/addEllipseArc @@ -2611,6 +2821,8 @@ same. Return the tag of the spline curve. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L71,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L62,t19.py}) @end table @item gmsh/model/occ/addBSpline @@ -2658,6 +2870,8 @@ wire. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L74,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L65,t19.py}) @end table @item gmsh/model/occ/addCurveLoop @@ -2675,6 +2889,8 @@ tag of the curve loop. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L26,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L24,t19.py}) @end table @item gmsh/model/occ/addRectangle @@ -2691,6 +2907,8 @@ tag of the rectangle. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L162,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L157,t1.py}) @end table @item gmsh/model/occ/addDisk @@ -2706,6 +2924,8 @@ tag of the disk. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L77,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L68,t19.py}) @end table @item gmsh/model/occ/addPlaneSurface @@ -2736,6 +2956,8 @@ surface to pass through the given points. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L54,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L137,t5.py}) @end table @item gmsh/model/occ/addSurfaceLoop @@ -2784,6 +3006,8 @@ sphere. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L54,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L44,t16.py}) @end table @item gmsh/model/occ/addBox @@ -2799,6 +3023,8 @@ box. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L31,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L28,t16.py}) @end table @item gmsh/model/occ/addCylinder @@ -2816,6 +3042,8 @@ Return the tag of the cylinder. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L25,boolean.cpp}) @end table @item gmsh/model/occ/addCone @@ -2882,6 +3110,8 @@ ruled surfaces. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L32,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L29,t19.py}) @end table @item gmsh/model/occ/addThickSolid @@ -2947,6 +3177,8 @@ Add a pipe by extruding the entities @code{dimTags} along the wire @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L81,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L72,t19.py}) @end table @item gmsh/model/occ/fillet @@ -2964,6 +3196,8 @@ Return the filleted entities in @code{outDimTags}. Remove the original volume if @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L55,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L47,t19.py}) @end table @item gmsh/model/occ/chamfer @@ -2999,6 +3233,8 @@ is set. Remove the tool if @code{removeTool} is set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L28,boolean.cpp}) @end table @item gmsh/model/occ/intersect @@ -3016,6 +3252,8 @@ set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L24,boolean.cpp}) @end table @item gmsh/model/occ/cut @@ -3032,6 +3270,8 @@ is set. Remove the tool if @code{removeTool} is set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L42,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L32,t16.py}) @end table @item gmsh/model/occ/fragment @@ -3049,6 +3289,8 @@ set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L62,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L51,t16.py}) @end table @item gmsh/model/occ/translate @@ -3062,6 +3304,8 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L47,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L44,t19.py}) @end table @item gmsh/model/occ/rotate @@ -3076,6 +3320,8 @@ direction (@code{ax}, @code{ay}, @code{az}). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L78,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L69,t19.py}) @end table @item gmsh/model/occ/dilate @@ -3146,6 +3392,8 @@ Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L46,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L43,t19.py}) @end table @item gmsh/model/occ/remove @@ -3159,6 +3407,8 @@ entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L85,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L76,t19.py}) @end table @item gmsh/model/occ/removeAllDuplicates @@ -3188,6 +3438,8 @@ manual. @code{outDimTags} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/heal.py#L11,heal.py}) @end table @item gmsh/model/occ/importShapes @@ -3204,6 +3456,8 @@ the file (currently "brep", "step" or "iges"). @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L29,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L25,t20.py}) @end table @item gmsh/model/occ/importShapesNativePointer @@ -3235,6 +3489,8 @@ entities are returned as a vector of (dim, tag) integer pairs. @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L87,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L66,t20.py}) @end table @item gmsh/model/occ/getEntitiesInBoundingBox @@ -3264,6 +3520,8 @@ tag @code{tag}. @code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L51,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L39,t20.py}) @end table @item gmsh/model/occ/getMass @@ -3277,6 +3535,8 @@ Get the mass of the OpenCASCADE entity of dimension @code{dim} and tag @code{mass} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_assembly.py#L18,step_assembly.py}) @end table @item gmsh/model/occ/getCenterOfMass @@ -3317,6 +3577,8 @@ processing, the number of synchronization points should normally be minimized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L166,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L161,t1.py}) @end table @end ftable @@ -3356,6 +3618,8 @@ associate a new tag. Return the view tag. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L110,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L108,t4.py}) @end table @item gmsh/view/remove @@ -3368,6 +3632,8 @@ Remove the view with tag @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L46,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L35,plugin.py}) @end table @item gmsh/view/getIndex @@ -3382,6 +3648,8 @@ access view options. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L80,t8.py}) @end table @item gmsh/view/getTags @@ -3394,6 +3662,8 @@ Get the tags of all views. @code{tags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L50,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L76,t8.py}) @end table @item gmsh/view/addModelData @@ -3417,6 +3687,8 @@ data. @code{partition} allows to specify data in several sub-sets. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L234,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L84,x3.py}) @end table @item gmsh/view/addHomogeneousModelData @@ -3434,6 +3706,8 @@ but only if data is associated to elements of the same type for - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L95,x3.py}) @end table @item gmsh/view/getModelData @@ -3449,6 +3723,8 @@ tags @code{tags}, as well as the @code{dataType} and the number of components @code{dataType}, @code{tags}, @code{data}, @code{time}, @code{numComponents} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.cpp#L17,perf.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.py#L12,perf.py}) @end table @item gmsh/view/addListData @@ -3464,6 +3740,8 @@ contains the data for the @code{numEle} elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L114,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L112,t4.py}) @end table @item gmsh/view/getListData @@ -3478,6 +3756,8 @@ data type and the @code{data} for each data type. @code{dataType}, @code{numElements}, @code{data} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L56,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L42,plugin.py}) @end table @item gmsh/view/addListDataString @@ -3494,6 +3774,8 @@ views) strings. @code{style} contains pairs of styling parameters, concatenated. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L114,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L112,t4.py}) @end table @item gmsh/view/getListDataStrings @@ -3524,6 +3806,8 @@ already exists), otherwise associate a new tag. Return the view tag. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view_combine.py#L28,view_combine.py}) @end table @item gmsh/view/copyOptions @@ -3552,6 +3836,8 @@ original views if @code{remove} is set. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view_combine.py#L24,view_combine.py}) @end table @item gmsh/view/probe @@ -3584,6 +3870,8 @@ file extension. Append to the file if @code{append} is set. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L235,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L121,x3.py}) @end table @end ftable @@ -3603,6 +3891,8 @@ Set the numerical option @code{option} to the value @code{value} for plugin - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L39,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L30,t9.py}) @end table @item gmsh/plugin/setString @@ -3616,6 +3906,8 @@ Set the string option @code{option} to the value @code{value} for plugin - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L55,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L46,t9.py}) @end table @item gmsh/plugin/run @@ -3628,6 +3920,8 @@ Run the plugin @code{name}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L41,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L32,t9.py}) @end table @end ftable @@ -3646,6 +3940,8 @@ Draw all the OpenGL scenes. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L151,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L175,t8.py}) @end table @end ftable @@ -3664,6 +3960,8 @@ Create the FLTK graphical user interface. Can only be called in the main thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L75,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L70,t8.py}) @end table @item gmsh/fltk/wait @@ -3679,6 +3977,8 @@ thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L81,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L76,custom_gui.py}) @end table @item gmsh/fltk/update @@ -3694,6 +3994,8 @@ update of the user interface from another thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L94,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L87,custom_gui.py}) @end table @item gmsh/fltk/awake @@ -3707,6 +4009,8 @@ perform an action (currently the only @code{action} allowed is "update"). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L40,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L61,custom_gui.py}) @end table @item gmsh/fltk/lock @@ -3719,6 +4023,8 @@ Block the current thread until it can safely modify the user interface. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L33,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L54,custom_gui.py}) @end table @item gmsh/fltk/unlock @@ -3731,6 +4037,8 @@ Release the lock that was set using lock. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L35,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L56,custom_gui.py}) @end table @item gmsh/fltk/run @@ -3745,6 +4053,8 @@ been initialized. Can only be called in the main thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L151,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L146,t1.py}) @end table @item gmsh/fltk/isAvailable @@ -3757,6 +4067,8 @@ Check if the user interface is available (e.g. to detect if it has been closed). - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L77,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L72,custom_gui.py}) @end table @item gmsh/fltk/selectEntities @@ -3812,6 +4124,8 @@ Set one or more parameters in the ONELAB database, encoded in @code{format}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L30,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L29,custom_gui.py}) @end table @item gmsh/onelab/get @@ -3825,6 +4139,8 @@ ONELAB database, encoded in @code{format}. @code{data} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L16,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L36,custom_gui.py}) @end table @item gmsh/onelab/setNumber @@ -3838,6 +4154,8 @@ the parameter if it does not exist; update the value if the parameter exists. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L44,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L62,custom_gui.py}) @end table @item gmsh/onelab/setString @@ -3851,6 +4169,8 @@ the parameter if it does not exist; update the value if the parameter exists. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L30,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L51,custom_gui.py}) @end table @item gmsh/onelab/getNumber @@ -3864,6 +4184,8 @@ Return an empty vector if the parameter does not exist. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L16,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L36,custom_gui.py}) @end table @item gmsh/onelab/getString @@ -3877,6 +4199,8 @@ Return an empty vector if the parameter does not exist. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L86,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L80,custom_gui.py}) @end table @item gmsh/onelab/clear @@ -3889,6 +4213,8 @@ Clear the ONELAB database, or remove a single parameter if @code{name} is given. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L46,onelab_test.py}) @end table @item gmsh/onelab/run @@ -3903,6 +4229,8 @@ might be linked to the processed input files. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.cpp#L17,onelab_data.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.py#L14,onelab_data.py}) @end table @end ftable @@ -3921,6 +4249,8 @@ Write a @code{message}. @code{level} can be "info", "warning" or "error". - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L41,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L55,custom_gui.py}) @end table @item gmsh/logger/start @@ -3933,6 +4263,8 @@ Start logging messages. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L27,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L25,t16.py}) @end table @item gmsh/logger/get @@ -3945,6 +4277,8 @@ Get logged messages. @code{log} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L139,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L113,t16.py}) @end table @item gmsh/logger/stop @@ -3957,6 +4291,8 @@ Stop logging messages. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L141,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L115,t16.py}) @end table @item gmsh/logger/getWallTime @@ -3969,6 +4305,8 @@ Return wall clock time. - @item Return: floating point value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L38,custom_gui.cpp}) @end table @item gmsh/logger/getCpuTime diff --git a/doc/texinfo/api.texi b/doc/texinfo/api.texi index bf858b3abe93129f9c1477316b75363e70ca9f58..d542d7524268a48cfad94c6f1401b1261657d400 100644 --- a/doc/texinfo/api.texi +++ b/doc/texinfo/api.texi @@ -36,6 +36,8 @@ configuration files (gmshrc and gmsh-options). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L16,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L14,t1.py}) @end table @item gmsh/finalize @@ -48,6 +50,8 @@ Finalize Gmsh. This must be called when you are done using the Gmsh API. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L175,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L170,t1.py}) @end table @item gmsh/open @@ -62,6 +66,8 @@ model data will create a new model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L31,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L29,x1.py}) @end table @item gmsh/merge @@ -76,6 +82,8 @@ file with model data will add the data to the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L38,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L35,t7.py}) @end table @item gmsh/write @@ -88,6 +96,8 @@ Write a file. The export format is determined by the file extension. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L126,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L121,t1.py}) @end table @item gmsh/clear @@ -120,6 +130,8 @@ are listed in the Gmsh reference manual. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L20,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L18,t1.py}) @end table @item gmsh/option/getNumber @@ -134,6 +146,8 @@ are listed in the Gmsh reference manual. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L118,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L149,t8.py}) @end table @item gmsh/option/setString @@ -148,6 +162,8 @@ are listed in the Gmsh reference manual. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L143,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L138,t1.py}) @end table @item gmsh/option/getString @@ -162,6 +178,8 @@ are listed in the Gmsh reference manual. @code{value} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L33,test.py}) @end table @item gmsh/option/setColor @@ -178,6 +196,8 @@ reference manual, with the "Color." middle string removed. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L83,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L80,t3.py}) @end table @item gmsh/option/getColor @@ -193,6 +213,8 @@ the "Color." middle string removed. @code{r}, @code{g}, @code{b}, @code{a} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L91,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L87,t3.py}) @end table @end ftable @@ -211,6 +233,8 @@ Add a new model, with name @code{name}, and set it as the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L22,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L20,t1.py}) @end table @item gmsh/model/remove @@ -223,6 +247,8 @@ Remove the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L91,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L80,t18.py}) @end table @item gmsh/model/list @@ -247,6 +273,8 @@ Get the name of the current model. @code{name} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L12,explore.py}) @end table @item gmsh/model/setCurrent @@ -260,6 +288,8 @@ the same name, select the one that was added first. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L123,x3.py}) @end table @item gmsh/model/getEntities @@ -274,6 +304,8 @@ entities are returned as a vector of (dim, tag) integer pairs. @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L198,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L181,t5.py}) @end table @item gmsh/model/setEntityName @@ -298,6 +330,8 @@ Get the name of the entity of dimension @code{dim} and tag @code{tag}. @code{name} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_assembly.py#L13,step_assembly.py}) @end table @item gmsh/model/getPhysicalGroups @@ -312,6 +346,8 @@ only the entities of the specified dimension (e.g. physical points if @code{dim} @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L103,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L88,x1.py}) @end table @item gmsh/model/getEntitiesForPhysicalGroup @@ -338,6 +374,8 @@ dimension @code{dim} and tag @code{tag} belongs. @code{physicalTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L103,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L88,x1.py}) @end table @item gmsh/model/addPhysicalGroup @@ -352,6 +390,8 @@ tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L109,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L104,t1.py}) @end table @item gmsh/model/setPhysicalName @@ -364,6 +404,8 @@ Set the name of the physical group of dimension @code{dim} and tag @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L111,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L106,t1.py}) @end table @item gmsh/model/getPhysicalName @@ -393,6 +435,8 @@ recursively down to dimension 0 (i.e. to points) if @code{recursive} is true. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L169,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L164,t1.py}) @end table @item gmsh/model/getEntitiesInBoundingBox @@ -408,6 +452,8 @@ dimension (e.g. points if @code{dim} == 0). @code{tags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L125,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L101,t16.py}) @end table @item gmsh/model/getBoundingBox @@ -423,6 +469,8 @@ the whole model. @code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L112,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L101,t18.py}) @end table @item gmsh/model/getDimension @@ -452,6 +500,8 @@ overall model. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L84,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L76,x2.py}) @end table @item gmsh/model/removeEntities @@ -465,6 +515,8 @@ true, remove all the entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L91,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L80,t18.py}) @end table @item gmsh/model/removeEntityName @@ -514,6 +566,8 @@ Get the type of the entity of dimension @code{dim} and tag @code{tag}. @code{entityType} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L115,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L95,t21.py}) @end table @item gmsh/model/getParent @@ -528,6 +582,8 @@ tag @code{tag}, i.e. from which the entity is a part of, if any. @code{parentDim}, @code{parentTag} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L123,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L97,t21.py}) @end table @item gmsh/model/getPartitions @@ -541,6 +597,8 @@ belongs. @code{partitions} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L112,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L93,t21.py}) @end table @item gmsh/model/getValue @@ -559,6 +617,8 @@ coordinates in @code{points}, concatenated: [p1x, p1y, p1z, p2x, ...]. @code{points} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L91,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L87,t2.py}) @end table @item gmsh/model/getDerivative @@ -596,6 +656,8 @@ u, v parametric coordinates on the surface, concatenated: [p1u, p1v, p2u, ...]). @code{curvatures} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L28,normals.py}) @end table @item gmsh/model/getPrincipalCurvatures @@ -626,6 +688,8 @@ triplets of x, y, z components, concatenated: [n1x, n1y, n1z, n2x, ...]. @code{normals} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L26,normals.py}) @end table @item gmsh/model/getParametrization @@ -656,6 +720,8 @@ the visibility setting recursively if @code{recursive} is true. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L199,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L182,t5.py}) @end table @item gmsh/model/getVisibility @@ -684,6 +750,8 @@ should be integers between 0 and 255. Apply the color setting recursively if - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L159,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L157,t4.py}) @end table @item gmsh/model/getColor @@ -696,6 +764,8 @@ Get the color of the model entity of dimension @code{dim} and tag @code{tag}. @code{r}, @code{g}, @code{b}, @code{a} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_boundary_colors.py#L12,step_boundary_colors.py}) @end table @item gmsh/model/setCoordinates @@ -726,6 +796,8 @@ Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L123,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L118,t1.py}) @end table @item gmsh/model/mesh/partition @@ -738,6 +810,8 @@ Partition the mesh of the current model into @code{numPart} partitions. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L86,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L73,t21.py}) @end table @item gmsh/model/mesh/unpartition @@ -768,6 +842,8 @@ Laplace smoothing, "Relocate2D" and "Relocate3D" for node relocation). If - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/opt.py#L13,opt.py}) @end table @item gmsh/model/mesh/recombine @@ -780,6 +856,8 @@ Recombine the mesh of the current model. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L90,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L88,t11.py}) @end table @item gmsh/model/mesh/refine @@ -792,6 +870,8 @@ Refine the mesh of the current model by uniformly splitting the elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L92,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L90,t11.py}) @end table @item gmsh/model/mesh/setOrder @@ -804,6 +884,8 @@ Set the order of the elements in the mesh of the current model to @code{order}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L35,boolean.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L17,periodic.py}) @end table @item gmsh/model/mesh/getLastEntityError @@ -845,6 +927,8 @@ another entity with a non-empty mesh. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L30,flatten.py}) @end table @item gmsh/model/mesh/getNodes @@ -869,6 +953,8 @@ the entity if @code{dim} >= 0 in order to compute their parametric coordinates). @code{nodeTags}, @code{coord}, @code{parametricCoord} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L70,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L66,x1.py}) @end table @item gmsh/model/mesh/getNodesByElementType @@ -898,6 +984,8 @@ often preferable. @code{coord}, @code{parametricCoord} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L70,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L66,x1.py}) @end table @item gmsh/model/mesh/setNode @@ -961,6 +1049,8 @@ automatically assigned to the nodes. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L90,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L82,x2.py}) @end table @item gmsh/model/mesh/reclassifyNodes @@ -976,6 +1066,8 @@ after the elements have been set. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L105,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L96,x2.py}) @end table @item gmsh/model/mesh/relocateNodes @@ -1015,6 +1107,8 @@ that contains the node tags of all the elements of the given type, concatenated: @code{elementTypes}, @code{elementTags}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L75,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L69,x1.py}) @end table @item gmsh/model/mesh/getElement @@ -1029,6 +1123,8 @@ otherwise); for large meshes accessing elements in bulk is often preferable. @code{elementType}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L75,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L69,x1.py}) @end table @item gmsh/model/mesh/getElementByCoordinates @@ -1096,6 +1192,8 @@ mesh. @code{elementTypes} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L33,edges.cpp}) @end table @item gmsh/model/mesh/getElementType @@ -1111,6 +1209,8 @@ corresponding serendip element type (element without interior nodes). - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L33,edges.cpp}) @end table @item gmsh/model/mesh/getElementProperties @@ -1127,6 +1227,8 @@ of primary (first order) nodes (@code{numPrimaryNodes}). @code{elementName}, @code{dim}, @code{order}, @code{numNodes}, @code{nodeCoord}, @code{numPrimaryNodes} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L128,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L100,x1.py}) @end table @item gmsh/model/mesh/getElementsByType @@ -1147,6 +1249,8 @@ indexed by @code{task}. @code{elementTags}, @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L55,edges.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L19,adapt_mesh.py}) @end table @item gmsh/model/mesh/preallocateElementsByType @@ -1181,6 +1285,8 @@ e1nN, e2n1, ...]. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L96,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L88,x2.py}) @end table @item gmsh/model/mesh/addElementsByType @@ -1199,6 +1305,8 @@ are automatically assigned to the elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L96,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L88,x2.py}) @end table @item gmsh/model/mesh/getIntegrationPoints @@ -1216,6 +1324,8 @@ points in the reference element: [g1u, g1v, g1w, ..., gGu, gGv, gGw]. @code{integrationPoints}, @code{integrationWeights} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L84,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L31,adapt_mesh.py}) @end table @item gmsh/model/mesh/getJacobians @@ -1241,6 +1351,8 @@ and return the part of the data indexed by @code{task}. @code{jacobians}, @code{determinants}, @code{points} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L86,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L32,adapt_mesh.py}) @end table @item gmsh/model/mesh/preallocateJacobians @@ -1279,6 +1391,8 @@ orientations. @code{numComponents}, @code{basisFunctions}, @code{numOrientations} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L91,edges.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L33,adapt_mesh.py}) @end table @item gmsh/model/mesh/getBasisFunctionsOrientationForElements @@ -1434,6 +1548,8 @@ indexed by @code{task}. @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L61,edges.cpp}) @end table @item gmsh/model/mesh/getElementFaceNodes @@ -1454,6 +1570,8 @@ the data indexed by @code{task}. @code{nodeTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L61,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/neighbors.py#L17,neighbors.py}) @end table @item gmsh/model/mesh/getGhostElements @@ -1480,6 +1598,8 @@ entities of dimension 0 (points) are handled. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L117,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L94,t16.py}) @end table @item gmsh/model/mesh/setTransfiniteCurve @@ -1495,6 +1615,8 @@ Currently supported types are "Progression" (geometrical progression with power - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L151,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L141,x2.py}) @end table @item gmsh/model/mesh/setTransfiniteSurface @@ -1513,6 +1635,8 @@ its boundary. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L155,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L143,x2.py}) @end table @item gmsh/model/mesh/setTransfiniteVolume @@ -1527,6 +1651,8 @@ interpolation explicitly. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L159,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L146,x2.py}) @end table @item gmsh/model/mesh/setRecombine @@ -1541,6 +1667,8 @@ recombine triangles into quadrangles) are supported. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L44,t11.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L42,t11.py}) @end table @item gmsh/model/mesh/setSmoothing @@ -1554,6 +1682,8 @@ and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L157,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L145,x2.py}) @end table @item gmsh/model/mesh/setReverse @@ -1583,6 +1713,8 @@ Set the meshing algorithm on the model entity of dimension @code{dim} and tag - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L209,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L192,t5.py}) @end table @item gmsh/model/mesh/setSizeFromBoundary @@ -1611,6 +1743,8 @@ discrete entity, which is automatically reparametrized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t12.cpp#L83,t12.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t12.py#L79,t12.py}) @end table @item gmsh/model/mesh/setOutwardOrientation @@ -1641,6 +1775,8 @@ The embedded entities should not be part of the boundary of the entity - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t15.cpp#L51,t15.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t15.py#L47,t15.py}) @end table @item gmsh/model/mesh/removeEmbedded @@ -1711,6 +1847,8 @@ and @code{dim} == 2. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L39,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L36,t18.py}) @end table @item gmsh/model/mesh/getPeriodicNodes @@ -1726,6 +1864,8 @@ corresponding master node tags @code{nodeTagsMaster}, and the affine transform @code{tagMaster}, @code{nodeTags}, @code{nodeTagsMaster}, @code{affineTransform} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L19,periodic.py}) @end table @item gmsh/model/mesh/removeDuplicateNodes @@ -1738,6 +1878,8 @@ Remove duplicate nodes in the mesh of the current model. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L15,glue_and_remesh_stl.py}) @end table @item gmsh/model/mesh/splitQuadrangles @@ -1769,6 +1911,8 @@ less than Pi, also force curves to be split according to @code{curveAngle}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L46,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L38,t13.py}) @end table @item gmsh/model/mesh/createGeometry @@ -1783,6 +1927,8 @@ assuming that each can be parametrized with a single map. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L53,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L45,t13.py}) @end table @item gmsh/model/mesh/createTopology @@ -1800,6 +1946,8 @@ in CAD kernel. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L27,glue_and_remesh_stl.py}) @end table @item gmsh/model/mesh/computeHomology @@ -1819,6 +1967,8 @@ as physical groups in the mesh. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L111,t14.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L107,t14.py}) @end table @item gmsh/model/mesh/computeCohomology @@ -1838,6 +1988,8 @@ stored as physical groups in the mesh. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L123,t14.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L119,t14.py}) @end table @item gmsh/model/mesh/computeCrossField @@ -1871,6 +2023,8 @@ the field tag. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L47,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L38,t7.py}) @end table @item gmsh/model/mesh/field/remove @@ -1896,6 +2050,8 @@ Set the numerical option @code{option} to value @code{value} for field - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L47,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L45,t10.py}) @end table @item gmsh/model/mesh/field/setString @@ -1908,6 +2064,8 @@ Set the string option @code{option} to value @code{value} for field @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L73,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L70,t10.py}) @end table @item gmsh/model/mesh/field/setNumbers @@ -1921,6 +2079,8 @@ Set the numerical list option @code{option} to value @code{value} for field - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L47,t10.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L45,t10.py}) @end table @item gmsh/model/mesh/field/setAsBackgroundMesh @@ -1933,6 +2093,8 @@ Set the field @code{tag} as the background mesh size field. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L50,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L41,t7.py}) @end table @item gmsh/model/mesh/field/setAsBoundaryLayer @@ -1969,6 +2131,8 @@ the geo module.) - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L32,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L30,t1.py}) @end table @item gmsh/model/geo/addLine @@ -1983,6 +2147,8 @@ new tag is selected automatically. Return the tag of the line. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L71,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L68,t1.py}) @end table @item gmsh/model/geo/addCircleArc @@ -1999,6 +2165,8 @@ the plane of the circle arc. Return the tag of the circle arc. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L26,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L109,t5.py}) @end table @item gmsh/model/geo/addEllipseArc @@ -2031,6 +2199,8 @@ same. Return the tag of the spline curve. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t12.cpp#L67,t12.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t12.py#L63,t12.py}) @end table @item gmsh/model/geo/addBSpline @@ -2107,6 +2277,8 @@ curve loop. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L84,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L80,t1.py}) @end table @item gmsh/model/geo/addPlaneSurface @@ -2122,6 +2294,8 @@ selected automatically. Return the tag of the surface. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L89,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L85,t1.py}) @end table @item gmsh/model/geo/addSurfaceFilling @@ -2137,6 +2311,8 @@ tag is selected automatically. Return the tag of the surface. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L49,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L132,t5.py}) @end table @item gmsh/model/geo/addSurfaceLoop @@ -2151,6 +2327,8 @@ automatically. Return the tag of the shell. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L114,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L110,t2.py}) @end table @item gmsh/model/geo/addVolume @@ -2166,6 +2344,8 @@ selected automatically. Return the tag of the volume. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L115,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L111,t2.py}) @end table @item gmsh/model/geo/extrude @@ -2184,6 +2364,8 @@ extruded along their normal. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L125,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L120,t2.py}) @end table @item gmsh/model/geo/revolve @@ -2203,6 +2385,8 @@ normalized to 1. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L52,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L49,t3.py}) @end table @item gmsh/model/geo/twist @@ -2223,6 +2407,8 @@ normalized to 1. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L62,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L59,t3.py}) @end table @item gmsh/model/geo/translate @@ -2236,6 +2422,8 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L49,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L47,t2.py}) @end table @item gmsh/model/geo/rotate @@ -2250,6 +2438,8 @@ direction (@code{ax}, @code{ay}, @code{az}). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L53,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L51,t2.py}) @end table @item gmsh/model/geo/dilate @@ -2304,6 +2494,8 @@ Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L62,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L59,t2.py}) @end table @item gmsh/model/geo/remove @@ -2317,6 +2509,8 @@ entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L32,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L31,t6.py}) @end table @item gmsh/model/geo/removeAllDuplicates @@ -2357,6 +2551,8 @@ processing, the number of synchronization points should normally be minimized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L115,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L110,t1.py}) @end table @end ftable @@ -2376,6 +2572,8 @@ entities of dimension 0 (points) are handled. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L129,t2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L124,t2.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteCurve @@ -2391,6 +2589,8 @@ Currently supported types are "Progression" (geometrical progression with power - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L48,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L47,t6.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteSurface @@ -2409,6 +2609,8 @@ its boundary. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L67,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L66,t6.py}) @end table @item gmsh/model/geo/mesh/setTransfiniteVolume @@ -2437,6 +2639,8 @@ recombine triangles into quadrangles) are supported. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L71,t6.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L70,t6.py}) @end table @item gmsh/model/geo/mesh/setSmoothing @@ -2517,6 +2721,8 @@ the occ module.) - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L67,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L59,t19.py}) @end table @item gmsh/model/occ/addLine @@ -2531,6 +2737,8 @@ new tag is selected automatically. Return the tag of the line. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L16,crack.py}) @end table @item gmsh/model/occ/addCircleArc @@ -2561,6 +2769,8 @@ arc between the two angles. Return the tag of the circle. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L25,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L23,t19.py}) @end table @item gmsh/model/occ/addEllipseArc @@ -2611,6 +2821,8 @@ same. Return the tag of the spline curve. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L71,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L62,t19.py}) @end table @item gmsh/model/occ/addBSpline @@ -2658,6 +2870,8 @@ wire. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L74,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L65,t19.py}) @end table @item gmsh/model/occ/addCurveLoop @@ -2675,6 +2889,8 @@ tag of the curve loop. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L26,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L24,t19.py}) @end table @item gmsh/model/occ/addRectangle @@ -2691,6 +2907,8 @@ tag of the rectangle. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L162,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L157,t1.py}) @end table @item gmsh/model/occ/addDisk @@ -2706,6 +2924,8 @@ tag of the disk. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L77,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L68,t19.py}) @end table @item gmsh/model/occ/addPlaneSurface @@ -2736,6 +2956,8 @@ surface to pass through the given points. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L54,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L137,t5.py}) @end table @item gmsh/model/occ/addSurfaceLoop @@ -2784,6 +3006,8 @@ sphere. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L54,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L44,t16.py}) @end table @item gmsh/model/occ/addBox @@ -2799,6 +3023,8 @@ box. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L31,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L28,t16.py}) @end table @item gmsh/model/occ/addCylinder @@ -2816,6 +3042,8 @@ Return the tag of the cylinder. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L25,boolean.cpp}) @end table @item gmsh/model/occ/addCone @@ -2882,6 +3110,8 @@ ruled surfaces. @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L32,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L29,t19.py}) @end table @item gmsh/model/occ/addThickSolid @@ -2947,6 +3177,8 @@ Add a pipe by extruding the entities @code{dimTags} along the wire @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L81,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L72,t19.py}) @end table @item gmsh/model/occ/fillet @@ -2964,6 +3196,8 @@ Return the filleted entities in @code{outDimTags}. Remove the original volume if @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L55,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L47,t19.py}) @end table @item gmsh/model/occ/chamfer @@ -2999,6 +3233,8 @@ is set. Remove the tool if @code{removeTool} is set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L28,boolean.cpp}) @end table @item gmsh/model/occ/intersect @@ -3016,6 +3252,8 @@ set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L24,boolean.cpp}) @end table @item gmsh/model/occ/cut @@ -3032,6 +3270,8 @@ is set. Remove the tool if @code{removeTool} is set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L42,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L32,t16.py}) @end table @item gmsh/model/occ/fragment @@ -3049,6 +3289,8 @@ set. @code{outDimTags}, @code{outDimTagsMap} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L62,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L51,t16.py}) @end table @item gmsh/model/occ/translate @@ -3062,6 +3304,8 @@ Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L47,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L44,t19.py}) @end table @item gmsh/model/occ/rotate @@ -3076,6 +3320,8 @@ direction (@code{ax}, @code{ay}, @code{az}). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L78,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L69,t19.py}) @end table @item gmsh/model/occ/dilate @@ -3146,6 +3392,8 @@ Copy the entities @code{dimTags}; the new entities are returned in @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L46,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L43,t19.py}) @end table @item gmsh/model/occ/remove @@ -3159,6 +3407,8 @@ entities on their boundaries, down to dimension 0. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L85,t19.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L76,t19.py}) @end table @item gmsh/model/occ/removeAllDuplicates @@ -3188,6 +3438,8 @@ manual. @code{outDimTags} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/heal.py#L11,heal.py}) @end table @item gmsh/model/occ/importShapes @@ -3204,6 +3456,8 @@ the file (currently "brep", "step" or "iges"). @code{outDimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L29,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L25,t20.py}) @end table @item gmsh/model/occ/importShapesNativePointer @@ -3235,6 +3489,8 @@ entities are returned as a vector of (dim, tag) integer pairs. @code{dimTags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L87,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L66,t20.py}) @end table @item gmsh/model/occ/getEntitiesInBoundingBox @@ -3264,6 +3520,8 @@ tag @code{tag}. @code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L51,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L39,t20.py}) @end table @item gmsh/model/occ/getMass @@ -3277,6 +3535,8 @@ Get the mass of the OpenCASCADE entity of dimension @code{dim} and tag @code{mass} @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_assembly.py#L18,step_assembly.py}) @end table @item gmsh/model/occ/getCenterOfMass @@ -3317,6 +3577,8 @@ processing, the number of synchronization points should normally be minimized. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L166,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L161,t1.py}) @end table @end ftable @@ -3356,6 +3618,8 @@ associate a new tag. Return the view tag. - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L110,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L108,t4.py}) @end table @item gmsh/view/remove @@ -3368,6 +3632,8 @@ Remove the view with tag @code{tag}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L46,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L35,plugin.py}) @end table @item gmsh/view/getIndex @@ -3382,6 +3648,8 @@ access view options. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L80,t8.py}) @end table @item gmsh/view/getTags @@ -3394,6 +3662,8 @@ Get the tags of all views. @code{tags} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L50,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L76,t8.py}) @end table @item gmsh/view/addModelData @@ -3417,6 +3687,8 @@ data. @code{partition} allows to specify data in several sub-sets. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L234,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L84,x3.py}) @end table @item gmsh/view/addHomogeneousModelData @@ -3434,6 +3706,8 @@ but only if data is associated to elements of the same type for - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L95,x3.py}) @end table @item gmsh/view/getModelData @@ -3449,6 +3723,8 @@ tags @code{tags}, as well as the @code{dataType} and the number of components @code{dataType}, @code{tags}, @code{data}, @code{time}, @code{numComponents} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.cpp#L17,perf.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.py#L12,perf.py}) @end table @item gmsh/view/addListData @@ -3464,6 +3740,8 @@ contains the data for the @code{numEle} elements. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L114,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L112,t4.py}) @end table @item gmsh/view/getListData @@ -3478,6 +3756,8 @@ data type and the @code{data} for each data type. @code{dataType}, @code{numElements}, @code{data} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L56,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L42,plugin.py}) @end table @item gmsh/view/addListDataString @@ -3494,6 +3774,8 @@ views) strings. @code{style} contains pairs of styling parameters, concatenated. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L114,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L112,t4.py}) @end table @item gmsh/view/getListDataStrings @@ -3524,6 +3806,8 @@ already exists), otherwise associate a new tag. Return the view tag. - @item Return: integer value +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view_combine.py#L28,view_combine.py}) @end table @item gmsh/view/copyOptions @@ -3552,6 +3836,8 @@ original views if @code{remove} is set. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view_combine.py#L24,view_combine.py}) @end table @item gmsh/view/probe @@ -3584,6 +3870,8 @@ file extension. Append to the file if @code{append} is set. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L235,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L121,x3.py}) @end table @end ftable @@ -3603,6 +3891,8 @@ Set the numerical option @code{option} to the value @code{value} for plugin - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L39,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L30,t9.py}) @end table @item gmsh/plugin/setString @@ -3616,6 +3906,8 @@ Set the string option @code{option} to the value @code{value} for plugin - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L55,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L46,t9.py}) @end table @item gmsh/plugin/run @@ -3628,6 +3920,8 @@ Run the plugin @code{name}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L41,t9.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L32,t9.py}) @end table @end ftable @@ -3646,6 +3940,8 @@ Draw all the OpenGL scenes. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L151,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L175,t8.py}) @end table @end ftable @@ -3664,6 +3960,8 @@ Create the FLTK graphical user interface. Can only be called in the main thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L75,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L70,t8.py}) @end table @item gmsh/fltk/wait @@ -3679,6 +3977,8 @@ thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L81,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L76,custom_gui.py}) @end table @item gmsh/fltk/update @@ -3694,6 +3994,8 @@ update of the user interface from another thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L94,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L87,custom_gui.py}) @end table @item gmsh/fltk/awake @@ -3707,6 +4009,8 @@ perform an action (currently the only @code{action} allowed is "update"). - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L40,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L61,custom_gui.py}) @end table @item gmsh/fltk/lock @@ -3719,6 +4023,8 @@ Block the current thread until it can safely modify the user interface. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L33,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L54,custom_gui.py}) @end table @item gmsh/fltk/unlock @@ -3731,6 +4037,8 @@ Release the lock that was set using lock. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L35,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L56,custom_gui.py}) @end table @item gmsh/fltk/run @@ -3745,6 +4053,8 @@ been initialized. Can only be called in the main thread. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L151,t1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L146,t1.py}) @end table @item gmsh/fltk/isAvailable @@ -3757,6 +4067,8 @@ Check if the user interface is available (e.g. to detect if it has been closed). - @item Return: integer value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L77,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L72,custom_gui.py}) @end table @item gmsh/fltk/selectEntities @@ -3812,6 +4124,8 @@ Set one or more parameters in the ONELAB database, encoded in @code{format}. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L30,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L29,custom_gui.py}) @end table @item gmsh/onelab/get @@ -3825,6 +4139,8 @@ ONELAB database, encoded in @code{format}. @code{data} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L16,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L36,custom_gui.py}) @end table @item gmsh/onelab/setNumber @@ -3838,6 +4154,8 @@ the parameter if it does not exist; update the value if the parameter exists. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L44,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L62,custom_gui.py}) @end table @item gmsh/onelab/setString @@ -3851,6 +4169,8 @@ the parameter if it does not exist; update the value if the parameter exists. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L30,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L51,custom_gui.py}) @end table @item gmsh/onelab/getNumber @@ -3864,6 +4184,8 @@ Return an empty vector if the parameter does not exist. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L16,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L36,custom_gui.py}) @end table @item gmsh/onelab/getString @@ -3877,6 +4199,8 @@ Return an empty vector if the parameter does not exist. @code{value} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L86,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L80,custom_gui.py}) @end table @item gmsh/onelab/clear @@ -3889,6 +4213,8 @@ Clear the ONELAB database, or remove a single parameter if @code{name} is given. - @item Return: - +@item Examples: +Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L46,onelab_test.py}) @end table @item gmsh/onelab/run @@ -3903,6 +4229,8 @@ might be linked to the processed input files. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.cpp#L17,onelab_data.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.py#L14,onelab_data.py}) @end table @end ftable @@ -3921,6 +4249,8 @@ Write a @code{message}. @code{level} can be "info", "warning" or "error". - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L41,t7.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L55,custom_gui.py}) @end table @item gmsh/logger/start @@ -3933,6 +4263,8 @@ Start logging messages. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L27,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L25,t16.py}) @end table @item gmsh/logger/get @@ -3945,6 +4277,8 @@ Get logged messages. @code{log} @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L139,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L113,t16.py}) @end table @item gmsh/logger/stop @@ -3957,6 +4291,8 @@ Stop logging messages. - @item Return: - +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L141,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L115,t16.py}) @end table @item gmsh/logger/getWallTime @@ -3969,6 +4305,8 @@ Return wall clock time. - @item Return: floating point value +@item Examples: +C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L38,custom_gui.cpp}) @end table @item gmsh/logger/getCpuTime