ForkMaster/netgenplugin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Restore documentation of methods dynamically added by plug-ins to the Mesh class, killed by previous integration

Browse Source
This commit is contained in:
vsr 2013-04-05 10:47:52 +00:00
parent b9a1fa194f
commit 1e54d14b39
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/NETGENPlugin/NETGENPluginBuilder.py
View File

@ -172,7 +172,7 @@ class NETGEN_Algorithm(Mesh_Algorithm):
## Tetrahedron 1D-2D-3D algorithm.
#
# It can be created by calling smeshBuilder.Mesh.Tetrahedron( smesh.NETGEN_1D2D3D, geom=0 ).
# It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.NETGEN_1D2D3D, geom=0 ).
# This algorithm generates all 1D (edges), 2D (faces) and 3D (volumes) elements
# for given geometrical shape.
class NETGEN_1D2D3D_Algorithm(NETGEN_Algorithm):
@ -262,7 +262,7 @@ class NETGEN_1D2D3D_Algorithm(NETGEN_Algorithm):
## Triangle NETGEN 1D-2D algorithm.
#
# It can be created by calling smeshBuilder.Mesh.Triangle( smesh.NETGEN_1D2D, geom=0 )
# It can be created by calling smeshBuilder.Mesh.Triangle( smeshBuilder.NETGEN_1D2D, geom=0 )
#
# This algorithm generates 1D (edges) and 2D (faces) elements
# for given geometrical shape.
@ -291,7 +291,7 @@ class NETGEN_1D2D_Algorithm(NETGEN_1D2D3D_Algorithm):
## Triangle NETGEN 2D algorithm
#
# It can be created by calling smeshBuilder.Mesh.Triangle( smesh.NETGEN_2D, geom=0 )
# It can be created by calling smeshBuilder.Mesh.Triangle( smeshBuilder.NETGEN_2D, geom=0 )
#
# This algorithm generates only 2D (faces) elements for given geometrical shape
# and, in contrast to NETGEN_1D2D_Algorithm class, should be used in conjunction
@ -368,7 +368,7 @@ class NETGEN_2D_Only_Algorithm(NETGEN_Algorithm):
## Tetrahedron 3D algorithm
#
# It can be created by calling smeshBuilder.Mesh.Tetrahedron() or smeshBuilder.Mesh.Tetrahedron( smesh.NETGEN, geom=0 )
# It can be created by calling smeshBuilder.Mesh.Tetrahedron() or smeshBuilder.Mesh.Tetrahedron( smeshBuilder.NETGEN, geom=0 )
#
# This algorithm generates only 3D (volumes) elements for given geometrical shape
# and, in contrast to NETGEN_1D2D3D_Algorithm class, should be used in conjunction
@ -415,11 +415,11 @@ class NETGEN_3D_Algorithm(NETGEN_Algorithm):
## Triangle (helper) 1D-2D algorithm
#
# This is the helper class that is used just to allow creating of create NETGEN_1D2D algorithm
# by calling smeshBuilder.Mesh.Triangle( smesh.NETGEN, geom=0 ); this is required for backward compatibility
# by calling smeshBuilder.Mesh.Triangle( smeshBuilder.NETGEN, geom=0 ); this is required for backward compatibility
# with old Python scripts.
#
# @note This class (and corresponding smeshBuilder.Mesh function) is obsolete;
# use smeshBuilder.Mesh.Triangle( smesh.NETGEN_1D2D, geom=0 ) instead.
# use smeshBuilder.Mesh.Triangle( smeshBuilder.NETGEN_1D2D, geom=0 ) instead.
class NETGEN_1D2D_Algorithm_2(NETGEN_1D2D_Algorithm):
## name of the dynamic method in smeshBuilder.Mesh class
@ -444,7 +444,7 @@ class NETGEN_1D2D_Algorithm_2(NETGEN_1D2D_Algorithm):
# by calling smeshBuilder.Mesh.Netgen(); this is required for backward compatibility with old Python scripts.
#
# @note This class (and corresponding smeshBuilder.Mesh function) is obsolete;
# use smeshBuilder.Mesh.Tetrahedron( smesh.NETGEN_1D2D3D, geom=0 ) instead.
# use smeshBuilder.Mesh.Tetrahedron( smeshBuilder.NETGEN_1D2D3D, geom=0 ) instead.
class NETGEN_1D2D3D_Algorithm_2(NETGEN_1D2D3D_Algorithm):
## name of the dynamic method in smeshBuilder.Mesh class