Commit ffe316a8 by Christophe Geuzaine

more docs

parent fb3760af
Pipeline #914 passed with stage
in 104 minutes 11 seconds
......@@ -30,7 +30,7 @@ gmsh.add('initialize',doc,None,argcargv())
doc = '''Finalizes Gmsh. This must be called when you are done using the Gmsh API.'''
gmsh.add('finalize',doc,None)
doc = '''Opens a file and adds one (or more) new model(s). Equivalent to the `File->Open' menu in the Gmsh app. Handling of the file depends on its extension and/or its contents.'''
doc = '''Opens a file. Equivalent to the `File->Open' menu in the Gmsh app. Handling of the file depends on its extension and/or its contents.'''
gmsh.add('open',doc,None,istring('fileName'))
doc = '''Merges a file. Equivalent to the `File->Merge' menu in the Gmsh app. Handling of the file depends on its extension and/or its contents.'''
......@@ -302,10 +302,10 @@ occ.add('addWire',doc,oint,ivectorint('edgeTags'),iint('tag','-1'),ibool('checkC
doc = '''Adds a line loop (a closed wire) formed by `edgeTags'. `edgeTags' should contain (signed) tags of geometrical enties of dimension 1 forming a closed loop: a negative tag signifies that the underlying edge is considered with reversed orientation. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the line loop.'''
occ.add('addLineLoop',doc,oint,ivectorint('edgeTags'),iint('tag','-1'))
doc = '''TODO'''
doc = '''Adds a rectangle with lower left corner at (`x', `y', `z') and upper right corner at (`x' + `dx', `y' + `dy', `z'). If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Rounds the corners if `roundedRadius' is nonzero. Returns the tag of the rectangle.'''
occ.add('addRectangle',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('dx'),idouble('dy'),iint('tag','-1'),idouble('roundedRadius','0.'))
doc = '''TODO'''
doc = '''Adds a disk with center (`xc', `yc', `zc') and radius `rx' along the x-axis and `ry; along the y-axis. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the disk.'''
occ.add('addDisk',doc,oint,idouble('xc'),idouble('yc'),idouble('zc'),idouble('rx'),idouble('ry'),iint('tag','-1'))
doc = '''Adds a plane surface defined by one or more line loops (or closed wires) `wireTags'. The first line loop defines the exterior contour; additional line loop define holes. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the surface.'''
......@@ -320,28 +320,30 @@ occ.add('addSurfaceLoop',doc,oint,ivectorint('faceTags'),iint('tag','-1'))
doc = '''Adds a volume defined by one or more surface loops `shellTags'. The first surface loop defines the exterior boundary; additional surface loop define holes. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the volume.'''
occ.add('addVolume',doc,oint,ivectorint('shellTags'),iint('tag','-1'))
doc = '''TODO'''
doc = '''Adds a sphere of center (`xc', `yc', `zc') and radius `r'. The optional `angle1' and `angle2' arguments define the polar angle opening (from -Pi/2 to Pi/2). The optional `angle3' argument defines the azimuthal opening (from 0 to 2*Pi). If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the sphere.'''
occ.add('addSphere',doc,oint,idouble('xc'),idouble('yc'),idouble('zc'),idouble('radius'),iint('tag','-1'),idouble('angle1','-M_PI/2','-pi/2'),idouble('angle2','M_PI/2','pi/2'),idouble('angle3','2*M_PI','2*pi'))
doc = '''TODO'''
doc = '''Adds a parallelepipedic box defined by a point (`x', `y', `z') and the extents along the x-, y- and z-axes. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the box.'''
occ.add('addBox',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('dx'),idouble('dy'),idouble('dz'),iint('tag','-1'))
doc = '''TODO'''
doc = '''Adds a cylinder, defined by the center (`x', `y', `z') of its first circular face, the 3 components (`dx', `dy', `dz') of the vector defining its axis and its radius `r'. The optional `angle' argument defines the angular opening (from 0 to 2*Pi). If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the cylinder.'''
occ.add('addCylinder',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('dx'),idouble('dy'),idouble('dz'),idouble('r'),iint('tag','-1'),idouble('angle','2*M_PI','2*pi'))
doc = '''TODO'''
doc = '''Add a cone, defined by the center (`x', `y', `z') of its first circular face, the 3 components of the vector (`dx', `dy', `dz') defining its axis and the two radii `r1' and `r2' of the faces (these radii can be zero). If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. `angle' defines the optional angular opening (from 0 to 2*Pi). Returns the tag of the cone.'''
occ.add('addCone',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('dx'),idouble('dy'),idouble('dz'),idouble('r1'),idouble('r2'),iint('tag','-1'),idouble('angle','2*M_PI','2*pi'))
doc = '''TODO'''
doc = '''Add a right angular wedge, defined by the right-angle point (`x', `y', `z') and the 3 extends along the x-, y- and z-axes (`dx', `dy', `dz'). If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. The optional argument `ltx' defines the
top extent along the x-axis. Returns the tag of the wedge.'''
occ.add('addWedge',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('dx'),idouble('dy'),idouble('dz'),iint('tag','-1'),idouble('ltx','0.'))
doc = '''TODO'''
doc = '''Adds a torus, defined by its center (`x', `y', `z') and its 2 radii `r' and `r2'. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. The optional argument `angle' defines the angular opening (from 0 to 2*Pi). Returns the tag of the wedge.'''
occ.add('addTorus',doc,oint,idouble('x'),idouble('y'),idouble('z'),idouble('r1'),idouble('r2'),iint('tag','-1'),idouble('angle','2*M_PI','2*pi'))
doc = '''TODO'''
doc = '''Adds a volume (if the optional argument `makeSolid' is set) or surfaces defined through the open or closed wires `wireTags'. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. The new entities are returned in `outDimTags'. If the optional argument `makeRuled' is set, the surfaces created on the boundary are forced to be ruled surfaces.'''
occ.add('addThruSections',doc,oint,ivectorint('wireTags'),ovectorpair('outDimTags'),iint('tag','-1'),ibool('makeSolid','true','True'),ibool('makeRuled','false','False'))
doc = '''TODO'''
doc = '''Adds a hollowed volume built from an initial volume `solidTag' and a set of faces from this volume `excludeFaceTags', which are to be removed. The remaining faces of the volume become the walls of the hollowed solid, with thickness `offset'. If `tag' is positive, sets the tag explicitly; otherwise a new tag is selected automatically. Returns the tag of the volume.'''
occ.add('addThickSolid',doc,oint,iint('solidTag'),ivectorint('excludeFaceTags'),idouble('offset'),ovectorpair('outDimTags'),iint('tag','-1'))
doc = '''Extrudes the geometrical entities in `dimTags' by translation along (`dx', `dy', `dz'). Returns extruded entities in `outDimTags'. If `numElements' is not empty, also extrude the mesh: the entries in `numElements' give the number of elements in each layer. If `height' is not empty, it provides the (cummulative) height of the different layers, normalized to 1.'''
......@@ -389,7 +391,7 @@ occ.add('remove',doc,None,ivectorpair('dimTags'),ibool('recursive','false','Fals
doc = '''Removes all duplicate entities (different entities at the same geometrical location) after intersecting (using boolean fragments) all highest dimensional entities.'''
occ.add('removeAllDuplicates',doc,None)
doc = '''TODO'''
doc = '''Imports BREP, STEP or IGES shapes from the file `fileName'. The imported entities are returned in `outDimTags'. If the optional argument `highestDimOnly' is set, only import the highest dimensional entities in the file. The optional argument `format' can be used to force the format of the file (currently "brep", "step" or "iges").'''
occ.add('importShapes',doc,None,istring('fileName'),ovectorpair('outDimTags'),ibool('highestDimOnly','true','True'),istring('format','""'))
doc = '''Sets a mesh size constraint on the geometrical entities `dimTags'. Currently only entities of dimension 0 (points) are handled.'''
......
......@@ -49,9 +49,8 @@ namespace gmsh { // Top-level functions
// Finalizes Gmsh. This must be called when you are done using the Gmsh API.
GMSH_API void finalize();
// Opens a file and adds one (or more) new model(s). Equivalent to the
// `File->Open' menu in the Gmsh app. Handling of the file depends on its
// extension and/or its contents.
// Opens a file. Equivalent to the `File->Open' menu in the Gmsh app. Handling of
// the file depends on its extension and/or its contents.
GMSH_API void open(const std::string & fileName);
// Merges a file. Equivalent to the `File->Merge' menu in the Gmsh app. Handling
......@@ -751,7 +750,10 @@ namespace gmsh { // Top-level functions
GMSH_API int addLineLoop(const std::vector<int> & edgeTags,
const int tag = -1);
// TODO
// Adds a rectangle with lower left corner at (`x', `y', `z') and upper right
// corner at (`x' + `dx', `y' + `dy', `z'). If `tag' is positive, sets the
// tag explicitly; otherwise a new tag is selected automatically. Rounds the
// corners if `roundedRadius' is nonzero. Returns the tag of the rectangle.
GMSH_API int addRectangle(const double x,
const double y,
const double z,
......@@ -760,7 +762,10 @@ namespace gmsh { // Top-level functions
const int tag = -1,
const double roundedRadius = 0.);
// TODO
// Adds a disk with center (`xc', `yc', `zc') and radius `rx' along the
// x-axis and `ry; along the y-axis. If `tag' is positive, sets the tag
// explicitly; otherwise a new tag is selected automatically. Returns the tag
// of the disk.
GMSH_API int addDisk(const double xc,
const double yc,
const double zc,
......@@ -795,7 +800,11 @@ namespace gmsh { // Top-level functions
GMSH_API int addVolume(const std::vector<int> & shellTags,
const int tag = -1);
// TODO
// Adds a sphere of center (`xc', `yc', `zc') and radius `r'. The optional
// `angle1' and `angle2' arguments define the polar angle opening (from -Pi/2
// to Pi/2). The optional `angle3' argument defines the azimuthal opening
// (from 0 to 2*Pi). If `tag' is positive, sets the tag explicitly; otherwise
// a new tag is selected automatically. Returns the tag of the sphere.
GMSH_API int addSphere(const double xc,
const double yc,
const double zc,
......@@ -805,7 +814,10 @@ namespace gmsh { // Top-level functions
const double angle2 = M_PI/2,
const double angle3 = 2*M_PI);
// TODO
// Adds a parallelepipedic box defined by a point (`x', `y', `z') and the
// extents along the x-, y- and z-axes. If `tag' is positive, sets the tag
// explicitly; otherwise a new tag is selected automatically. Returns the tag
// of the box.
GMSH_API int addBox(const double x,
const double y,
const double z,
......@@ -814,7 +826,12 @@ namespace gmsh { // Top-level functions
const double dz,
const int tag = -1);
// TODO
// Adds a cylinder, defined by the center (`x', `y', `z') of its first
// circular face, the 3 components (`dx', `dy', `dz') of the vector defining
// its axis and its radius `r'. The optional `angle' argument defines the
// angular opening (from 0 to 2*Pi). If `tag' is positive, sets the tag
// explicitly; otherwise a new tag is selected automatically. Returns the tag
// of the cylinder.
GMSH_API int addCylinder(const double x,
const double y,
const double z,
......@@ -825,7 +842,12 @@ namespace gmsh { // Top-level functions
const int tag = -1,
const double angle = 2*M_PI);
// TODO
// Add a cone, defined by the center (`x', `y', `z') of its first circular
// face, the 3 components of the vector (`dx', `dy', `dz') defining its axis
// and the two radii `r1' and `r2' of the faces (these radii can be zero). If
// `tag' is positive, sets the tag explicitly; otherwise a new tag is
// selected automatically. `angle' defines the optional angular opening (from
// 0 to 2*Pi). Returns the tag of the cone.
GMSH_API int addCone(const double x,
const double y,
const double z,
......@@ -837,7 +859,11 @@ namespace gmsh { // Top-level functions
const int tag = -1,
const double angle = 2*M_PI);
// TODO
// Add a right angular wedge, defined by the right-angle point (`x', `y',
// `z') and the 3 extends along the x-, y- and z-axes (`dx', `dy', `dz'). If
// `tag' is positive, sets the tag explicitly; otherwise a new tag is
// selected automatically. The optional argument `ltx' defines the top extent
// along the x-axis. Returns the tag of the wedge.
GMSH_API int addWedge(const double x,
const double y,
const double z,
......@@ -847,7 +873,10 @@ namespace gmsh { // Top-level functions
const int tag = -1,
const double ltx = 0.);
// TODO
// Adds a torus, defined by its center (`x', `y', `z') and its 2 radii `r'
// and `r2'. If `tag' is positive, sets the tag explicitly; otherwise a new
// tag is selected automatically. The optional argument `angle' defines the
// angular opening (from 0 to 2*Pi). Returns the tag of the wedge.
GMSH_API int addTorus(const double x,
const double y,
const double z,
......@@ -856,14 +885,24 @@ namespace gmsh { // Top-level functions
const int tag = -1,
const double angle = 2*M_PI);
// TODO
// Adds a volume (if the optional argument `makeSolid' is set) or surfaces
// defined through the open or closed wires `wireTags'. If `tag' is positive,
// sets the tag explicitly; otherwise a new tag is selected automatically.
// The new entities are returned in `outDimTags'. If the optional argument
// `makeRuled' is set, the surfaces created on the boundary are forced to be
// ruled surfaces.
GMSH_API int addThruSections(const std::vector<int> & wireTags,
gmsh::vector_pair & outDimTags,
const int tag = -1,
const bool makeSolid = true,
const bool makeRuled = false);
// TODO
// Adds a hollowed volume built from an initial volume `solidTag' and a set
// of faces from this volume `excludeFaceTags', which are to be removed. The
// remaining faces of the volume become the walls of the hollowed solid, with
// thickness `offset'. If `tag' is positive, sets the tag explicitly;
// otherwise a new tag is selected automatically. Returns the tag of the
// volume.
GMSH_API int addThickSolid(const int solidTag,
const std::vector<int> & excludeFaceTags,
const double offset,
......@@ -1005,7 +1044,11 @@ namespace gmsh { // Top-level functions
// dimensional entities.
GMSH_API void removeAllDuplicates();
// TODO
// Imports BREP, STEP or IGES shapes from the file `fileName'. The imported
// entities are returned in `outDimTags'. If the optional argument
// `highestDimOnly' is set, only import the highest dimensional entities in
// the file. The optional argument `format' can be used to force the format
// of the file (currently "brep", "step" or "iges").
GMSH_API void importShapes(const std::string & fileName,
gmsh::vector_pair & outDimTags,
const bool highestDimOnly = true,
......
......@@ -169,9 +169,8 @@ def finalize():
def open(fileName):
"""
Opens a file and adds one (or more) new model(s). Equivalent to the
`File->Open' menu in the Gmsh app. Handling of the file depends on its
extension and/or its contents.
Opens a file. Equivalent to the `File->Open' menu in the Gmsh app. Handling
of the file depends on its extension and/or its contents.
"""
ierr = c_int()
lib.gmshOpen(
......@@ -2052,7 +2051,10 @@ class model:
@staticmethod
def addRectangle(x,y,z,dx,dy,tag=-1,roundedRadius=0.):
"""
TODO
Adds a rectangle with lower left corner at (`x', `y', `z') and upper right
corner at (`x' + `dx', `y' + `dy', `z'). If `tag' is positive, sets the tag
explicitly; otherwise a new tag is selected automatically. Rounds the
corners if `roundedRadius' is nonzero. Returns the tag of the rectangle.
return int
"""
......@@ -2075,7 +2077,9 @@ class model:
@staticmethod
def addDisk(xc,yc,zc,rx,ry,tag=-1):
"""
TODO
Adds a disk with center (`xc', `yc', `zc') and radius `rx' along the x-axis
and `ry; along the y-axis. If `tag' is positive, sets the tag explicitly;
otherwise a new tag is selected automatically. Returns the tag of the disk.
return int
"""
......@@ -2183,7 +2187,11 @@ class model:
@staticmethod
def addSphere(xc,yc,zc,radius,tag=-1,angle1=-pi/2,angle2=pi/2,angle3=2*pi):
"""
TODO
Adds a sphere of center (`xc', `yc', `zc') and radius `r'. The optional
`angle1' and `angle2' arguments define the polar angle opening (from -Pi/2
to Pi/2). The optional `angle3' argument defines the azimuthal opening
(from 0 to 2*Pi). If `tag' is positive, sets the tag explicitly; otherwise
a new tag is selected automatically. Returns the tag of the sphere.
return int
"""
......@@ -2207,7 +2215,10 @@ class model:
@staticmethod
def addBox(x,y,z,dx,dy,dz,tag=-1):
"""
TODO
Adds a parallelepipedic box defined by a point (`x', `y', `z') and the
extents along the x-, y- and z-axes. If `tag' is positive, sets the tag
explicitly; otherwise a new tag is selected automatically. Returns the tag
of the box.
return int
"""
......@@ -2230,7 +2241,12 @@ class model:
@staticmethod
def addCylinder(x,y,z,dx,dy,dz,r,tag=-1,angle=2*pi):
"""
TODO
Adds a cylinder, defined by the center (`x', `y', `z') of its first
circular face, the 3 components (`dx', `dy', `dz') of the vector defining
its axis and its radius `r'. The optional `angle' argument defines the
angular opening (from 0 to 2*Pi). If `tag' is positive, sets the tag
explicitly; otherwise a new tag is selected automatically. Returns the tag
of the cylinder.
return int
"""
......@@ -2255,7 +2271,12 @@ class model:
@staticmethod
def addCone(x,y,z,dx,dy,dz,r1,r2,tag=-1,angle=2*pi):
"""
TODO
Add a cone, defined by the center (`x', `y', `z') of its first circular
face, the 3 components of the vector (`dx', `dy', `dz') defining its axis
and the two radii `r1' and `r2' of the faces (these radii can be zero). If
`tag' is positive, sets the tag explicitly; otherwise a new tag is selected
automatically. `angle' defines the optional angular opening (from 0 to
2*Pi). Returns the tag of the cone.
return int
"""
......@@ -2281,7 +2302,11 @@ class model:
@staticmethod
def addWedge(x,y,z,dx,dy,dz,tag=-1,ltx=0.):
"""
TODO
Add a right angular wedge, defined by the right-angle point (`x', `y', `z')
and the 3 extends along the x-, y- and z-axes (`dx', `dy', `dz'). If `tag'
is positive, sets the tag explicitly; otherwise a new tag is selected
automatically. The optional argument `ltx' defines the top extent along the
x-axis. Returns the tag of the wedge.
return int
"""
......@@ -2305,7 +2330,10 @@ class model:
@staticmethod
def addTorus(x,y,z,r1,r2,tag=-1,angle=2*pi):
"""
TODO
Adds a torus, defined by its center (`x', `y', `z') and its 2 radii `r' and
`r2'. If `tag' is positive, sets the tag explicitly; otherwise a new tag is
selected automatically. The optional argument `angle' defines the angular
opening (from 0 to 2*Pi). Returns the tag of the wedge.
return int
"""
......@@ -2328,7 +2356,12 @@ class model:
@staticmethod
def addThruSections(wireTags,tag=-1,makeSolid=True,makeRuled=False):
"""
TODO
Adds a volume (if the optional argument `makeSolid' is set) or surfaces
defined through the open or closed wires `wireTags'. If `tag' is positive,
sets the tag explicitly; otherwise a new tag is selected automatically. The
new entities are returned in `outDimTags'. If the optional argument
`makeRuled' is set, the surfaces created on the boundary are forced to be
ruled surfaces.
return int, outDimTags
"""
......@@ -2353,7 +2386,12 @@ class model:
@staticmethod
def addThickSolid(solidTag,excludeFaceTags,offset,tag=-1):
"""
TODO
Adds a hollowed volume built from an initial volume `solidTag' and a set of
faces from this volume `excludeFaceTags', which are to be removed. The
remaining faces of the volume become the walls of the hollowed solid, with
thickness `offset'. If `tag' is positive, sets the tag explicitly;
otherwise a new tag is selected automatically. Returns the tag of the
volume.
return int, outDimTags
"""
......@@ -2748,7 +2786,11 @@ class model:
@staticmethod
def importShapes(fileName,highestDimOnly=True,format=""):
"""
TODO
Imports BREP, STEP or IGES shapes from the file `fileName'. The imported
entities are returned in `outDimTags'. If the optional argument
`highestDimOnly' is set, only import the highest dimensional entities in
the file. The optional argument `format' can be used to force the format of
the file (currently "brep", "step" or "iges").
return outDimTags
"""
......
......@@ -41,9 +41,8 @@ GMSH_API void gmshInitialize(int argc, char ** argv,
/* Finalizes Gmsh. This must be called when you are done using the Gmsh API. */
GMSH_API void gmshFinalize(int * ierr);
/* Opens a file and adds one (or more) new model(s). Equivalent to the
* `File->Open' menu in the Gmsh app. Handling of the file depends on its
* extension and/or its contents. */
/* Opens a file. Equivalent to the `File->Open' menu in the Gmsh app. Handling
* of the file depends on its extension and/or its contents. */
GMSH_API void gmshOpen(const char * fileName,
int * ierr);
......@@ -799,7 +798,10 @@ GMSH_API int gmshModelOccAddLineLoop(int* edgeTags, size_t edgeTags_n,
const int tag,
int * ierr);
/* TODO */
/* Adds a rectangle with lower left corner at (`x', `y', `z') and upper right
* corner at (`x' + `dx', `y' + `dy', `z'). If `tag' is positive, sets the tag
* explicitly; otherwise a new tag is selected automatically. Rounds the
* corners if `roundedRadius' is nonzero. Returns the tag of the rectangle. */
GMSH_API int gmshModelOccAddRectangle(const double x,
const double y,
const double z,
......@@ -809,7 +811,9 @@ GMSH_API int gmshModelOccAddRectangle(const double x,
const double roundedRadius,
int * ierr);
/* TODO */
/* Adds a disk with center (`xc', `yc', `zc') and radius `rx' along the x-axis
* and `ry; along the y-axis. If `tag' is positive, sets the tag explicitly;
* otherwise a new tag is selected automatically. Returns the tag of the disk. */
GMSH_API int gmshModelOccAddDisk(const double xc,
const double yc,
const double zc,
......@@ -849,7 +853,11 @@ GMSH_API int gmshModelOccAddVolume(int* shellTags, size_t shellTags_n,
const int tag,
int * ierr);
/* TODO */
/* Adds a sphere of center (`xc', `yc', `zc') and radius `r'. The optional
* `angle1' and `angle2' arguments define the polar angle opening (from -Pi/2
* to Pi/2). The optional `angle3' argument defines the azimuthal opening
* (from 0 to 2*Pi). If `tag' is positive, sets the tag explicitly; otherwise
* a new tag is selected automatically. Returns the tag of the sphere. */
GMSH_API int gmshModelOccAddSphere(const double xc,
const double yc,
const double zc,
......@@ -860,7 +868,10 @@ GMSH_API int gmshModelOccAddSphere(const double xc,
const double angle3,
int * ierr);
/* TODO */
/* Adds a parallelepipedic box defined by a point (`x', `y', `z') and the
* extents along the x-, y- and z-axes. If `tag' is positive, sets the tag
* explicitly; otherwise a new tag is selected automatically. Returns the tag
* of the box. */
GMSH_API int gmshModelOccAddBox(const double x,
const double y,
const double z,
......@@ -870,7 +881,12 @@ GMSH_API int gmshModelOccAddBox(const double x,
const int tag,
int * ierr);
/* TODO */
/* Adds a cylinder, defined by the center (`x', `y', `z') of its first
* circular face, the 3 components (`dx', `dy', `dz') of the vector defining
* its axis and its radius `r'. The optional `angle' argument defines the
* angular opening (from 0 to 2*Pi). If `tag' is positive, sets the tag
* explicitly; otherwise a new tag is selected automatically. Returns the tag
* of the cylinder. */
GMSH_API int gmshModelOccAddCylinder(const double x,
const double y,
const double z,
......@@ -882,7 +898,12 @@ GMSH_API int gmshModelOccAddCylinder(const double x,
const double angle,
int * ierr);
/* TODO */
/* Add a cone, defined by the center (`x', `y', `z') of its first circular
* face, the 3 components of the vector (`dx', `dy', `dz') defining its axis
* and the two radii `r1' and `r2' of the faces (these radii can be zero). If
* `tag' is positive, sets the tag explicitly; otherwise a new tag is selected
* automatically. `angle' defines the optional angular opening (from 0 to
* 2*Pi). Returns the tag of the cone. */
GMSH_API int gmshModelOccAddCone(const double x,
const double y,
const double z,
......@@ -895,7 +916,11 @@ GMSH_API int gmshModelOccAddCone(const double x,
const double angle,
int * ierr);
/* TODO */
/* Add a right angular wedge, defined by the right-angle point (`x', `y', `z')
* and the 3 extends along the x-, y- and z-axes (`dx', `dy', `dz'). If `tag'
* is positive, sets the tag explicitly; otherwise a new tag is selected
* automatically. The optional argument `ltx' defines the top extent along the
* x-axis. Returns the tag of the wedge. */
GMSH_API int gmshModelOccAddWedge(const double x,
const double y,
const double z,
......@@ -906,7 +931,10 @@ GMSH_API int gmshModelOccAddWedge(const double x,
const double ltx,
int * ierr);
/* TODO */
/* Adds a torus, defined by its center (`x', `y', `z') and its 2 radii `r' and
* `r2'. If `tag' is positive, sets the tag explicitly; otherwise a new tag is
* selected automatically. The optional argument `angle' defines the angular
* opening (from 0 to 2*Pi). Returns the tag of the wedge. */
GMSH_API int gmshModelOccAddTorus(const double x,
const double y,
const double z,
......@@ -916,7 +944,12 @@ GMSH_API int gmshModelOccAddTorus(const double x,
const double angle,
int * ierr);
/* TODO */
/* Adds a volume (if the optional argument `makeSolid' is set) or surfaces
* defined through the open or closed wires `wireTags'. If `tag' is positive,
* sets the tag explicitly; otherwise a new tag is selected automatically. The
* new entities are returned in `outDimTags'. If the optional argument
* `makeRuled' is set, the surfaces created on the boundary are forced to be
* ruled surfaces. */
GMSH_API int gmshModelOccAddThruSections(int* wireTags, size_t wireTags_n,
int ** outDimTags, size_t * outDimTags_n,
const int tag,
......@@ -924,7 +957,12 @@ GMSH_API int gmshModelOccAddThruSections(int* wireTags, size_t wireTags_n,
const int makeRuled,
int * ierr);
/* TODO */
/* Adds a hollowed volume built from an initial volume `solidTag' and a set of
* faces from this volume `excludeFaceTags', which are to be removed. The
* remaining faces of the volume become the walls of the hollowed solid, with
* thickness `offset'. If `tag' is positive, sets the tag explicitly;
* otherwise a new tag is selected automatically. Returns the tag of the
* volume. */
GMSH_API int gmshModelOccAddThickSolid(const int solidTag,
int* excludeFaceTags, size_t excludeFaceTags_n,
const double offset,
......@@ -1081,7 +1119,11 @@ GMSH_API void gmshModelOccRemove(int * dimTags, size_t dimTags_n,
* dimensional entities. */
GMSH_API void gmshModelOccRemoveAllDuplicates(int * ierr);
/* TODO */
/* Imports BREP, STEP or IGES shapes from the file `fileName'. The imported
* entities are returned in `outDimTags'. If the optional argument
* `highestDimOnly' is set, only import the highest dimensional entities in
* the file. The optional argument `format' can be used to force the format of
* the file (currently "brep", "step" or "iges"). */
GMSH_API void gmshModelOccImportShapes(const char * fileName,
int ** outDimTags, size_t * outDimTags_n,
const int highestDimOnly,
......
......@@ -2112,7 +2112,7 @@ Creates a volume defined through line loops. @code{ThruSections} is only
available with the OpenCASCADE kernel.
@item Ruled ThruSections ( @var{expression} ) = @{ @var{expression-list} @};
Same as @code{ThruSections}, but the surfaces creates on the boundary
Same as @code{ThruSections}, but the surfaces created on the boundary
are forced to be ruled. @code{Ruled ThruSections} is only available with
the OpenCASCADE kernel.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment