api.texi

@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#L13,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#L228,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#L181,t4.py}, @url{https://gitlab.onelab.info/gmsh/gmsh/tree/master/tutorial/python/t5.py#L223,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}, ...)