From c3d81ecf936e7531a2d76102a4459bb48456f0cc Mon Sep 17 00:00:00 2001 From: Christophe Geuzaine <cgeuzaine@uliege.be> Date: Fri, 10 Apr 2020 18:59:59 +0200 Subject: [PATCH] create api.texi directly in doc/texinfo --- api/GenApi.py | 2 +- api/api.texi | 4333 ----------------------------------------- tutorial/c++/x2.cpp | 4 +- tutorial/python/x2.py | 4 +- 4 files changed, 5 insertions(+), 4338 deletions(-) delete mode 100644 api/api.texi diff --git a/api/GenApi.py b/api/GenApi.py index b3cd86168c..2a8bff36ea 100644 --- a/api/GenApi.py +++ b/api/GenApi.py @@ -1604,7 +1604,7 @@ class API: f.write("@end table\n\n") f.write("@end ftable\n\n") - with open("api.texi", "w") as f: + with open("../doc/texinfo/api.texi", "w") as f: f.write( "@c This file was generated by api/gen.py: do not edit manually!\n\n" ) diff --git a/api/api.texi b/api/api.texi deleted file mode 100644 index 0416e0cda1..0000000000 --- a/api/api.texi +++ /dev/null @@ -1,4333 +0,0 @@ -@c This file was generated by api/gen.py: do not edit manually! - -@menu -* Namespace gmsh:: -* Namespace gmsh/option:: -* Namespace gmsh/model:: -* Namespace gmsh/model/mesh:: -* Namespace gmsh/model/mesh/field:: -* Namespace gmsh/model/geo:: -* Namespace gmsh/model/geo/mesh:: -* Namespace gmsh/model/occ:: -* Namespace gmsh/model/occ/mesh:: -* Namespace gmsh/view:: -* Namespace gmsh/plugin:: -* Namespace gmsh/graphics:: -* Namespace gmsh/fltk:: -* Namespace gmsh/onelab:: -* Namespace gmsh/logger:: -@end menu - -@node Namespace gmsh, Namespace gmsh/option, , Gmsh API -@section Namespace @code{gmsh}: top-level functions - -@ftable @code -@item gmsh/initialize -Initialize Gmsh. This must be called before any call to the other functions in -the API. If @code{argc} and @code{argv} (or just @code{argv} in Python or Julia) -are provided, they will be handled in the same way as the command line arguments -in the Gmsh app. If @code{readConfigFiles} is set, read system Gmsh -configuration files (gmshrc and gmsh-options). - -@table @asis -@item Input: -@code{(argc = 0)}, @code{argv = []}, @code{readConfigFiles = True} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L16,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L14,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L14,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L16,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L77,t5.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L14,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L13,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L12,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L12,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L12,t5.py}, ...) -@end table - -@item gmsh/finalize -Finalize Gmsh. This must be called when you are done using the Gmsh API. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L175,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L167,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L105,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L172,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L231,t5.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L170,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L160,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L101,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L179,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L225,t5.py}, ...) -@end table - -@item gmsh/open -Open a file. Equivalent to the @code{File->Open} menu in the Gmsh app. Handling -of the file depends on its extension and/or its contents: opening a file with -model data will create a new model. - -@table @asis -@item Input: -@code{fileName} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L31,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L13,explore.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.cpp#L14,onelab_data.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/open.cpp#L13,open.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L29,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L10,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L14,flatten.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/heal.py#L6,heal.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.py#L11,onelab_data.py}, ...) -@end table - -@item gmsh/merge -Merge a file. Equivalent to the @code{File->Merge} menu in the Gmsh app. -Handling of the file depends on its extension and/or its contents. Merging a -file with model data will add the data to the current model. - -@table @asis -@item Input: -@code{fileName} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L38,t7.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L37,t8.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L29,t9.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L22,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t17.cpp#L33,t17.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L35,t7.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L35,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L26,t9.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L20,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t17.py#L32,t17.py}, ...) -@end table - -@item gmsh/write -Write a file. The export format is determined by the file extension. - -@table @asis -@item Input: -@code{fileName} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L126,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L142,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L77,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L167,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L227,t5.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L121,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L136,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L74,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L174,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L221,t5.py}, ...) -@end table - -@item gmsh/clear -Clear all loaded models and post-processing data, and add a new empty model. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L156,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L118,x1.py}) -@end table - -@end ftable - -@node Namespace gmsh/option, Namespace gmsh/model, Namespace gmsh, Gmsh API -@section Namespace @code{gmsh/option}: option handling functions - -@ftable @code -@item gmsh/option/setNumber -Set a numerical option to @code{value}. @code{name} is of the form -"category.option" or "category[num].option". Available categories and options -are listed in the Gmsh reference manual. - -@table @asis -@item Input: -@code{name}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L20,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L18,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L15,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L17,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L78,t5.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L18,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L17,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L13,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L13,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L13,t5.py}, ...) -@end table - -@item gmsh/option/getNumber -Get the @code{value} of a numerical option. @code{name} is of the form -"category.option" or "category[num].option". Available categories and options -are listed in the Gmsh reference manual. - -@table @asis -@item Input: -@code{name} -@item Output: -@code{value} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L117,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L151,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L6,test.py}) -@end table - -@item gmsh/option/setString -Set a string option to @code{value}. @code{name} is of the form -"category.option" or "category[num].option". Available categories and options -are listed in the Gmsh reference manual. - -@table @asis -@item Input: -@code{name}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L143,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L151,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L91,t8.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L38,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L138,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L159,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L88,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L29,t20.py}) -@end table - -@item gmsh/option/getString -Get the @code{value} of a string option. @code{name} is of the form -"category.option" or "category[num].option". Available categories and options -are listed in the Gmsh reference manual. - -@table @asis -@item Input: -@code{name} -@item Output: -@code{value} -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L30,test.py}) -@end table - -@item gmsh/option/setColor -Set a color option to the RGBA value (@code{r}, @code{g}, @code{b}, @code{a}), -where where @code{r}, @code{g}, @code{b} and @code{a} should be integers between -0 and 255. @code{name} is of the form "category.option" or -"category[num].option". Available categories and options are listed in the Gmsh -reference manual, with the "Color." middle string removed. - -@table @asis -@item Input: -@code{name}, @code{r}, @code{g}, @code{b}, @code{a = 255} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L84,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L61,t8.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L81,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L58,t8.py}) -@end table - -@item gmsh/option/getColor -Get the @code{r}, @code{g}, @code{b}, @code{a} value of a color option. -@code{name} is of the form "category.option" or "category[num].option". -Available categories and options are listed in the Gmsh reference manual, with -the "Color." middle string removed. - -@table @asis -@item Input: -@code{name} -@item Output: -@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#L92,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L88,t3.py}) -@end table - -@end ftable - -@node Namespace gmsh/model, Namespace gmsh/model/mesh, Namespace gmsh/option, Gmsh API -@section Namespace @code{gmsh/model}: model functions - -@ftable @code -@item gmsh/model/add -Add a new model, with name @code{name}, and set it as the current model. - -@table @asis -@item Input: -@code{name} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L22,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L20,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L17,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L19,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L16,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L20,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L19,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L15,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L15,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L15,t5.py}, ...) -@end table - -@item gmsh/model/remove -Remove the current model. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/list -List the names of all models. - -@table @asis -@item Input: -- -@item Output: -@code{names} -@item Return: -- -@end table - -@item gmsh/model/getCurrent -Get the name of the current model. - -@table @asis -@item Input: -- -@item Output: -@code{name} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L35,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L32,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L12,explore.py}) -@end table - -@item gmsh/model/setCurrent -Set the current model to the model with name @code{name}. If several models have -the same name, select the one that was added first. - -@table @asis -@item Input: -@code{name} -@item Output: -- -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L132,x3.py}) -@end table - -@item gmsh/model/getEntities -Get all the entities in the current model. If @code{dim} is >= 0, return only -the entities of the specified dimension (e.g. points if @code{dim} == 0). The -entities are returned as a vector of (dim, tag) integer pairs. - -@table @asis -@item Input: -@code{dim = -1} -@item Output: -@code{dimTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L200,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L55,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L114,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L31,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L81,t20.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L195,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L47,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L97,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L29,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L63,t20.py}, ...) -@end table - -@item gmsh/model/setEntityName -Set the name of the entity of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{name} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/getEntityName -Get the name of the entity of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{name} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L90,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L80,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/step_assembly.py#L13,step_assembly.py}) -@end table - -@item gmsh/model/getPhysicalGroups -Get all the physical groups in the current model. If @code{dim} is >= 0, return -only the entities of the specified dimension (e.g. physical points if @code{dim} -== 0). The entities are returned as a vector of (dim, tag) integer pairs. - -@table @asis -@item Input: -@code{dim = -1} -@item Output: -@code{dimTags} -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L83,poisson.py}) -@end table - -@item gmsh/model/getEntitiesForPhysicalGroup -Get the tags of the model entities making up the physical group of dimension -@code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{tags} -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L88,poisson.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L25,test.py}) -@end table - -@item gmsh/model/getPhysicalGroupsForEntity -Get the tags of the physical groups (if any) to which the model entity of -dimension @code{dim} and tag @code{tag} belongs. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{physicalTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L115,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L95,x1.py}) -@end table - -@item gmsh/model/addPhysicalGroup -Add a physical group of dimension @code{dim}, grouping the model entities with -tags @code{tags}. Return the tag of the physical group, equal to @code{tag} if -@code{tag} is positive, or a new tag if @code{tag} < 0. - -@table @asis -@item Input: -@code{dim}, @code{tags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L109,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L34,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L31,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L178,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L74,t14.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L104,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L33,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L29,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L177,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L70,t14.py}, ...) -@end table - -@item gmsh/model/setPhysicalName -Set the name of the physical group of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{name} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L111,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L36,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L33,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L75,t14.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L53,t21.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L106,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L35,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L31,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L71,t14.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L41,t21.py}, ...) -@end table - -@item gmsh/model/getPhysicalName -Get the name of the physical group of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{name} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L120,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L99,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L87,poisson.py}) -@end table - -@item gmsh/model/getBoundary -Get the boundary of the model entities @code{dimTags}. Return in -@code{outDimTags} the boundary of the individual entities (if @code{combined} is -false) or the boundary of the combined geometrical shape formed by all input -entities (if @code{combined} is true). Return tags multiplied by the sign of the -boundary entity if @code{oriented} is true. Apply the boundary operator -recursively down to dimension 0 (i.e. to points) if @code{recursive} is true. - -@table @asis -@item Input: -@code{dimTags}, @code{combined = True}, @code{oriented = True}, @code{recursive = False} -@item Output: -@code{outDimTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L169,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L85,t14.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L118,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L97,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L50,t19.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L164,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L82,t14.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L100,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L88,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L46,t19.py}, ...) -@end table - -@item gmsh/model/getEntitiesInBoundingBox -Get the model entities in the bounding box defined by the two points -(@code{xmin}, @code{ymin}, @code{zmin}) and (@code{xmax}, @code{ymax}, -@code{zmax}). If @code{dim} is >= 0, return only the entities of the specified -dimension (e.g. points if @code{dim} == 0). - -@table @asis -@item Input: -@code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax}, @code{dim = -1} -@item Output: -@code{tags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L123,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L86,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L96,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L105,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L80,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L77,t20.py}) -@end table - -@item gmsh/model/getBoundingBox -Get the bounding box (@code{xmin}, @code{ymin}, @code{zmin}), (@code{xmax}, -@code{ymax}, @code{zmax}) of the model entity of dimension @code{dim} and tag -@code{tag}. If @code{dim} and @code{tag} are negative, get the bounding box of -the whole model. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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#L113,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L46,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L103,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L36,t20.py}) -@end table - -@item gmsh/model/getDimension -Get the geometrical dimension of the current model. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L36,x1.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L33,x1.py}) -@end table - -@item gmsh/model/addDiscreteEntity -Add a discrete model entity (defined by a mesh) of dimension @code{dim} in the -current model. Return the tag of the new discrete entity, equal to @code{tag} if -@code{tag} is positive, or a new tag if @code{tag} < 0. @code{boundary} -specifies the tags of the entities on the boundary of the discrete entity, if -any. Specifying @code{boundary} allows Gmsh to construct the topology of the -overall model. - -@table @asis -@item Input: -@code{dim}, @code{tag = -1}, @code{boundary = []} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L77,x2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.cpp#L11,discrete.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L63,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L63,faces.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L11,plugin.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L74,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L81,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.py#L10,discrete.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/mesh_from_discrete_curve.py#L11,mesh_from_discrete_curve.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L9,plugin.py}, ...) -@end table - -@item gmsh/model/removeEntities -Remove the entities @code{dimTags} of the current model. If @code{recursive} is -true, remove all the entities on their boundaries, down to dimension 0. - -@table @asis -@item Input: -@code{dimTags}, @code{recursive = False} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L92,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L110,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L84,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L86,t20.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spherical_surf.py#L16,spherical_surf.py}) -@end table - -@item gmsh/model/removeEntityName -Remove the entity name @code{name} from the current model. - -@table @asis -@item Input: -@code{name} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/removePhysicalGroups -Remove the physical groups @code{dimTags} of the current model. If -@code{dimTags} is empty, remove all groups. - -@table @asis -@item Input: -@code{dimTags = []} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/removePhysicalName -Remove the physical name @code{name} from the current model. - -@table @asis -@item Input: -@code{name} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/getType -Get the type of the entity of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{entityType} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L115,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L88,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L36,explore.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L55,partition.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L96,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L79,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L18,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L44,partition.py}) -@end table - -@item gmsh/model/getParent -In a partitioned model, get the parent of the entity of dimension @code{dim} and -tag @code{tag}, i.e. from which the entity is a part of, if any. -@code{parentDim} and @code{parentTag} are set to -1 if the entity has no parent. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L135,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L47,explore.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L63,partition.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L98,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L108,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L32,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L46,partition.py}) -@end table - -@item gmsh/model/getPartitions -In a partitioned model, return the tags of the partition(s) to which the entity -belongs. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{partitions} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L112,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L129,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L41,explore.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L52,partition.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L93,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L105,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L29,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L41,partition.py}) -@end table - -@item gmsh/model/getValue -Evaluate the parametrization of the entity of dimension @code{dim} and tag -@code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for -@code{dim} equal to 0 (with empty @code{parametricCoord}), 1 (with -@code{parametricCoord} containing parametric coordinates on the curve) or 2 -(with @code{parametricCoord} containing pairs of u, v parametric coordinates on -the surface, concatenated: [p1u, p1v, p2u, ...]). Return triplets of x, y, z -coordinates in @code{points}, concatenated: [p1x, p1y, p1z, p2x, ...]. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{parametricCoord} -@item Output: -@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}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L36,terrain_stl.py}) -@end table - -@item gmsh/model/getDerivative -Evaluate the derivative of the parametrization of the entity of dimension -@code{dim} and tag @code{tag} at the parametric coordinates -@code{parametricCoord}. Only valid for @code{dim} equal to 1 (with -@code{parametricCoord} containing parametric coordinates on the curve) or 2 -(with @code{parametricCoord} containing pairs of u, v parametric coordinates on -the surface, concatenated: [p1u, p1v, p2u, ...]). For @code{dim} equal to 1 -return the x, y, z components of the derivative with respect to u [d1ux, d1uy, -d1uz, d2ux, ...]; for @code{dim} equal to 2 return the x, y, z components of the -derivate with respect to u and v: [d1ux, d1uy, d1uz, d1vx, d1vy, d1vz, d2ux, -...]. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{parametricCoord} -@item Output: -@code{derivatives} -@item Return: -- -@end table - -@item gmsh/model/getCurvature -Evaluate the (maximum) curvature of the entity of dimension @code{dim} and tag -@code{tag} at the parametric coordinates @code{parametricCoord}. Only valid for -@code{dim} equal to 1 (with @code{parametricCoord} containing parametric -coordinates on the curve) or 2 (with @code{parametricCoord} containing pairs of -u, v parametric coordinates on the surface, concatenated: [p1u, p1v, p2u, ...]). - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{parametricCoord} -@item Output: -@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 -Evaluate the principal curvatures of the surface with tag @code{tag} at the -parametric coordinates @code{parametricCoord}, as well as their respective -directions. @code{parametricCoord} are given by pair of u and v coordinates, -concatenated: [p1u, p1v, p2u, ...]. - -@table @asis -@item Input: -@code{tag}, @code{parametricCoord} -@item Output: -@code{curvatureMax}, @code{curvatureMin}, @code{directionMax}, @code{directionMin} -@item Return: -- -@end table - -@item gmsh/model/getNormal -Get the normal to the surface with tag @code{tag} at the parametric coordinates -@code{parametricCoord}. @code{parametricCoord} are given by pairs of u and v -coordinates, concatenated: [p1u, p1v, p2u, ...]. @code{normals} are returned as -triplets of x, y, z components, concatenated: [n1x, n1y, n1z, n2x, ...]. - -@table @asis -@item Input: -@code{tag}, @code{parametricCoord} -@item Output: -@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 -Get the parametric coordinates @code{parametricCoord} for the points -@code{points} on the entity of dimension @code{dim} and tag @code{tag}. -@code{points} are given as triplets of x, y, z coordinates, concatenated: [p1x, -p1y, p1z, p2x, ...]. @code{parametricCoord} returns the parametric coordinates t -on the curve (if @code{dim} = 1) or pairs of u and v coordinates concatenated on -the surface (if @code{dim} = 2), i.e. [p1t, p2t, ...] or [p1u, p1v, p2u, ...]. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{points} -@item Output: -@code{parametricCoord} -@item Return: -- -@end table - -@item gmsh/model/setVisibility -Set the visibility of the model entities @code{dimTags} to @code{value}. Apply -the visibility setting recursively if @code{recursive} is true. - -@table @asis -@item Input: -@code{dimTags}, @code{value}, @code{recursive = False} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L201,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L196,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L30,gui.py}) -@end table - -@item gmsh/model/getVisibility -Get the visibility of the model entity of dimension @code{dim} and tag -@code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{value} -@item Return: -- -@end table - -@item gmsh/model/setColor -Set the color of the model entities @code{dimTags} to the RGBA value (@code{r}, -@code{g}, @code{b}, @code{a}), where @code{r}, @code{g}, @code{b} and @code{a} -should be integers between 0 and 255. Apply the color setting recursively if -@code{recursive} is true. - -@table @asis -@item Input: -@code{dimTags}, @code{r}, @code{g}, @code{b}, @code{a = 255}, @code{recursive = False} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L158,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L167,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L32,gui.py}) -@end table - -@item gmsh/model/getColor -Get the color of the model entity of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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 -Set the @code{x}, @code{y}, @code{z} coordinates of a geometrical point. - -@table @asis -@item Input: -@code{tag}, @code{x}, @code{y}, @code{z} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L78,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L75,x2.py}) -@end table - -@end ftable - -@node Namespace gmsh/model/mesh, Namespace gmsh/model/mesh/field, Namespace gmsh/model, Gmsh API -@section Namespace @code{gmsh/model/mesh}: mesh functions - -@ftable @code -@item gmsh/model/mesh/generate -Generate a mesh of the current model, up to dimension @code{dim} (0, 1, 2 or 3). - -@table @asis -@item Input: -@code{dim = 3} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L123,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L141,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L76,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L165,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L226,t5.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L118,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L135,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L73,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L172,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L220,t5.py}, ...) -@end table - -@item gmsh/model/mesh/partition -Partition the mesh of the current model into @code{numPart} partitions. - -@table @asis -@item Input: -@code{numPart} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L87,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L36,boolean.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L30,partition.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L73,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L36,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L26,partition.py}) -@end table - -@item gmsh/model/mesh/unpartition -Unpartition the mesh of the current model. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/optimize -Optimize the mesh of the current model using @code{method} (empty for default -tetrahedral mesh optimizer, "Netgen" for Netgen optimizer, "HighOrder" for -direct high-order mesh optimizer, "HighOrderElastic" for high-order elastic -smoother, "HighOrderFastCurving" for fast curving algorithm, "Laplace2D" for -Laplace smoothing, "Relocate2D" and "Relocate3D" for node relocation). If -@code{force} is set apply the optimization also to discrete entities. If -@code{dimTags} is given, only apply the optimizer to the given entities. - -@table @asis -@item Input: -@code{method}, @code{force = False}, @code{niter = 1}, @code{dimTags = []} -@item Output: -- -@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 -Recombine the mesh of the current model. - -@table @asis -@item Input: -- -@item Output: -- -@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 -Refine the mesh of the current model by uniformly splitting the elements. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L92,t11.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L34,boolean.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t11.py#L90,t11.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L34,boolean.py}) -@end table - -@item gmsh/model/mesh/setOrder -Set the order of the elements in the mesh of the current model to @code{order}. - -@table @asis -@item Input: -@code{order} -@item Output: -- -@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/boolean.py#L35,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L18,periodic.py}) -@end table - -@item gmsh/model/mesh/getLastEntityError -Get the last entities (if any) where a meshing error occurred. Currently only -populated by the new 3D meshing algorithms. - -@table @asis -@item Input: -- -@item Output: -@code{dimTags} -@item Return: -- -@end table - -@item gmsh/model/mesh/getLastNodeError -Get the last nodes (if any) where a meshing error occurred. Currently only -populated by the new 3D meshing algorithms. - -@table @asis -@item Input: -- -@item Output: -@code{nodeTags} -@item Return: -- -@end table - -@item gmsh/model/mesh/clear -Clear the mesh, i.e. delete all the nodes and elements, for the entities -@code{dimTags}. if @code{dimTags} is empty, clear the whole mesh. Note that the -mesh of an entity can only be cleared if this entity is not on the boundary of -another entity with a non-empty mesh. - -@table @asis -@item Input: -@code{dimTags = []} -@item Output: -- -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L31,flatten.py}) -@end table - -@item gmsh/model/mesh/getNodes -Get the nodes classified on the entity of dimension @code{dim} and tag -@code{tag}. If @code{tag} < 0, get the nodes for all entities of dimension -@code{dim}. If @code{dim} and @code{tag} are negative, get all the nodes in the -mesh. @code{nodeTags} contains the node tags (their unique, strictly positive -identification numbers). @code{coord} is a vector of length 3 times the length -of @code{nodeTags} that contains the x, y, z coordinates of the nodes, -concatenated: [n1x, n1y, n1z, n2x, ...]. If @code{dim} >= 0 and -@code{returnParamtricCoord} is set, @code{parametricCoord} contains the -parametric coordinates ([u1, u2, ...] or [u1, v1, u2, ...]) of the nodes, if -available. The length of @code{parametricCoord} can be 0 or @code{dim} times the -length of @code{nodeTags}. If @code{includeBoundary} is set, also return the -nodes classified on the boundary of the entity (which will be reparametrized on -the entity if @code{dim} >= 0 in order to compute their parametric coordinates). - -@table @asis -@item Input: -@code{dim = -1}, @code{tag = -1}, @code{includeBoundary = False}, @code{returnParametricCoord = True} -@item Output: -@code{nodeTags}, @code{coord}, @code{parametricCoord} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L76,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L80,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L24,explore.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L70,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L15,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L20,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L26,flatten.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L23,normals.py}, ...) -@end table - -@item gmsh/model/mesh/getNodesByElementType -Get the nodes classified on the entity of tag @code{tag}, for all the elements -of type @code{elementType}. The other arguments are treated as in -@code{getNodes}. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1}, @code{returnParametricCoord = True} -@item Output: -@code{nodeTags}, @code{coord}, @code{parametricCoord} -@item Return: -- -@end table - -@item gmsh/model/mesh/getNode -Get the coordinates and the parametric coordinates (if any) of the node with tag -@code{tag}. This function relies on an internal cache (a vector in case of dense -node numbering, a map otherwise); for large meshes accessing nodes in bulk is -often preferable. - -@table @asis -@item Input: -@code{nodeTag} -@item Output: -@code{coord}, @code{parametricCoord} -@item Return: -- -@end table - -@item gmsh/model/mesh/setNode -Set the coordinates and the parametric coordinates (if any) of the node with tag -@code{tag}. This function relies on an internal cache (a vector in case of dense -node numbering, a map otherwise); for large meshes accessing nodes in bulk is -often preferable. - -@table @asis -@item Input: -@code{nodeTag}, @code{coord}, @code{parametricCoord} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/rebuildNodeCache -Rebuild the node cache. - -@table @asis -@item Input: -@code{onlyIfNecessary = True} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/getNodesForPhysicalGroup -Get the nodes from all the elements belonging to the physical group of dimension -@code{dim} and tag @code{tag}. @code{nodeTags} contains the node tags; -@code{coord} is a vector of length 3 times the length of @code{nodeTags} that -contains the x, y, z coordinates of the nodes, concatenated: [n1x, n1y, n1z, -n2x, ...]. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{nodeTags}, @code{coord} -@item Return: -- -@end table - -@item gmsh/model/mesh/addNodes -Add nodes classified on the model entity of dimension @code{dim} and tag -@code{tag}. @code{nodeTags} contains the node tags (their unique, strictly -positive identification numbers). @code{coord} is a vector of length 3 times the -length of @code{nodeTags} that contains the x, y, z coordinates of the nodes, -concatenated: [n1x, n1y, n1z, n2x, ...]. The optional @code{parametricCoord} -vector contains the parametric coordinates of the nodes, if any. The length of -@code{parametricCoord} can be 0 or @code{dim} times the length of -@code{nodeTags}. If the @code{nodeTags} vector is empty, new tags are -automatically assigned to the nodes. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{nodeTags}, @code{coord}, @code{parametricCoord = []} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L91,x2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.cpp#L14,discrete.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L12,plugin.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.cpp#L11,view.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L88,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L82,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.py#L13,discrete.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L37,flatten.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/mesh_from_discrete_curve.py#L16,mesh_from_discrete_curve.py}, ...) -@end table - -@item gmsh/model/mesh/reclassifyNodes -Reclassify all nodes on their associated model entity, based on the elements. -Can be used when importing nodes in bulk (e.g. by associating them all to a -single volume), to reclassify them correctly on model surfaces, curves, etc. -after the elements have been set. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L106,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L102,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L67,terrain.py}) -@end table - -@item gmsh/model/mesh/relocateNodes -Relocate the nodes classified on the entity of dimension @code{dim} and tag -@code{tag} using their parametric coordinates. If @code{tag} < 0, relocate the -nodes for all entities of dimension @code{dim}. If @code{dim} and @code{tag} are -negative, relocate all the nodes in the mesh. - -@table @asis -@item Input: -@code{dim = -1}, @code{tag = -1} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/getElements -Get the elements classified on the entity of dimension @code{dim} and tag -@code{tag}. If @code{tag} < 0, get the elements for all entities of dimension -@code{dim}. If @code{dim} and @code{tag} are negative, get all the elements in -the mesh. @code{elementTypes} contains the MSH types of the elements (e.g. -@code{2} for 3-node triangles: see @code{getElementProperties} to obtain the -properties for a given element type). @code{elementTags} is a vector of the same -length as @code{elementTypes}; each entry is a vector containing the tags -(unique, strictly positive identifiers) of the elements of the corresponding -type. @code{nodeTags} is also a vector of the same length as -@code{elementTypes}; each entry is a vector of length equal to the number of -elements of the given type times the number N of nodes for this type of element, -that contains the node tags of all the elements of the given type, concatenated: -[e1n1, e1n2, ..., e1nN, e2n1, ...]. - -@table @asis -@item Input: -@code{dim = -1}, @code{tag = -1} -@item Output: -@code{elementTypes}, @code{elementTags}, @code{nodeTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x1.cpp#L81,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L83,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L29,explore.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L73,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L22,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L28,flatten.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L42,test.py}) -@end table - -@item gmsh/model/mesh/getElement -Get the type and node tags of the element with tag @code{tag}. This function -relies on an internal cache (a vector in case of dense element numbering, a map -otherwise); for large meshes accessing elements in bulk is often preferable. - -@table @asis -@item Input: -@code{elementTag} -@item Output: -@code{elementType}, @code{nodeTags} -@item Return: -- -@end table - -@item gmsh/model/mesh/getElementByCoordinates -Search the mesh for an element located at coordinates (@code{x}, @code{y}, -@code{z}). This function performs a search in a spatial octree. If an element is -found, return its tag, type and node tags, as well as the local coordinates -(@code{u}, @code{v}, @code{w}) within the element corresponding to search -location. If @code{dim} is >= 0, only search for elements of the given -dimension. If @code{strict} is not set, use a tolerance to find elements near -the search location. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dim = -1}, @code{strict = False} -@item Output: -@code{elementTag}, @code{elementType}, @code{nodeTags}, @code{u}, @code{v}, @code{w} -@item Return: -- -@end table - -@item gmsh/model/mesh/getElementsByCoordinates -Search the mesh for element(s) located at coordinates (@code{x}, @code{y}, -@code{z}). This function performs a search in a spatial octree. Return the tags -of all found elements in @code{elementTags}. Additional information about the -elements can be accessed through @code{getElement} and -@code{getLocalCoordinatesInElement}. If @code{dim} is >= 0, only search for -elements of the given dimension. If @code{strict} is not set, use a tolerance to -find elements near the search location. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dim = -1}, @code{strict = False} -@item Output: -@code{elementTags} -@item Return: -- -@end table - -@item gmsh/model/mesh/getLocalCoordinatesInElement -Return the local coordinates (@code{u}, @code{v}, @code{w}) within the element -@code{elementTag} corresponding to the model coordinates (@code{x}, @code{y}, -@code{z}). This function relies on an internal cache (a vector in case of dense -element numbering, a map otherwise); for large meshes accessing elements in bulk -is often preferable. - -@table @asis -@item Input: -@code{elementTag}, @code{x}, @code{y}, @code{z} -@item Output: -@code{u}, @code{v}, @code{w} -@item Return: -- -@end table - -@item gmsh/model/mesh/getElementTypes -Get the types of elements in the entity of dimension @code{dim} and tag -@code{tag}. If @code{tag} < 0, get the types for all entities of dimension -@code{dim}. If @code{dim} and @code{tag} are negative, get all the types in the -mesh. - -@table @asis -@item Input: -@code{dim = -1}, @code{tag = -1} -@item Output: -@code{elementTypes} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L33,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L33,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L92,poisson.py}) -@end table - -@item gmsh/model/mesh/getElementType -Return an element type given its family name @code{familyName} ("point", "line", -"triangle", "quadrangle", "tetrahedron", "pyramid", "prism", "hexahedron") and -polynomial order @code{order}. If @code{serendip} is true, return the -corresponding serendip element type (element without interior nodes). - -@table @asis -@item Input: -@code{familyName}, @code{order}, @code{serendip = False} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L66,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L66,faces.cpp}) -@end table - -@item gmsh/model/mesh/getElementProperties -Get the properties of an element of type @code{elementType}: its name -(@code{elementName}), dimension (@code{dim}), order (@code{order}), number of -nodes (@code{numNodes}), coordinates of the nodes in the reference element -(@code{nodeCoord} vector, of length @code{dim} times @code{numNodes}) and number -of primary (first order) nodes (@code{numPrimaryNodes}). - -@table @asis -@item Input: -@code{elementType} -@item Output: -@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#L145,x1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L42,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.cpp#L55,explore.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L42,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x1.py#L112,x1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/explore.py#L34,explore.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L111,poisson.py}) -@end table - -@item gmsh/model/mesh/getElementsByType -Get the elements of type @code{elementType} classified on the entity of tag -@code{tag}. If @code{tag} < 0, get the elements for all entities. -@code{elementTags} is a vector containing the tags (unique, strictly positive -identifiers) of the elements of the corresponding type. @code{nodeTags} is a -vector of length equal to the number of elements of the given type times the -number N of nodes for this type of element, that contains the node tags of all -the elements of the given type, concatenated: [e1n1, e1n2, ..., e1nN, e2n1, -...]. If @code{numTasks} > 1, only compute and return the part of the data -indexed by @code{task}. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@code{elementTags}, @code{nodeTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L54,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L54,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L18,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/neighbors.py#L16,neighbors.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L95,poisson.py}) -@end table - -@item gmsh/model/mesh/preallocateElementsByType -Preallocate data before calling @code{getElementsByType} with @code{numTasks} > -1. For C and C++ only. - -@table @asis -@item Input: -@code{elementType}, @code{elementTag}, @code{nodeTag}, @code{tag = -1} -@item Output: -@code{elementTags}, @code{nodeTags} -@item Return: -- -@end table - -@item gmsh/model/mesh/addElements -Add elements classified on the entity of dimension @code{dim} and tag -@code{tag}. @code{types} contains the MSH types of the elements (e.g. @code{2} -for 3-node triangles: see the Gmsh reference manual). @code{elementTags} is a -vector of the same length as @code{types}; each entry is a vector containing the -tags (unique, strictly positive identifiers) of the elements of the -corresponding type. @code{nodeTags} is also a vector of the same length as -@code{types}; each entry is a vector of length equal to the number of elements -of the given type times the number N of nodes per element, that contains the -node tags of all the elements of the given type, concatenated: [e1n1, e1n2, ..., -e1nN, e2n1, ...]. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{elementTypes}, @code{elementTags}, @code{nodeTags} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.cpp#L21,discrete.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L14,plugin.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.cpp#L13,view.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/discrete.py#L33,discrete.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/flatten.py#L38,flatten.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/mesh_from_discrete_curve.py#L22,mesh_from_discrete_curve.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L12,plugin.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/test.py#L48,test.py}, ...) -@end table - -@item gmsh/model/mesh/addElementsByType -Add elements of type @code{elementType} classified on the entity of tag -@code{tag}. @code{elementTags} contains the tags (unique, strictly positive -identifiers) of the elements of the corresponding type. @code{nodeTags} is a -vector of length equal to the number of elements times the number N of nodes per -element, that contains the node tags of all the elements, concatenated: [e1n1, -e1n2, ..., e1nN, e2n1, ...]. If the @code{elementTag} vector is empty, new tags -are automatically assigned to the elements. - -@table @asis -@item Input: -@code{tag}, @code{elementType}, @code{elementTags}, @code{nodeTags} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L97,x2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L67,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L67,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L94,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L87,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L59,terrain.py}) -@end table - -@item gmsh/model/mesh/getIntegrationPoints -Get the numerical quadrature information for the given element type -@code{elementType} and integration rule @code{integrationType} (e.g. "Gauss4" -for a Gauss quadrature suited for integrating 4th order polynomials). -@code{integrationPoints} contains the u, v, w coordinates of the G integration -points in the reference element: [g1u, g1v, g1w, ..., gGu, gGv, gGw]. -@code{integrationWeigths} contains the associated weights: [g1q, ..., gGq]. - -@table @asis -@item Input: -@code{elementType}, @code{integrationType} -@item Output: -@code{integrationPoints}, @code{integrationWeights} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L90,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L87,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L87,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L30,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L112,poisson.py}) -@end table - -@item gmsh/model/mesh/getJacobians -Get the Jacobians of all the elements of type @code{elementType} classified on -the entity of tag @code{tag}, at the G integration points -@code{integrationPoints} given as concatenated triplets of coordinates in the -reference element [g1u, g1v, g1w, ..., gGu, gGv, gGw]. Data is returned by -element, with elements in the same order as in @code{getElements} and -@code{getElementsByType}. @code{jacobians} contains for each element the 9 -entries of the 3x3 Jacobian matrix at each integration point. The matrix is -returned by column: [e1g1Jxu, e1g1Jyu, e1g1Jzu, e1g1Jxv, ..., e1g1Jzw, e1g2Jxu, -..., e1gGJzw, e2g1Jxu, ...], with Jxu=dx/du, Jyu=dy/du, etc. @code{determinants} -contains for each element the determinant of the Jacobian matrix at each -integration point: [e1g1, e1g2, ... e1gG, e2g1, ...]. @code{points} contains for -each element the x, y, z coordinates of the integration points. If @code{tag} < -0, get the Jacobian data for all entities. If @code{numTasks} > 1, only compute -and return the part of the data indexed by @code{task}. - -@table @asis -@item Input: -@code{elementType}, @code{integrationPoints}, @code{tag = -1}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@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#L93,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L99,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L99,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L31,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L131,poisson.py}) -@end table - -@item gmsh/model/mesh/preallocateJacobians -Preallocate data before calling @code{getJacobians} with @code{numTasks} > 1. -For C and C++ only. - -@table @asis -@item Input: -@code{elementType}, @code{numIntegrationPoints}, @code{jacobian}, @code{determinant}, @code{point}, @code{tag = -1} -@item Output: -@code{jacobians}, @code{determinants}, @code{points} -@item Return: -- -@end table - -@item gmsh/model/mesh/getBasisFunctions -Get the basis functions of the element of type @code{elementType} at the -integration points @code{integrationPoints} (given as concatenated triplets of -coordinates in the reference element [g1u, g1v, g1w, ..., gGu, gGv, gGw]), for -the function space @code{functionSpaceType} (e.g. "Lagrange" or "GradLagrange" -for Lagrange basis functions or their gradient, in the u, v, w coordinates of -the reference element; or "H1Legendre3" or "GradH1Legendre3" for 3rd order -hierarchical H1 Legendre functions). @code{numComponents} returns the number C -of components of a basis function. @code{basisFunctions} returns the value of -the N basis functions at the integration points, i.e. [g1f1, g1f2, ..., g1fN, -g2f1, ...] when C == 1 or [g1f1u, g1f1v, g1f1w, g1f2u, ..., g1fNw, g2f1u, ...] -when C == 3. For basis functions that depend on the orientation of the elements, -all values for the first orientation are returned first, followed by values for -the secondd, etc. @code{numOrientations} returns the overall number of -orientations. - -@table @asis -@item Input: -@code{elementType}, @code{integrationPoints}, @code{functionSpaceType} -@item Output: -@code{numComponents}, @code{basisFunctions}, @code{numOrientations} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L90,edges.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L90,faces.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L32,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L114,poisson.py}) -@end table - -@item gmsh/model/mesh/getBasisFunctionsOrientationForElements -Get the orientation index of the elements of type @code{elementType} in the -entity of tag @code{tag}. The arguments have the same meaning as in -@code{getBasisFunctions}. @code{basisFunctionsOrientation} is a vector giving -for each element the orientation index in the values returned by -@code{getBasisFunctions}. For Lagrange basis functions the call is superfluous -as it will return a vector of zeros. - -@table @asis -@item Input: -@code{elementType}, @code{functionSpaceType}, @code{tag = -1}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@code{basisFunctionsOrientation} -@item Return: -- -@end table - -@item gmsh/model/mesh/preallocateBasisFunctionsOrientationForElements -Preallocate data before calling @code{getBasisFunctionsOrientationForElements} -with @code{numTasks} > 1. For C and C++ only. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1} -@item Output: -@code{basisFunctionsOrientation} -@item Return: -- -@end table - -@item gmsh/model/mesh/getEdgeNumber -Get the global edge identifier @code{edgeNum} for an input list of node pairs, -concatenated in the vector @code{edgeNodes}. Warning: this is an experimental -feature and will probably change in a future release. - -@table @asis -@item Input: -@code{edgeNodes} -@item Output: -@code{edgeNum} -@item Return: -- -@end table - -@item gmsh/model/mesh/getLocalMultipliersForHcurl0 -Get the local multipliers (to guarantee H(curl)-conformity) of the order 0 -H(curl) basis functions. Warning: this is an experimental feature and will -probably change in a future release. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1} -@item Output: -@code{localMultipliers} -@item Return: -- -@end table - -@item gmsh/model/mesh/getKeysForElements -Generate the @code{keys} for the elements of type @code{elementType} in the -entity of tag @code{tag}, for the @code{functionSpaceType} function space. Each -key uniquely identifies a basis function in the function space. If -@code{returnCoord} is set, the @code{coord} vector contains the x, y, z -coordinates locating basis functions for sorting purposes. Warning: this is an -experimental feature and will probably change in a future release. - -@table @asis -@item Input: -@code{elementType}, @code{functionSpaceType}, @code{tag = -1}, @code{returnCoord = True} -@item Output: -@code{keys}, @code{coord} -@item Return: -- -@end table - -@item gmsh/model/mesh/getNumberOfKeysForElements -Get the number of keys by elements of type @code{elementType} for function space -named @code{functionSpaceType}. - -@table @asis -@item Input: -@code{elementType}, @code{functionSpaceType} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/mesh/getInformationForElements -Get information about the @code{keys}. @code{infoKeys} returns information about -the functions associated with the @code{keys}. @code{infoKeys[0].first} -describes the type of function (0 for vertex function, 1 for edge function, 2 -for face function and 3 for bubble function). @code{infoKeys[0].second} gives -the order of the function associated with the key. Warning: this is an -experimental feature and will probably change in a future release. - -@table @asis -@item Input: -@code{keys}, @code{elementType}, @code{functionSpaceType} -@item Output: -@code{infoKeys} -@item Return: -- -@end table - -@item gmsh/model/mesh/getBarycenters -Get the barycenters of all elements of type @code{elementType} classified on the -entity of tag @code{tag}. If @code{primary} is set, only the primary nodes of -the elements are taken into account for the barycenter calculation. If -@code{fast} is set, the function returns the sum of the primary node coordinates -(without normalizing by the number of nodes). If @code{tag} < 0, get the -barycenters for all entities. If @code{numTasks} > 1, only compute and return -the part of the data indexed by @code{task}. - -@table @asis -@item Input: -@code{elementType}, @code{tag}, @code{fast}, @code{primary}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@code{barycenters} -@item Return: -- -@end table - -@item gmsh/model/mesh/preallocateBarycenters -Preallocate data before calling @code{getBarycenters} with @code{numTasks} > 1. -For C and C++ only. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1} -@item Output: -@code{barycenters} -@item Return: -- -@end table - -@item gmsh/model/mesh/getElementEdgeNodes -Get the nodes on the edges of all elements of type @code{elementType} classified -on the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the -edges for all the elements: [e1a1n1, e1a1n2, e1a2n1, ...]. Data is returned by -element, with elements in the same order as in @code{getElements} and -@code{getElementsByType}. If @code{primary} is set, only the primary (begin/end) -nodes of the edges are returned. If @code{tag} < 0, get the edge nodes for all -entities. If @code{numTasks} > 1, only compute and return the part of the data -indexed by @code{task}. - -@table @asis -@item Input: -@code{elementType}, @code{tag = -1}, @code{primary = False}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@code{nodeTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L60,edges.cpp}) -@end table - -@item gmsh/model/mesh/getElementFaceNodes -Get the nodes on the faces of type @code{faceType} (3 for triangular faces, 4 -for quadrangular faces) of all elements of type @code{elementType} classified on -the entity of tag @code{tag}. @code{nodeTags} contains the node tags of the -faces for all elements: [e1f1n1, ..., e1f1nFaceType, e1f2n1, ...]. Data is -returned by element, with elements in the same order as in @code{getElements} -and @code{getElementsByType}. If @code{primary} is set, only the primary -(corner) nodes of the faces are returned. If @code{tag} < 0, get the face nodes -for all entities. If @code{numTasks} > 1, only compute and return the part of -the data indexed by @code{task}. - -@table @asis -@item Input: -@code{elementType}, @code{faceType}, @code{tag = -1}, @code{primary = False}, @code{task = 0}, @code{numTasks = 1} -@item Output: -@code{nodeTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L60,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 -Get the ghost elements @code{elementTags} and their associated @code{partitions} -stored in the ghost entity of dimension @code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{elementTags}, @code{partitions} -@item Return: -- -@end table - -@item gmsh/model/mesh/setSize -Set a mesh size constraint on the model entities @code{dimTags}. Currently only -entities of dimension 0 (points) are handled. - -@table @asis -@item Input: -@code{dimTags}, @code{size} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L115,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L32,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L48,t21.cpp}, @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/t16.py#L97,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L29,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L36,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L75,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L12,periodic.py}, ...) -@end table - -@item gmsh/model/mesh/setTransfiniteCurve -Set a transfinite meshing constraint on the curve @code{tag}, with -@code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. -Currently supported types are "Progression" (geometrical progression with power -@code{coef}) and "Bump" (refinement toward both extremities of the curve). - -@table @asis -@item Input: -@code{tag}, @code{numNodes}, @code{meshType = "Progression"}, @code{coef = 1.} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L152,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L147,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L148,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L77,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/setTransfiniteSurface -Set a transfinite meshing constraint on the surface @code{tag}. -@code{arrangement} describes the arrangement of the triangles when the surface -is not flagged as recombined: currently supported values are "Left", "Right", -"AlternateLeft" and "AlternateRight". @code{cornerTags} can be used to specify -the (3 or 4) corners of the transfinite interpolation explicitly; specifying the -corners explicitly is mandatory if the surface has more that 3 or 4 points on -its boundary. - -@table @asis -@item Input: -@code{tag}, @code{arrangement = "Left"}, @code{cornerTags = []} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L156,x2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.cpp#L11,perf.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/square.cpp#L7,square.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L149,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.py#L8,perf.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L150,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L79,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/setTransfiniteVolume -Set a transfinite meshing constraint on the surface @code{tag}. -@code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite -interpolation explicitly. - -@table @asis -@item Input: -@code{tag}, @code{cornerTags = []} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L160,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L152,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L153,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L82,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/setRecombine -Set a recombination meshing constraint on the model entity of dimension -@code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to -recombine triangles into quadrangles) are supported. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L44,t11.cpp}, @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/t11.py#L42,t11.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L150,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L238,poisson.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L151,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L80,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/setSmoothing -Set a smoothing meshing constraint on the model entity of dimension @code{dim} -and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L158,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L151,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L152,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L81,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/setReverse -Set a reverse meshing constraint on the model entity of dimension @code{dim} and -tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed -with respect to the natural mesh orientation (i.e. the orientation consistent -with the orientation of the geometry). If @code{val} is false, the mesh is left -as-is. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val = True} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/setAlgorithm -Set the meshing algorithm on the model entity of dimension @code{dim} and tag -@code{tag}. Currently only supported for @code{dim} == 2. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L213,t5.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L207,t5.py}) -@end table - -@item gmsh/model/mesh/setSizeFromBoundary -Force the mesh size to be extended from the boundary, or not, for the model -entity of dimension @code{dim} and tag @code{tag}. Currently only supported for -@code{dim} == 2. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/setCompound -Set a compound meshing constraint on the model entities of dimension @code{dim} -and tags @code{tags}. During meshing, compound entities are treated as a single -discrete entity, which is automatically reparametrized. - -@table @asis -@item Input: -@code{dim}, @code{tags} -@item Output: -- -@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 -Set meshing constraints on the bounding surfaces of the volume of tag @code{tag} -so that all surfaces are oriented with outward pointing normals. Currently only -available with the OpenCASCADE kernel, as it relies on the STL triangulation. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/embed -Embed the model entities of dimension @code{dim} and tags @code{tags} in the -(@code{inDim}, @code{inTag}) model entity. The dimension @code{dim} can 0, 1 or -2 and must be strictly smaller than @code{inDim}, which must be either 2 or 3. -The embedded entities should not be part of the boundary of the entity -@code{inTag}, whose mesh will conform to the mesh of the embedded entities. - -@table @asis -@item Input: -@code{dim}, @code{tags}, @code{inDim}, @code{inTag} -@item Output: -- -@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 -Remove embedded entities from the model entities @code{dimTags}. if @code{dim} -is >= 0, only remove embedded entities of the given dimension (e.g. embedded -points if @code{dim} == 0). - -@table @asis -@item Input: -@code{dimTags}, @code{dim = -1} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/reorderElements -Reorder the elements of type @code{elementType} classified on the entity of tag -@code{tag} according to @code{ordering}. - -@table @asis -@item Input: -@code{elementType}, @code{tag}, @code{ordering} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/renumberNodes -Renumber the node tags in a continuous sequence. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/renumberElements -Renumber the element tags in a continuous sequence. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/setPeriodic -Set the meshes of the entities of dimension @code{dim} and tag @code{tags} as -periodic copies of the meshes of entities @code{tagsMaster}, using the affine -transformation specified in @code{affineTransformation} (16 entries of a 4x4 -matrix, by row). If used after meshing, generate the periodic node -correspondence information assuming the meshes of entities @code{tags} -effectively match the meshes of entities @code{tagsMaster} (useful for -structured and extruded meshes). Currently only available for @code{dim} == 1 -and @code{dim} == 2. - -@table @asis -@item Input: -@code{dim}, @code{tags}, @code{tagsMaster}, @code{affineTransform} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L40,t18.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L36,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/periodic.py#L14,periodic.py}) -@end table - -@item gmsh/model/mesh/getPeriodicNodes -Get the master entity @code{tagMaster}, the node tags @code{nodeTags} and their -corresponding master node tags @code{nodeTagsMaster}, and the affine transform -@code{affineTransform} for the entity of dimension @code{dim} and tag -@code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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#L20,periodic.py}) -@end table - -@item gmsh/model/mesh/removeDuplicateNodes -Remove duplicate nodes in the mesh of the current model. - -@table @asis -@item Input: -- -@item Output: -- -@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 -Split (into two triangles) all quadrangles in surface @code{tag} whose quality -is lower than @code{quality}. If @code{tag} < 0, split quadrangles in all -surfaces. - -@table @asis -@item Input: -@code{quality = 1.}, @code{tag = -1} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/classifySurfaces -Classify ("color") the surface mesh based on the angle threshold @code{angle} -(in radians), and create new discrete surfaces, curves and points accordingly. -If @code{boundary} is set, also create discrete curves on the boundary if the -surface is open. If @code{forReparametrization} is set, create edges and -surfaces that can be reparametrized using a single map. If @code{curveAngle} is -less than Pi, also force curves to be split according to @code{curveAngle}. - -@table @asis -@item Input: -@code{angle}, @code{boundary = True}, @code{forReparametrization = False}, @code{curveAngle = pi} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L45,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L38,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L19,glue_and_remesh_stl.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/remesh_stl.py#L18,remesh_stl.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L70,terrain.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L17,terrain_stl.py}) -@end table - -@item gmsh/model/mesh/createGeometry -Create a parametrization for discrete curves and surfaces (i.e. curves and -surfaces represented solely by a mesh, without an underlying CAD description), -assuming that each can be parametrized with a single map. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L51,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L110,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L44,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L106,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L32,glue_and_remesh_stl.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/remesh_stl.py#L22,remesh_stl.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain.py#L76,terrain.py}, ...) -@end table - -@item gmsh/model/mesh/createTopology -Create a boundary representation from the mesh if the model does not have one -(e.g. when imported from mesh file formats with no BRep representation of the -underlying model). If @code{makeSimplyConnected} is set, enforce simply -connected discrete surfaces and volumes. If @code{exportDiscrete} is set, clear -any built-in CAD kernel entities and export the discrete entities in the built- -in CAD kernel. - -@table @asis -@item Input: -@code{makeSimplyConnected = True}, @code{exportDiscrete = True} -@item Output: -- -@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 -Compute a basis representation for homology spaces after a mesh has been -generated. The computation domain is given in a list of physical group tags -@code{domainTags}; if empty, the whole mesh is the domain. The computation -subdomain for relative homology computation is given in a list of physical group -tags @code{subdomainTags}; if empty, absolute homology is computed. The -dimensions homology bases to be computed are given in the list @code{dim}; if -empty, all bases are computed. Resulting basis representation chains are stored -as physical groups in the mesh. - -@table @asis -@item Input: -@code{domainTags = []}, @code{subdomainTags = []}, @code{dims = []} -@item Output: -- -@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#L112,t14.py}) -@end table - -@item gmsh/model/mesh/computeCohomology -Compute a basis representation for cohomology spaces after a mesh has been -generated. The computation domain is given in a list of physical group tags -@code{domainTags}; if empty, the whole mesh is the domain. The computation -subdomain for relative cohomology computation is given in a list of physical -group tags @code{subdomainTags}; if empty, absolute cohomology is computed. The -dimensions homology bases to be computed are given in the list @code{dim}; if -empty, all bases are computed. Resulting basis representation cochains are -stored as physical groups in the mesh. - -@table @asis -@item Input: -@code{domainTags = []}, @code{subdomainTags = []}, @code{dims = []} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L121,t14.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L124,t14.py}) -@end table - -@item gmsh/model/mesh/computeCrossField -Compute a cross field for the current mesh. The function creates 3 views: the H -function, the Theta function and cross directions. Return the tags of the views - -@table @asis -@item Input: -- -@item Output: -@code{viewTags} -@item Return: -- -@end table - -@end ftable - -@node Namespace gmsh/model/mesh/field, Namespace gmsh/model/geo, Namespace gmsh/model/mesh, Gmsh API -@section Namespace @code{gmsh/model/mesh/field}: mesh size field functions - -@ftable @code -@item gmsh/model/mesh/field/add -Add a new mesh size field of type @code{fieldType}. If @code{tag} is positive, -assign the tag explicitly; otherwise a new tag is assigned automatically. Return -the field tag. - -@table @asis -@item Input: -@code{fieldType}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L46,t7.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L46,t10.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L38,t11.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L65,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t17.cpp#L41,t17.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L38,t7.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L44,t10.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L55,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t17.py#L35,t17.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L106,adapt_mesh.py}) -@end table - -@item gmsh/model/mesh/field/remove -Remove the field with tag @code{tag}. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/mesh/field/setNumber -Set the numerical option @code{option} to value @code{value} for field -@code{tag}. - -@table @asis -@item Input: -@code{tag}, @code{option}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L48,t10.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L271,adapt_mesh.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L46,t10.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L107,adapt_mesh.py}) -@end table - -@item gmsh/model/mesh/field/setString -Set the string option @code{option} to value @code{value} for field @code{tag}. - -@table @asis -@item Input: -@code{tag}, @code{option}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L73,t10.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L39,t11.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L67,t13.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L70,t10.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L57,t13.py}) -@end table - -@item gmsh/model/mesh/field/setNumbers -Set the numerical list option @code{option} to value @code{value} for field -@code{tag}. - -@table @asis -@item Input: -@code{tag}, @code{option}, @code{value} -@item Output: -- -@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 -Set the field @code{tag} as the background mesh size field. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L49,t7.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t10.cpp#L108,t10.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t11.cpp#L41,t11.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L70,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t17.cpp#L42,t17.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L41,t7.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t10.py#L102,t10.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L60,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t17.py#L36,t17.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L108,adapt_mesh.py}) -@end table - -@item gmsh/model/mesh/field/setAsBoundaryLayer -Set the field @code{tag} as a boundary layer size field. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@item Return: -- -@end table - -@end ftable - -@node Namespace gmsh/model/geo, Namespace gmsh/model/geo/mesh, Namespace gmsh/model/mesh/field, Gmsh API -@section Namespace @code{gmsh/model/geo}: built-in CAD kernel functions - -@ftable @code -@item gmsh/model/geo/addPoint -Add a geometrical point in the built-in CAD representation, at coordinates -(@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing -constraint at that point. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. Return the tag of the point. -(Note that the point will be added in the current model only after -@code{synchronize} is called. This behavior holds for all the entities added in -the geo module.) - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{meshSize = 0.}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L32,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L24,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L21,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L18,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L20,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L30,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L23,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L19,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L45,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L19,t6.py}, ...) -@end table - -@item gmsh/model/geo/addLine -Add a straight line segment between the two points with tags @code{startTag} and -@code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a -new tag is selected automatically. Return the tag of the line. - -@table @asis -@item Input: -@code{startTag}, @code{endTag}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L71,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L28,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L25,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L125,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L24,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L68,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L27,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L23,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L60,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L23,t6.py}, ...) -@end table - -@item gmsh/model/geo/addCircleArc -Add a circle arc (strictly smaller than Pi) between the two points with tags -@code{startTag} and @code{endTag}, with center @code{centertag}. If @code{tag} -is positive, set the tag explicitly; otherwise a new tag is selected -automatically. If (@code{nx}, @code{ny}, @code{nz}) != (0, 0, 0), explicitly set -the plane of the circle arc. Return the tag of the circle arc. - -@table @asis -@item Input: -@code{startTag}, @code{centerTag}, @code{endTag}, @code{tag = -1}, @code{nx = 0.}, @code{ny = 0.}, @code{nz = 0.} -@item Output: -- -@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#L119,t5.py}) -@end table - -@item gmsh/model/geo/addEllipseArc -Add an ellipse arc (strictly smaller than Pi) between the two points -@code{startTag} and @code{endTag}, with center @code{centerTag} and major axis -point @code{majorTag}. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. If (@code{nx}, @code{ny}, -@code{nz}) != (0, 0, 0), explicitly set the plane of the circle arc. Return the -tag of the ellipse arc. - -@table @asis -@item Input: -@code{startTag}, @code{centerTag}, @code{majorTag}, @code{endTag}, @code{tag = -1}, @code{nx = 0.}, @code{ny = 0.}, @code{nz = 0.} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/geo/addSpline -Add a spline (Catmull-Rom) curve going through the points @code{pointTags}. If -@code{tag} is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Create a periodic curve if the first and last points are the -same. Return the tag of the spline curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1} -@item Output: -- -@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 -Add a cubic b-spline curve with @code{pointTags} control points. If @code{tag} -is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Creates a periodic curve if the first and last points are the -same. Return the tag of the b-spline curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/geo/addBezier -Add a Bezier curve with @code{pointTags} control points. If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -Return the tag of the Bezier curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/geo/addCompoundSpline -Add a spline (Catmull-Rom) going through points sampling the curves in -@code{curveTags}. The density of sampling points on each curve is governed by -@code{numIntervals}. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. Return the tag of the spline. - -@table @asis -@item Input: -@code{curveTags}, @code{numIntervals = 5}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/geo/addCompoundBSpline -Add a b-spline with control points sampling the curves in @code{curveTags}. The -density of sampling points on each curve is governed by @code{numIntervals}. If -@code{tag} is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Return the tag of the b-spline. - -@table @asis -@item Input: -@code{curveTags}, @code{numIntervals = 20}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/geo/addCurveLoop -Add a curve loop (a closed wire) formed by the curves @code{curveTags}. -@code{curveTags} should contain (signed) tags of model enties of dimension 1 -forming a closed loop: a negative tag signifies that the underlying curve is -considered with reversed orientation. If @code{tag} is positive, set the tag -explicitly; otherwise a new tag is selected automatically. Return the tag of the -curve loop. - -@table @asis -@item Input: -@code{curveTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L84,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L32,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L29,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L39,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L28,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L80,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L31,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L27,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L82,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L27,t6.py}, ...) -@end table - -@item gmsh/model/geo/addPlaneSurface -Add a plane surface defined by one or more curve loops @code{wireTags}. The -first curve loop defines the exterior contour; additional curve loop define -holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is -selected automatically. Return the tag of the surface. - -@table @asis -@item Input: -@code{wireTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L89,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L33,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L30,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L148,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L29,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L85,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L32,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L28,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L83,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L28,t6.py}, ...) -@end table - -@item gmsh/model/geo/addSurfaceFilling -Add a surface filling the curve loops in @code{wireTags}. Currently only a -single curve loop is supported; this curve loop should be composed by 3 or 4 -curves only. If @code{tag} is positive, set the tag explicitly; otherwise a new -tag is selected automatically. Return the tag of the surface. - -@table @asis -@item Input: -@code{wireTags}, @code{tag = -1}, @code{sphereCenterTag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L49,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t12.cpp#L71,t12.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L142,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t12.py#L67,t12.py}) -@end table - -@item gmsh/model/geo/addSurfaceLoop -Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} -is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Return the tag of the shell. - -@table @asis -@item Input: -@code{surfaceTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L114,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L69,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L58,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L140,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L110,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L103,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L48,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L136,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L38,glue_and_remesh_stl.py}, ...) -@end table - -@item gmsh/model/geo/addVolume -Add a volume (a region) defined by one or more shells @code{shellTags}. The -first surface loop defines the exterior boundary; additional surface loop define -holes. If @code{tag} is positive, set the tag explicitly; otherwise a new tag is -selected automatically. Return the tag of the volume. - -@table @asis -@item Input: -@code{shellTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L115,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L70,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L59,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/x2.cpp#L141,x2.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L111,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L163,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t13.py#L49,t13.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x2.py#L137,x2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/glue_and_remesh_stl.py#L39,glue_and_remesh_stl.py}, ...) -@end table - -@item gmsh/model/geo/extrude -Extrude the model entities @code{dimTags} by translation along (@code{dx}, -@code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If -@code{numElements} is not empty, also extrude the mesh: the entries in -@code{numElements} give the number of elements in each layer. If @code{height} -is not empty, it provides the (cumulative) height of the different layers, -normalized to 1. If @code{dx} == @code{dy} == @code{dz} == 0, the entities are -extruded along their normal. - -@table @asis -@item Input: -@code{dimTags}, @code{dx}, @code{dy}, @code{dz}, @code{numElements = []}, @code{heights = []}, @code{recombine = False} -@item Output: -@code{outDimTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L125,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L45,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t14.cpp#L65,t14.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t15.cpp#L63,t15.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L120,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L43,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t14.py#L61,t14.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t15.py#L59,t15.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/hex.py#L8,hex.py}) -@end table - -@item gmsh/model/geo/revolve -Extrude the model entities @code{dimTags} by rotation of @code{angle} radians -around the axis of revolution defined by the point (@code{x}, @code{y}, -@code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). The angle should -be strictly smaller than Pi. Return extruded entities in @code{outDimTags}. If -@code{numElements} is not empty, also extrude the mesh: the entries in -@code{numElements} give the number of elements in each layer. If @code{height} -is not empty, it provides the (cumulative) height of the different layers, -normalized to 1. - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{ax}, @code{ay}, @code{az}, @code{angle}, @code{numElements = []}, @code{heights = []}, @code{recombine = False} -@item Output: -@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 -Extrude the model entities @code{dimTags} by a combined translation and rotation -of @code{angle} radians, along (@code{dx}, @code{dy}, @code{dz}) and around the -axis of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the -direction (@code{ax}, @code{ay}, @code{az}). The angle should be strictly -smaller than Pi. Return extruded entities in @code{outDimTags}. If -@code{numElements} is not empty, also extrude the mesh: the entries in -@code{numElements} give the number of elements in each layer. If @code{height} -is not empty, it provides the (cumulative) height of the different layers, -normalized to 1. - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{dz}, @code{ax}, @code{ay}, @code{az}, @code{angle}, @code{numElements = []}, @code{heights = []}, @code{recombine = False} -@item Output: -@code{outDimTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L63,t3.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L60,t3.py}) -@end table - -@item gmsh/model/geo/translate -Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, -@code{dz}). - -@table @asis -@item Input: -@code{dimTags}, @code{dx}, @code{dy}, @code{dz} -@item Output: -- -@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 -Rotate the model entities @code{dimTags} of @code{angle} radians around the axis -of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the -direction (@code{ax}, @code{ay}, @code{az}). - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{ax}, @code{ay}, @code{az}, @code{angle} -@item Output: -- -@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 -Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and -@code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as -the center of the homothetic transformation. - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{a}, @code{b}, @code{c} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/mirror -Mirror the model entities @code{dimTag}, with respect to the plane of equation -@code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. - -@table @asis -@item Input: -@code{dimTags}, @code{a}, @code{b}, @code{c}, @code{d} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/symmetrize -Mirror the model entities @code{dimTag}, with respect to the plane of equation -@code{a} * x + @code{b} * y + @code{c} * z + @code{d} = 0. (This is a synonym -for @code{mirror}, which will be deprecated in a future release.) - -@table @asis -@item Input: -@code{dimTags}, @code{a}, @code{b}, @code{c}, @code{d} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/copy -Copy the entities @code{dimTags}; the new entities are returned in -@code{outDimTags}. - -@table @asis -@item Input: -@code{dimTags} -@item Output: -@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 -Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the -entities on their boundaries, down to dimension 0. - -@table @asis -@item Input: -@code{dimTags}, @code{recursive = False} -@item Output: -- -@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 -Remove all duplicate entities (different entities at the same geometrical -location). - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/splitCurve -Split the model curve of tag @code{tag} on the control points @code{pointTags}. -Return the tags @code{curveTags} of the newly created curves. - -@table @asis -@item Input: -@code{tag}, @code{pointTags} -@item Output: -@code{curveTags} -@item Return: -- -@end table - -@item gmsh/model/geo/synchronize -Synchronize the built-in CAD representation with the current Gmsh model. This -can be called at any time, but since it involves a non trivial amount of -processing, the number of synchronization points should normally be minimized. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L115,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L89,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L66,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L196,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t6.cpp#L99,t6.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L110,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L86,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L63,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L192,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t6.py#L94,t6.py}, ...) -@end table - -@end ftable - -@node Namespace gmsh/model/geo/mesh, Namespace gmsh/model/occ, Namespace gmsh/model/geo, Gmsh API -@section Namespace @code{gmsh/model/geo/mesh}: built-in CAD kernel meshing constraints - -@ftable @code -@item gmsh/model/geo/mesh/setSize -Set a mesh size constraint on the model entities @code{dimTags}. Currently only -entities of dimension 0 (points) are handled. - -@table @asis -@item Input: -@code{dimTags}, @code{size} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t2.cpp#L129,t2.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t15.cpp#L41,t15.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t2.py#L124,t2.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t15.py#L37,t15.py}) -@end table - -@item gmsh/model/geo/mesh/setTransfiniteCurve -Set a transfinite meshing constraint on the curve @code{tag}, with -@code{numNodes} nodes distributed according to @code{meshType} and @code{coef}. -Currently supported types are "Progression" (geometrical progression with power -@code{coef}) and "Bump" (refinement toward both extremities of the curve). - -@table @asis -@item Input: -@code{tag}, @code{nPoints}, @code{meshType = "Progression"}, @code{coef = 1.} -@item Output: -- -@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 -Set a transfinite meshing constraint on the surface @code{tag}. -@code{arrangement} describes the arrangement of the triangles when the surface -is not flagged as recombined: currently supported values are "Left", "Right", -"AlternateLeft" and "AlternateRight". @code{cornerTags} can be used to specify -the (3 or 4) corners of the transfinite interpolation explicitly; specifying the -corners explicitly is mandatory if the surface has more that 3 or 4 points on -its boundary. - -@table @asis -@item Input: -@code{tag}, @code{arrangement = "Left"}, @code{cornerTags = []} -@item Output: -- -@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 -Set a transfinite meshing constraint on the surface @code{tag}. -@code{cornerTags} can be used to specify the (6 or 8) corners of the transfinite -interpolation explicitly. - -@table @asis -@item Input: -@code{tag}, @code{cornerTags = []} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/mesh/setRecombine -Set a recombination meshing constraint on the model entity of dimension -@code{dim} and tag @code{tag}. Currently only entities of dimension 2 (to -recombine triangles into quadrangles) are supported. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{angle = 45.} -@item Output: -- -@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 -Set a smoothing meshing constraint on the model entity of dimension @code{dim} -and tag @code{tag}. @code{val} iterations of a Laplace smoother are applied. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/mesh/setReverse -Set a reverse meshing constraint on the model entity of dimension @code{dim} and -tag @code{tag}. If @code{val} is true, the mesh orientation will be reversed -with respect to the natural mesh orientation (i.e. the orientation consistent -with the orientation of the geometry). If @code{val} is false, the mesh is left -as-is. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val = True} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/mesh/setAlgorithm -Set the meshing algorithm on the model entity of dimension @code{dim} and tag -@code{tag}. Currently only supported for @code{dim} == 2. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/geo/mesh/setSizeFromBoundary -Force the mesh size to be extended from the boundary, or not, for the model -entity of dimension @code{dim} and tag @code{tag}. Currently only supported for -@code{dim} == 2. - -@table @asis -@item Input: -@code{dim}, @code{tag}, @code{val} -@item Output: -- -@item Return: -- -@end table - -@end ftable - -@node Namespace gmsh/model/occ, Namespace gmsh/model/occ/mesh, Namespace gmsh/model/geo/mesh, Gmsh API -@section Namespace @code{gmsh/model/occ}: OpenCASCADE CAD kernel functions - -@ftable @code -@item gmsh/model/occ/addPoint -Add a geometrical point in the OpenCASCADE CAD representation, at coordinates -(@code{x}, @code{y}, @code{z}). If @code{meshSize} is > 0, add a meshing -constraint at that point. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. Return the tag of the point. -(Note that the point will be added in the current model only after -@code{synchronize} is called. This behavior holds for all the entities added in -the occ module.) - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{meshSize = 0.}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L67,t19.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.cpp#L11,spline.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L59,t19.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L14,crack.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.py#L10,spline.py}) -@end table - -@item gmsh/model/occ/addLine -Add a straight line segment between the two points with tags @code{startTag} and -@code{endTag}. If @code{tag} is positive, set the tag explicitly; otherwise a -new tag is selected automatically. Return the tag of the line. - -@table @asis -@item Input: -@code{startTag}, @code{endTag}, @code{tag = -1} -@item Output: -- -@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 -Add a circle arc between the two points with tags @code{startTag} and -@code{endTag}, with center @code{centerTag}. If @code{tag} is positive, set the -tag explicitly; otherwise a new tag is selected automatically. Return the tag of -the circle arc. - -@table @asis -@item Input: -@code{startTag}, @code{centerTag}, @code{endTag}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addCircle -Add a circle of center (@code{x}, @code{y}, @code{z}) and radius @code{r}. If -@code{tag} is positive, set the tag explicitly; otherwise a new tag is selected -automatically. If @code{angle1} and @code{angle2} are specified, create a circle -arc between the two angles. Return the tag of the circle. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{r}, @code{tag = -1}, @code{angle1 = 0.}, @code{angle2 = 2*pi} -@item Output: -- -@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 -Add an ellipse arc between the two points @code{startTag} and @code{endTag}, -with center @code{centerTag} and major axis point @code{majorTag}. If @code{tag} -is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Return the tag of the ellipse arc. Note that OpenCASCADE does not -allow creating ellipse arcs with the major radius smaller than the minor radius. - -@table @asis -@item Input: -@code{startTag}, @code{centerTag}, @code{majorTag}, @code{endTag}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addEllipse -Add an ellipse of center (@code{x}, @code{y}, @code{z}) and radii @code{r1} and -@code{r2} along the x- and y-axes respectively. If @code{tag} is positive, set -the tag explicitly; otherwise a new tag is selected automatically. If -@code{angle1} and @code{angle2} are specified, create an ellipse arc between the -two angles. Return the tag of the ellipse. Note that OpenCASCADE does not allow -creating ellipses with the major radius (along the x-axis) smaller than or equal -to the minor radius (along the y-axis): rotate the shape or use @code{addCircle} -in such cases. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{r1}, @code{r2}, @code{tag = -1}, @code{angle1 = 0.}, @code{angle2 = 2*pi} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addSpline -Add a spline (C2 b-spline) curve going through the points @code{pointTags}. If -@code{tag} is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Create a periodic curve if the first and last points are the -same. Return the tag of the spline curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L71,t19.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.cpp#L13,spline.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L62,t19.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.py#L12,spline.py}) -@end table - -@item gmsh/model/occ/addBSpline -Add a b-spline curve of degree @code{degree} with @code{pointTags} control -points. If @code{weights}, @code{knots} or @code{multiplicities} are not -provided, default parameters are computed automatically. If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -Create a periodic curve if the first and last points are the same. Return the -tag of the b-spline curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1}, @code{degree = 3}, @code{weights = []}, @code{knots = []}, @code{multiplicities = []} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.cpp#L14,spline.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.py#L13,spline.py}) -@end table - -@item gmsh/model/occ/addBezier -Add a Bezier curve with @code{pointTags} control points. If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -Return the tag of the Bezier curve. - -@table @asis -@item Input: -@code{pointTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.cpp#L15,spline.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spline.py#L14,spline.py}) -@end table - -@item gmsh/model/occ/addWire -Add a wire (open or closed) formed by the curves @code{curveTags}. Note that an -OpenCASCADE wire can be made of curves that share geometrically identical (but -topologically different) points. If @code{tag} is positive, set the tag -explicitly; otherwise a new tag is selected automatically. Return the tag of the -wire. - -@table @asis -@item Input: -@code{curveTags}, @code{tag = -1}, @code{checkClosed = False} -@item Output: -- -@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 -Add a curve loop (a closed wire) formed by the curves @code{curveTags}. -@code{curveTags} should contain tags of curves forming a closed loop. Note that -an OpenCASCADE curve loop can be made of curves that share geometrically -identical (but topologically different) points. If @code{tag} is positive, set -the tag explicitly; otherwise a new tag is selected automatically. Return the -tag of the curve loop. - -@table @asis -@item Input: -@code{curveTags}, @code{tag = -1} -@item Output: -- -@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 -Add a rectangle with lower left corner at (@code{x}, @code{y}, @code{z}) and -upper right corner at (@code{x} + @code{dx}, @code{y} + @code{dy}, @code{z}). If -@code{tag} is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Round the corners if @code{roundedRadius} is nonzero. Return the -tag of the rectangle. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{tag = -1}, @code{roundedRadius = 0.} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L162,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t17.cpp#L28,t17.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L63,t20.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L40,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L229,adapt_mesh.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L157,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t17.py#L27,t17.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L52,t20.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L32,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L70,adapt_mesh.py}, ...) -@end table - -@item gmsh/model/occ/addDisk -Add a disk with center (@code{xc}, @code{yc}, @code{zc}) and radius @code{rx} -along the x-axis and @code{ry} along the y-axis. If @code{tag} is positive, set -the tag explicitly; otherwise a new tag is selected automatically. Return the -tag of the disk. - -@table @asis -@item Input: -@code{xc}, @code{yc}, @code{zc}, @code{rx}, @code{ry}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L77,t19.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L18,edges.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L68,t19.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L37,poisson.py}) -@end table - -@item gmsh/model/occ/addPlaneSurface -Add a plane surface defined by one or more curve loops (or closed wires) -@code{wireTags}. The first curve loop defines the exterior contour; additional -curve loop define holes. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. Return the tag of the surface. - -@table @asis -@item Input: -@code{wireTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addSurfaceFilling -Add a surface filling the curve loops in @code{wireTags}. If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -Return the tag of the surface. If @code{pointTags} are provided, force the -surface to pass through the given points. - -@table @asis -@item Input: -@code{wireTag}, @code{tag = -1}, @code{pointTags = []} -@item Output: -- -@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#L147,t5.py}) -@end table - -@item gmsh/model/occ/addSurfaceLoop -Add a surface loop (a closed shell) formed by @code{surfaceTags}. If @code{tag} -is positive, set the tag explicitly; otherwise a new tag is selected -automatically. Return the tag of the surface loop. Setting @code{sewing} allows -to build a shell made of surfaces that share geometrically identical (but -topologically different) curves. - -@table @asis -@item Input: -@code{surfaceTags}, @code{tag = -1}, @code{sewing = False} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addVolume -Add a volume (a region) defined by one or more surface loops @code{shellTags}. -The first surface loop defines the exterior boundary; additional surface loop -define holes. If @code{tag} is positive, set the tag explicitly; otherwise a new -tag is selected automatically. Return the tag of the volume. - -@table @asis -@item Input: -@code{shellTags}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addSphere -Add a sphere of center (@code{xc}, @code{yc}, @code{zc}) and radius @code{r}. -The optional @code{angle1} and @code{angle2} arguments define the polar angle -opening (from -Pi/2 to Pi/2). The optional @code{angle3} argument defines the -azimuthal opening (from 0 to 2*Pi). If @code{tag} is positive, set the tag -explicitly; otherwise a new tag is selected automatically. Return the tag of the -sphere. - -@table @asis -@item Input: -@code{xc}, @code{yc}, @code{zc}, @code{radius}, @code{tag = -1}, @code{angle1 = -pi/2}, @code{angle2 = pi/2}, @code{angle3 = 2*pi} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L53,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L61,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L23,boolean.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L18,faces.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L21,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L47,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L59,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L23,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L19,gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L6,normals.py}, ...) -@end table - -@item gmsh/model/occ/addBox -Add a parallelepipedic box defined by a point (@code{x}, @code{y}, @code{z}) and -the extents along the x-, y- and z-axes. If @code{tag} is positive, set the tag -explicitly; otherwise a new tag is selected automatically. Return the tag of the -box. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{dz}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L31,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L27,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L22,boolean.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/faces.cpp#L16,faces.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L20,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L28,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L26,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L22,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L18,gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/neighbors.py#L11,neighbors.py}, ...) -@end table - -@item gmsh/model/occ/addCylinder -Add a cylinder, defined by the center (@code{x}, @code{y}, @code{z}) of its -first circular face, the 3 components (@code{dx}, @code{dy}, @code{dz}) of the -vector defining its axis and its radius @code{r}. The optional @code{angle} -argument defines the angular opening (from 0 to 2*Pi). If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -Return the tag of the cylinder. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{dz}, @code{r}, @code{tag = -1}, @code{angle = 2*pi} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L25,boolean.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L23,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L25,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L21,gui.py}) -@end table - -@item gmsh/model/occ/addCone -Add a cone, defined by the center (@code{x}, @code{y}, @code{z}) of its first -circular face, the 3 components of the vector (@code{dx}, @code{dy}, @code{dz}) -defining its axis and the two radii @code{r1} and @code{r2} of the faces (these -radii can be zero). If @code{tag} is positive, set the tag explicitly; otherwise -a new tag is selected automatically. @code{angle} defines the optional angular -opening (from 0 to 2*Pi). Return the tag of the cone. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{dz}, @code{r1}, @code{r2}, @code{tag = -1}, @code{angle = 2*pi} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addWedge -Add a right angular wedge, defined by the right-angle point (@code{x}, @code{y}, -@code{z}) and the 3 extends along the x-, y- and z-axes (@code{dx}, @code{dy}, -@code{dz}). If @code{tag} is positive, set the tag explicitly; otherwise a new -tag is selected automatically. The optional argument @code{ltx} defines the top -extent along the x-axis. Return the tag of the wedge. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{dx}, @code{dy}, @code{dz}, @code{tag = -1}, @code{ltx = 0.} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addTorus -Add a torus, defined by its center (@code{x}, @code{y}, @code{z}) and its 2 -radii @code{r} and @code{r2}. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. The optional argument -@code{angle} defines the angular opening (from 0 to 2*Pi). Return the tag of the -wedge. - -@table @asis -@item Input: -@code{x}, @code{y}, @code{z}, @code{r1}, @code{r2}, @code{tag = -1}, @code{angle = 2*pi} -@item Output: -- -@item Return: -integer value -@end table - -@item gmsh/model/occ/addThruSections -Add a volume (if the optional argument @code{makeSolid} is set) or surfaces -defined through the open or closed wires @code{wireTags}. If @code{tag} is -positive, set the tag explicitly; otherwise a new tag is selected automatically. -The new entities are returned in @code{outDimTags}. If the optional argument -@code{makeRuled} is set, the surfaces created on the boundary are forced to be -ruled surfaces. - -@table @asis -@item Input: -@code{wireTags}, @code{tag = -1}, @code{makeSolid = True}, @code{makeRuled = False} -@item Output: -@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 -Add a hollowed volume built from an initial volume @code{volumeTag} and a set of -faces from this volume @code{excludeSurfaceTags}, which are to be removed. The -remaining faces of the volume become the walls of the hollowed solid, with -thickness @code{offset}. If @code{tag} is positive, set the tag explicitly; -otherwise a new tag is selected automatically. - -@table @asis -@item Input: -@code{volumeTag}, @code{excludeSurfaceTags}, @code{offset}, @code{tag = -1} -@item Output: -@code{outDimTags} -@item Return: -- -@end table - -@item gmsh/model/occ/extrude -Extrude the model entities @code{dimTags} by translation along (@code{dx}, -@code{dy}, @code{dz}). Return extruded entities in @code{outDimTags}. If -@code{numElements} is not empty, also extrude the mesh: the entries in -@code{numElements} give the number of elements in each layer. If @code{height} -is not empty, it provides the (cumulative) height of the different layers, -normalized to 1. - -@table @asis -@item Input: -@code{dimTags}, @code{dx}, @code{dy}, @code{dz}, @code{numElements = []}, @code{heights = []}, @code{recombine = False} -@item Output: -@code{outDimTags} -@item Return: -- -@end table - -@item gmsh/model/occ/revolve -Extrude the model entities @code{dimTags} by rotation of @code{angle} radians -around the axis of revolution defined by the point (@code{x}, @code{y}, -@code{z}) and the direction (@code{ax}, @code{ay}, @code{az}). Return extruded -entities in @code{outDimTags}. If @code{numElements} is not empty, also extrude -the mesh: the entries in @code{numElements} give the number of elements in each -layer. If @code{height} is not empty, it provides the (cumulative) height of the -different layers, normalized to 1. When the mesh is extruded the angle should be -strictly smaller than 2*Pi. - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{ax}, @code{ay}, @code{az}, @code{angle}, @code{numElements = []}, @code{heights = []}, @code{recombine = False} -@item Output: -@code{outDimTags} -@item Return: -- -@end table - -@item gmsh/model/occ/addPipe -Add a pipe by extruding the entities @code{dimTags} along the wire -@code{wireTag}. Return the pipe in @code{outDimTags}. - -@table @asis -@item Input: -@code{dimTags}, @code{wireTag} -@item Output: -@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 -Fillet the volumes @code{volumeTags} on the curves @code{curveTags} with radii -@code{radii}. The @code{radii} vector can either contain a single radius, as -many radii as @code{curveTags}, or twice as many as @code{curveTags} (in which -case different radii are provided for the begin and end points of the curves). -Return the filleted entities in @code{outDimTags}. Remove the original volume if -@code{removeVolume} is set. - -@table @asis -@item Input: -@code{volumeTags}, @code{curveTags}, @code{radii}, @code{removeVolume = True} -@item Output: -@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 -Chamfer the volumes @code{volumeTags} on the curves @code{curveTags} with -distances @code{distances} measured on surfaces @code{surfaceTags}. The -@code{distances} vector can either contain a single distance, as many distances -as @code{curveTags} and @code{surfaceTags}, or twice as many as @code{curveTags} -and @code{surfaceTags} (in which case the first in each pair is measured on the -corresponding surface in @code{surfaceTags}, the other on the other adjacent -surface). Return the chamfered entities in @code{outDimTags}. Remove the -original volume if @code{removeVolume} is set. - -@table @asis -@item Input: -@code{volumeTags}, @code{curveTags}, @code{surfaceTags}, @code{distances}, @code{removeVolume = True} -@item Output: -@code{outDimTags} -@item Return: -- -@end table - -@item gmsh/model/occ/fuse -Compute the boolean union (the fusion) of the entities @code{objectDimTags} and -@code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If -@code{tag} is positive, try to set the tag explicitly (only valid if the boolean -operation results in a single entity). Remove the object if @code{removeObject} -is set. Remove the tool if @code{removeTool} is set. - -@table @asis -@item Input: -@code{objectDimTags}, @code{toolDimTags}, @code{tag = -1}, @code{removeObject = True}, @code{removeTool = True} -@item Output: -@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}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L26,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L28,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L24,gui.py}) -@end table - -@item gmsh/model/occ/intersect -Compute the boolean intersection (the common parts) of the entities -@code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in -@code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly -(only valid if the boolean operation results in a single entity). Remove the -object if @code{removeObject} is set. Remove the tool if @code{removeTool} is -set. - -@table @asis -@item Input: -@code{objectDimTags}, @code{toolDimTags}, @code{tag = -1}, @code{removeObject = True}, @code{removeTool = True} -@item Output: -@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}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L22,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L24,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L20,gui.py}) -@end table - -@item gmsh/model/occ/cut -Compute the boolean difference between the entities @code{objectDimTags} and -@code{toolDimTags}. Return the resulting entities in @code{outDimTags}. If -@code{tag} is positive, try to set the tag explicitly (only valid if the boolean -operation results in a single entity). Remove the object if @code{removeObject} -is set. Remove the tool if @code{removeTool} is set. - -@table @asis -@item Input: -@code{objectDimTags}, @code{toolDimTags}, @code{tag = -1}, @code{removeObject = True}, @code{removeTool = True} -@item Output: -@code{outDimTags}, @code{outDimTagsMap} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L41,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.cpp#L29,boolean.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L27,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L32,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/boolean.py#L29,boolean.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L25,gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/spherical_surf.py#L13,spherical_surf.py}) -@end table - -@item gmsh/model/occ/fragment -Compute the boolean fragments (general fuse) of the entities -@code{objectDimTags} and @code{toolDimTags}. Return the resulting entities in -@code{outDimTags}. If @code{tag} is positive, try to set the tag explicitly -(only valid if the boolean operation results in a single entity). Remove the -object if @code{removeObject} is set. Remove the tool if @code{removeTool} is -set. - -@table @asis -@item Input: -@code{objectDimTags}, @code{toolDimTags}, @code{tag = -1}, @code{removeObject = True}, @code{removeTool = True} -@item Output: -@code{outDimTags}, @code{outDimTagsMap} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L61,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L75,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L72,t20.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L44,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/edges.cpp#L23,edges.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L54,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L70,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L56,t20.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L34,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L21,crack.py}, ...) -@end table - -@item gmsh/model/occ/translate -Translate the model entities @code{dimTags} along (@code{dx}, @code{dy}, -@code{dz}). - -@table @asis -@item Input: -@code{dimTags}, @code{dx}, @code{dy}, @code{dz} -@item Output: -- -@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 -Rotate the model entities @code{dimTags} of @code{angle} radians around the axis -of revolution defined by the point (@code{x}, @code{y}, @code{z}) and the -direction (@code{ax}, @code{ay}, @code{az}). - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{ax}, @code{ay}, @code{az}, @code{angle} -@item Output: -- -@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 -Scale the model entities @code{dimTag} by factors @code{a}, @code{b} and -@code{c} along the three coordinate axes; use (@code{x}, @code{y}, @code{z}) as -the center of the homothetic transformation. - -@table @asis -@item Input: -@code{dimTags}, @code{x}, @code{y}, @code{z}, @code{a}, @code{b}, @code{c} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/occ/mirror -Apply a symmetry transformation to the model entities @code{dimTag}, with -respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + -@code{d} = 0. - -@table @asis -@item Input: -@code{dimTags}, @code{a}, @code{b}, @code{c}, @code{d} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/occ/symmetrize -Apply a symmetry transformation to the model entities @code{dimTag}, with -respect to the plane of equation @code{a} * x + @code{b} * y + @code{c} * z + -@code{d} = 0. (This is a synonym for @code{mirror}, which will be deprecated in -a future release.) - -@table @asis -@item Input: -@code{dimTags}, @code{a}, @code{b}, @code{c}, @code{d} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/occ/affineTransform -Apply a general affine transformation matrix @code{a} (16 entries of a 4x4 -matrix, by row; only the 12 first can be provided for convenience) to the model -entities @code{dimTag}. - -@table @asis -@item Input: -@code{dimTags}, @code{a} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/occ/copy -Copy the entities @code{dimTags}; the new entities are returned in -@code{outDimTags}. - -@table @asis -@item Input: -@code{dimTags} -@item Output: -@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 -Remove the entities @code{dimTags}. If @code{recursive} is true, remove all the -entities on their boundaries, down to dimension 0. - -@table @asis -@item Input: -@code{dimTags}, @code{recursive = False} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L85,t19.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L82,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L76,t19.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L63,t20.py}) -@end table - -@item gmsh/model/occ/removeAllDuplicates -Remove all duplicate entities (different entities at the same geometrical -location) after intersecting (using boolean fragments) all highest dimensional -entities. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@end table - -@item gmsh/model/occ/healShapes -Apply various healing procedures to the entities @code{dimTags} (or to all the -entities in the model if @code{dimTags} is empty). Return the healed entities in -@code{outDimTags}. Available healing options are listed in the Gmsh reference -manual. - -@table @asis -@item Input: -@code{dimTags = []}, @code{tolerance = 1e-8}, @code{fixDegenerated = True}, @code{fixSmallEdges = True}, @code{fixSmallFaces = True}, @code{sewFaces = True}, @code{makeSolids = True} -@item Output: -@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 -Import BREP, STEP or IGES shapes from the file @code{fileName}. The imported -entities are returned in @code{outDimTags}. If the optional argument -@code{highestDimOnly} is set, only import the highest dimensional entities in -the file. The optional argument @code{format} can be used to force the format of -the file (currently "brep", "step" or "iges"). - -@table @asis -@item Input: -@code{fileName}, @code{highestDimOnly = True}, @code{format = ""} -@item Output: -@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 -Imports an OpenCASCADE @code{shape} by providing a pointer to a native -OpenCASCADE @code{TopoDS_Shape} object (passed as a pointer to void). The -imported entities are returned in @code{outDimTags}. If the optional argument -@code{highestDimOnly} is set, only import the highest dimensional entities in -@code{shape}. For C and C++ only. Warning: this function is unsafe, as providing -an invalid pointer will lead to undefined behavior. - -@table @asis -@item Input: -@code{shape}, @code{highestDimOnly = True} -@item Output: -@code{outDimTags} -@item Return: -- -@end table - -@item gmsh/model/occ/getEntities -Get all the OpenCASCADE entities. If @code{dim} is >= 0, return only the -entities of the specified dimension (e.g. points if @code{dim} == 0). The -entities are returned as a vector of (dim, tag) integer pairs. - -@table @asis -@item Input: -@code{dim = -1} -@item Output: -@code{dimTags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t20.cpp#L85,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 -Get the OpenCASCADE entities in the bounding box defined by the two points -(@code{xmin}, @code{ymin}, @code{zmin}) and (@code{xmax}, @code{ymax}, -@code{zmax}). If @code{dim} is >= 0, return only the entities of the specified -dimension (e.g. points if @code{dim} == 0). - -@table @asis -@item Input: -@code{xmin}, @code{ymin}, @code{zmin}, @code{xmax}, @code{ymax}, @code{zmax}, @code{dim = -1} -@item Output: -@code{tags} -@item Return: -- -@end table - -@item gmsh/model/occ/getBoundingBox -Get the bounding box (@code{xmin}, @code{ymin}, @code{zmin}), (@code{xmax}, -@code{ymax}, @code{zmax}) of the OpenCASCADE entity of dimension @code{dim} and -tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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#L50,t20.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t20.py#L40,t20.py}) -@end table - -@item gmsh/model/occ/getMass -Get the mass of the OpenCASCADE entity of dimension @code{dim} and tag -@code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@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}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/volume.py#L10,volume.py}) -@end table - -@item gmsh/model/occ/getCenterOfMass -Get the center of mass of the OpenCASCADE entity of dimension @code{dim} and tag -@code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{x}, @code{y}, @code{z} -@item Return: -- -@end table - -@item gmsh/model/occ/getMatrixOfInertia -Get the matrix of inertia (by row) of the OpenCASCADE entity of dimension -@code{dim} and tag @code{tag}. - -@table @asis -@item Input: -@code{dim}, @code{tag} -@item Output: -@code{mat} -@item Return: -- -@end table - -@item gmsh/model/occ/synchronize -Synchronize the OpenCASCADE CAD representation with the current Gmsh model. This -can be called at any time, but since it involves a non trivial amount of -processing, the number of synchronization points should normally be minimized. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L166,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L84,t16.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t17.cpp#L29,t17.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t18.cpp#L28,t18.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t19.cpp#L33,t19.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L161,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L67,t16.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t17.py#L28,t17.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t18.py#L27,t18.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t19.py#L30,t19.py}, ...) -@end table - -@end ftable - -@node Namespace gmsh/model/occ/mesh, Namespace gmsh/view, Namespace gmsh/model/occ, Gmsh API -@section Namespace @code{gmsh/model/occ/mesh}: OpenCASCADE CAD kernel meshing constraints - -@ftable @code -@item gmsh/model/occ/mesh/setSize -Set a mesh size constraint on the model entities @code{dimTags}. Currently only -entities of dimension 0 (points) are handled. - -@table @asis -@item Input: -@code{dimTags}, @code{size} -@item Output: -- -@item Return: -- -@end table - -@end ftable - -@node Namespace gmsh/view, Namespace gmsh/plugin, Namespace gmsh/model/occ/mesh, Gmsh API -@section Namespace @code{gmsh/view}: post-processing view functions - -@ftable @code -@item gmsh/view/add -Add a new post-processing view, with name @code{name}. If @code{tag} is positive -use it (and remove the view with that tag if it already exists), otherwise -associate a new tag. Return the view tag. - -@table @asis -@item Input: -@code{name}, @code{tag = -1} -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L111,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L246,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L18,plugin.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.cpp#L17,view.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/viewlist.cpp#L20,viewlist.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L118,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L27,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L83,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L41,normals.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L16,plugin.py}, ...) -@end table - -@item gmsh/view/remove -Remove the view with tag @code{tag}. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L38,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L29,plugin.py}) -@end table - -@item gmsh/view/getIndex -Get the index of the view with tag @code{tag} in the list of currently loaded -views. This dynamic index (it can change when views are removed) is used to -access view options. - -@table @asis -@item Input: -@code{tag} -@item Output: -- -@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 -Get the tags of all views. - -@table @asis -@item Input: -- -@item Output: -@code{tags} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L42,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L76,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L32,plugin.py}) -@end table - -@item gmsh/view/addModelData -Add model-based post-processing data to the view with tag @code{tag}. -@code{modelName} identifies the model the data is attached to. @code{dataType} -specifies the type of data, currently either "NodeData", "ElementData" or -"ElementNodeData". @code{step} specifies the identifier (>= 0) of the data in a -sequence. @code{tags} gives the tags of the nodes or elements in the mesh to -which the data is associated. @code{data} is a vector of the same length as -@code{tags}: each entry is the vector of double precision numbers representing -the data associated with the corresponding tag. The optional @code{time} -argument associate a time value with the data. @code{numComponents} gives the -number of data components (1 for scalar data, 3 for vector data, etc.) per -entity; if negative, it is automatically inferred (when possible) from the input -data. @code{partition} allows to specify data in several sub-sets. - -@table @asis -@item Input: -@code{tag}, @code{step}, @code{modelName}, @code{dataType}, @code{tags}, @code{data}, @code{time = 0.}, @code{numComponents = -1}, @code{partition = 0} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L248,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L19,plugin.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.cpp#L21,view.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L95,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L84,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L17,plugin.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/poisson.py#L229,poisson.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.py#L20,view.py}) -@end table - -@item gmsh/view/addHomogeneousModelData -Add homogeneous model-based post-processing data to the view with tag -@code{tag}. The arguments have the same meaning as in @code{addModelData}, -except that @code{data} is supposed to be homogeneous and is thus flattened in a -single vector. This is always possible e.g. for "NodeData" and "ElementData", -but only if data is associated to elements of the same type for -"ElementNodeData". - -@table @asis -@item Input: -@code{tag}, @code{step}, @code{modelName}, @code{dataType}, @code{tags}, @code{data}, @code{time = 0.}, @code{numComponents = -1}, @code{partition = 0} -@item Output: -- -@item Return: -- -@item Examples: -Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L105,x3.py}) -@end table - -@item gmsh/view/getModelData -Get model-based post-processing data from the view with tag @code{tag} at step -@code{step}. Return the @code{data} associated to the nodes or the elements with -tags @code{tags}, as well as the @code{dataType} and the number of components -@code{numComponents}. - -@table @asis -@item Input: -@code{tag}, @code{step} -@item Output: -@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#L20,perf.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L28,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.py#L12,perf.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L21,plugin.py}) -@end table - -@item gmsh/view/addListData -Add list-based post-processing data to the view with tag @code{tag}. -@code{dataType} identifies the data: "SP" for scalar points, "VP", for vector -points, etc. @code{numEle} gives the number of elements in the data. @code{data} -contains the data for the @code{numEle} elements. - -@table @asis -@item Input: -@code{tag}, @code{dataType}, @code{numEle}, @code{data} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/viewlist.cpp#L25,viewlist.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L53,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L42,normals.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view_combine.py#L19,view_combine.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/viewlist.py#L20,viewlist.py}) -@end table - -@item gmsh/view/getListData -Get list-based post-processing data from the view with tag @code{tag}. Return -the types @code{dataTypes}, the number of elements @code{numElements} for each -data type and the @code{data} for each data type. - -@table @asis -@item Input: -@code{tag} -@item Output: -@code{dataType}, @code{numElements}, @code{data} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L48,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L36,plugin.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/volume.py#L20,volume.py}) -@end table - -@item gmsh/view/addListDataString -Add a string to a list-based post-processing view with tag @code{tag}. If -@code{coord} contains 3 coordinates the string is positioned in the 3D model -space ("3D string"); if it contains 2 coordinates it is positioned in the 2D -graphics viewport ("2D string"). @code{data} contains one or more (for multistep -views) strings. @code{style} contains pairs of styling parameters, concatenated. - -@table @asis -@item Input: -@code{tag}, @code{coord}, @code{data}, @code{style = []} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L115,t4.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L122,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L59,x3.py}) -@end table - -@item gmsh/view/getListDataStrings -Get list-based post-processing data strings (2D strings if @code{dim} = 2, 3D -strings if @code{dim} = 3) from the view with tag @code{tag}. Return the -coordinates in @code{coord}, the strings in @code{data} and the styles in -@code{style}. - -@table @asis -@item Input: -@code{tag}, @code{dim} -@item Output: -@code{coord}, @code{data}, @code{style} -@item Return: -- -@end table - -@item gmsh/view/addAlias -Add a post-processing view as an @code{alias} of the reference view with tag -@code{refTag}. If @code{copyOptions} is set, copy the options of the reference -view. If @code{tag} is positive use it (and remove the view with that tag if it -already exists), otherwise associate a new tag. Return the view tag. - -@table @asis -@item Input: -@code{refTag}, @code{copyOptions = False}, @code{tag = -1} -@item Output: -- -@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 -Copy the options from the view with tag @code{refTag} to the view with tag -@code{tag}. - -@table @asis -@item Input: -@code{refTag}, @code{tag} -@item Output: -- -@item Return: -- -@end table - -@item gmsh/view/combine -Combine elements (if @code{what} == "elements") or steps (if @code{what} == -"steps") of all views (@code{how} == "all"), all visible views (@code{how} == -"visible") or all views having the same name (@code{how} == "name"). Remove -original views if @code{remove} is set. - -@table @asis -@item Input: -@code{what}, @code{how}, @code{remove = True}, @code{copyOptions = True} -@item Output: -- -@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 -Probe the view @code{tag} for its @code{value} at point (@code{x}, @code{y}, -@code{z}). Return only the value at step @code{step} is @code{step} is positive. -Return only values with @code{numComp} if @code{numComp} is positive. Return the -gradient of the @code{value} if @code{gradient} is set. Probes with a -geometrical tolerance (in the reference unit cube) of @code{tolerance} if -@code{tolerance} is not zero. Return the result from the element described by -its coordinates if @code{xElementCoord}, @code{yElementCoord} and -@code{zElementCoord} are provided. - -@table @asis -@item Input: -@code{tag}, @code{x}, @code{y}, @code{z}, @code{step = -1}, @code{numComp = -1}, @code{gradient = False}, @code{tolerance = 0.}, @code{xElemCoord = []}, @code{yElemCoord = []}, @code{zElemCoord = []} -@item Output: -@code{value} -@item Return: -- -@end table - -@item gmsh/view/write -Write the view to a file @code{fileName}. The export format is determined by the -file extension. Append to the file if @code{append} is set. - -@table @asis -@item Input: -@code{tag}, @code{fileName}, @code{append = False} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.cpp#L249,adapt_mesh.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L44,plugin.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.cpp#L25,view.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/viewlist.cpp#L27,viewlist.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/x3.py#L130,x3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/adapt_mesh.py#L86,adapt_mesh.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/normals.py#L43,normals.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L34,plugin.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/view.py#L28,view.py}, ...) -@end table - -@end ftable - -@node Namespace gmsh/plugin, Namespace gmsh/graphics, Namespace gmsh/view, Gmsh API -@section Namespace @code{gmsh/plugin}: plugin functions - -@ftable @code -@item gmsh/plugin/setNumber -Set the numerical option @code{option} to the value @code{value} for plugin -@code{name}. - -@table @asis -@item Input: -@code{name}, @code{option}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L38,t9.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L95,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L32,partition.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L34,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L30,t9.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L80,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L36,crack.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L28,partition.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.py#L25,plugin.py}, ...) -@end table - -@item gmsh/plugin/setString -Set the string option @code{option} to the value @code{value} for plugin -@code{name}. - -@table @asis -@item Input: -@code{name}, @code{option}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L54,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 -Run the plugin @code{name}. - -@table @asis -@item Input: -@code{name} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L40,t9.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t21.cpp#L98,t21.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.cpp#L33,partition.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.cpp#L13,perf.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/plugin.cpp#L35,plugin.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t9.py#L32,t9.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t21.py#L83,t21.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L37,crack.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/partition.py#L29,partition.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/perf.py#L10,perf.py}, ...) -@end table - -@end ftable - -@node Namespace gmsh/graphics, Namespace gmsh/fltk, Namespace gmsh/plugin, Gmsh API -@section Namespace @code{gmsh/graphics}: graphics functions - -@ftable @code -@item gmsh/graphics/draw -Draw all the OpenGL scenes. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L149,t8.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L33,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L177,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L36,gui.py}) -@end table - -@end ftable - -@node Namespace gmsh/fltk, Namespace gmsh/onelab, Namespace gmsh/graphics, Gmsh API -@section Namespace @code{gmsh/fltk}: FLTK graphical user interface functions - -@ftable @code -@item gmsh/fltk/initialize -Create the FLTK graphical user interface. Can only be called in the main thread. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L75,t8.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L72,custom_gui.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L10,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t8.py#L70,t8.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/crack.py#L5,crack.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L70,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L8,gui.py}) -@end table - -@item gmsh/fltk/wait -Wait at most @code{time} seconds for user interface events and return. If -@code{time} < 0, wait indefinitely. First automatically create the user -interface if it has not yet been initialized. Can only be called in the main -thread. - -@table @asis -@item Input: -@code{time = -1.} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L79,custom_gui.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.cpp#L35,gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L78,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/gui.py#L38,gui.py}) -@end table - -@item gmsh/fltk/update -Update the user interface (potentially creating new widgets and windows). First -automatically create the user interface if it has not yet been initialized. Can -only be called in the main thread: use @code{awake("update")} to trigger an -update of the user interface from another thread. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L90,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L89,custom_gui.py}) -@end table - -@item gmsh/fltk/awake -Awake the main user interface thread and process pending events, and optionally -perform an action (currently the only @code{action} allowed is "update"). - -@table @asis -@item Input: -@code{action = ""} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L39,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/fltk/lock -Block the current thread until it can safely modify the user interface. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L32,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L55,custom_gui.py}) -@end table - -@item gmsh/fltk/unlock -Release the lock that was set using lock. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L34,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L57,custom_gui.py}) -@end table - -@item gmsh/fltk/run -Run the event loop of the graphical user interface, i.e. repeatedly call -@code{wait()}. First automatically create the user interface if it has not yet -been initialized. Can only be called in the main thread. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t1.cpp#L151,t1.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t3.cpp#L97,t3.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t4.cpp#L170,t4.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t5.cpp#L103,t5.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L58,t7.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t1.py#L146,t1.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t3.py#L93,t3.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t4.py#L177,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L38,t5.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t7.py#L50,t7.py}, ...) -@end table - -@item gmsh/fltk/isAvailable -Check if the user interface is available (e.g. to detect if it has been closed). - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -integer value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L76,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L74,custom_gui.py}) -@end table - -@item gmsh/fltk/selectEntities -Select entities in the user interface. If @code{dim} is >= 0, return only the -entities of the specified dimension (e.g. points if @code{dim} == 0). - -@table @asis -@item Input: -@code{dim = -1} -@item Output: -@code{dimTags} -@item Return: -integer value -@end table - -@item gmsh/fltk/selectElements -Select elements in the user interface. - -@table @asis -@item Input: -- -@item Output: -@code{elementTags} -@item Return: -integer value -@end table - -@item gmsh/fltk/selectViews -Select views in the user interface. - -@table @asis -@item Input: -- -@item Output: -@code{viewTags} -@item Return: -integer value -@end table - -@end ftable - -@node Namespace gmsh/onelab, Namespace gmsh/logger, Namespace gmsh/fltk, Gmsh API -@section Namespace @code{gmsh/onelab}: ONELAB server functions - -@ftable @code -@item gmsh/onelab/set -Set one or more parameters in the ONELAB database, encoded in @code{format}. - -@table @asis -@item Input: -@code{data}, @code{format = "json"} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L69,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L29,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L11,onelab_test.py}) -@end table - -@item gmsh/onelab/get -Get all the parameters (or a single one if @code{name} is specified) from the -ONELAB database, encoded in @code{format}. - -@table @asis -@item Input: -@code{name = ""}, @code{format = "json"} -@item Output: -@code{data} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.cpp#L20,onelab_data.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_data.py#L16,onelab_data.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L37,onelab_test.py}) -@end table - -@item gmsh/onelab/setNumber -Set the value of the number parameter @code{name} in the ONELAB database. Create -the parameter if it does not exist; update the value if the parameter exists. - -@table @asis -@item Input: -@code{name}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L43,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L63,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L42,onelab_test.py}) -@end table - -@item gmsh/onelab/setString -Set the value of the string parameter @code{name} in the ONELAB database. Create -the parameter if it does not exist; update the value if the parameter exists. - -@table @asis -@item Input: -@code{name}, @code{value} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L29,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L52,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/onelab_test.py#L43,onelab_test.py}) -@end table - -@item gmsh/onelab/getNumber -Get the value of the number parameter @code{name} from the ONELAB database. -Return an empty vector if the parameter does not exist. - -@table @asis -@item Input: -@code{name} -@item Output: -@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#L37,custom_gui.py}) -@end table - -@item gmsh/onelab/getString -Get the value of the string parameter @code{name} from the ONELAB database. -Return an empty vector if the parameter does not exist. - -@table @asis -@item Input: -@code{name} -@item Output: -@code{value} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L84,custom_gui.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L82,custom_gui.py}) -@end table - -@item gmsh/onelab/clear -Clear the ONELAB database, or remove a single parameter if @code{name} is given. - -@table @asis -@item Input: -@code{name = ""} -@item Output: -- -@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 -Run a ONELAB client. If @code{name} is provided, create a new ONELAB client with -name @code{name} and executes @code{command}. If not, try to run a client that -might be linked to the processed input files. - -@table @asis -@item Input: -@code{name = ""}, @code{command = ""} -@item Output: -- -@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 - -@node Namespace gmsh/logger, , Namespace gmsh/onelab, Gmsh API -@section Namespace @code{gmsh/logger}: information logging functions - -@ftable @code -@item gmsh/logger/write -Write a @code{message}. @code{level} can be "info", "warning" or "error". - -@table @asis -@item Input: -@code{message}, @code{level = "info"} -@item Output: -- -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t7.cpp#L40,t7.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t8.cpp#L41,t8.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t9.cpp#L31,t9.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t13.cpp#L24,t13.cpp}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L34,t16.cpp}, ...), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.py#L56,custom_gui.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/terrain_stl.py#L27,terrain_stl.py}) -@end table - -@item gmsh/logger/start -Start logging messages. - -@table @asis -@item Input: -- -@item Output: -- -@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 -Get logged messages. - -@table @asis -@item Input: -- -@item Output: -@code{log} -@item Return: -- -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/c++/t16.cpp#L137,t16.cpp}), Python (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t16.py#L117,t16.py}) -@end table - -@item gmsh/logger/stop -Stop logging messages. - -@table @asis -@item Input: -- -@item Output: -- -@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#L119,t16.py}) -@end table - -@item gmsh/logger/getWallTime -Return wall clock time. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -floating point value -@item Examples: -C++ (@url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/demos/api/custom_gui.cpp#L37,custom_gui.cpp}) -@end table - -@item gmsh/logger/getCpuTime -Return CPU time. - -@table @asis -@item Input: -- -@item Output: -- -@item Return: -floating point value -@end table - -@end ftable - diff --git a/tutorial/c++/x2.cpp b/tutorial/c++/x2.cpp index b73a2754f6..001a964f15 100644 --- a/tutorial/c++/x2.cpp +++ b/tutorial/c++/x2.cpp @@ -80,7 +80,7 @@ int main(int argc, char **argv) gmsh::model::setCoordinates(3, 1, 1, coords[3 * tag(N, N) - 1]); gmsh::model::setCoordinates(4, 0, 1, coords[3 * tag(0, N) - 1]); - // Create 4 discrete bounding curves, with their CAD boundary points: + // Create 4 discrete bounding curves, with their boundary points: for(int i = 0; i < 4; i++) gmsh::model::addDiscreteEntity(1, i + 1, {i + 1, (i < 3) ? (i + 2) : 1}); @@ -90,7 +90,7 @@ int main(int argc, char **argv) // Add all the nodes on the surface (for simplicity... see below): gmsh::model::mesh::addNodes(2, 1, nodes, coords); - // Add point elements on the 4 CAD points, line elements on the 4 curves, and + // Add point elements on the 4 points, line elements on the 4 curves, and // triangle elements on the surface: for(int i = 0; i < 4; i++) { // Type 15 for point elements: diff --git a/tutorial/python/x2.py b/tutorial/python/x2.py index 69370b01e2..ebbdbd0caa 100644 --- a/tutorial/python/x2.py +++ b/tutorial/python/x2.py @@ -77,7 +77,7 @@ gmsh.model.setCoordinates(2, 1, 0, coords[3 * tag(N, 0) - 1]) gmsh.model.setCoordinates(3, 1, 1, coords[3 * tag(N, N) - 1]) gmsh.model.setCoordinates(4, 0, 1, coords[3 * tag(0, N) - 1]) -# Create 4 discrete bounding curves, with their (CAD) boundary points: +# Create 4 discrete bounding curves, with their boundary points: for i in range(4): gmsh.model.addDiscreteEntity(1, i + 1, [i + 1, i + 2 if i < 3 else 1]) @@ -87,7 +87,7 @@ gmsh.model.addDiscreteEntity(2, 1, [1, 2, -3, -4]) # Add all the nodes on the surface (for simplicity... see below): gmsh.model.mesh.addNodes(2, 1, nodes, coords) -# Add point elements on the 4 CAD points, line elements on the 4 curves, and +# Add point elements on the 4 points, line elements on the 4 curves, and # triangle elements on the surface: for i in range(4): # Type 15 for point elements: -- GitLab