Skip to content
Snippets Groups Projects
Commit 40c19a0d authored by Christophe Geuzaine's avatar Christophe Geuzaine
Browse files

small doc fixes
parent 0f03d485
No related branches found
No related tags found
No related merge requests found
// $Id: CutParametric.cpp,v 1.11 2005-03-02 07:49:41 geuzaine Exp $ // $Id: CutParametric.cpp,v 1.12 2005-03-02 08:14:29 geuzaine Exp $
// //
// Copyright (C) 1997-2005 C. Geuzaine, J.-F. Remacle // Copyright (C) 1997-2005 C. Geuzaine, J.-F. Remacle
// //
...@@ -76,13 +76,13 @@ void GMSH_CutParametricPlugin::getInfos(char *author, char *copyright, ...@@ -76,13 +76,13 @@ void GMSH_CutParametricPlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuzaine@acm.caltech.edu)"); strcpy(author, "C. Geuzaine (geuzaine@acm.caltech.edu)");
strcpy(copyright, "DGR (www.multiphysics.com)"); strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text, strcpy(help_text,
"Plugin(CutParametric) cuts the scalar view `iView'\n" "Plugin(CutParametric) cuts the view `iView' with\n"
"with the parametric function (`X'(u), `Y'(u), `Z'(u)),\n" "the parametric function (`X'(u), `Y'(u), `Z'(u)),\n"
"using `nPointsU' values of the parameter u in\n" "using `nPointsU' values of the parameter u in\n"
"[`MinU', `MaxU']. If `ConnectPoints' is set, the\n" "[`MinU', `MaxU']. If `ConnectPoints' is set, the\n"
"plugin creates scalar line elements; otherwise,\n" "plugin creates line elements; otherwise, the\n"
"the plugin generates scalar points. If `iView' < 0,\n" "plugin generates points. If `iView' < 0, the plugin\n"
"the plugin is run on the current view.\n" "is run on the current view.\n"
"\n" "\n"
"Plugin(CutParametric) creates one new view.\n"); "Plugin(CutParametric) creates one new view.\n");
} }
......
// $Id: Triangulate.cpp,v 1.27 2005-01-08 20:15:19 geuzaine Exp $ // $Id: Triangulate.cpp,v 1.28 2005-03-02 08:14:29 geuzaine Exp $
// //
// Copyright (C) 1997-2005 C. Geuzaine, J.-F. Remacle // Copyright (C) 1997-2005 C. Geuzaine, J.-F. Remacle
// //
...@@ -62,12 +62,11 @@ void GMSH_TriangulatePlugin::getInfos(char *author, char *copyright, ...@@ -62,12 +62,11 @@ void GMSH_TriangulatePlugin::getInfos(char *author, char *copyright,
strcpy(author, "C. Geuzaine (geuz@geuz.org)"); strcpy(author, "C. Geuzaine (geuz@geuz.org)");
strcpy(copyright, "DGR (www.multiphysics.com)"); strcpy(copyright, "DGR (www.multiphysics.com)");
strcpy(help_text, strcpy(help_text,
"Plugin(Triangulate) triangulates the points\n" "Plugin(Triangulate) triangulates the points in the\n"
"in the view `iView', assuming that all the\n" "view `iView', assuming that all the points belong\n"
"points belong to a surface that can be\n" "to a surface that can be projected one-to-one\n"
"projected into a plane in a one-to-one\n" "onto a plane. If `iView' < 0, the plugin is run on\n"
"fashion. If `iView' < 0, the plugin is run\n" "the current view.\n"
"on the current view.\n"
"\n" "\n"
"Plugin(Triangulate) creates one new view.\n"); "Plugin(Triangulate) creates one new view.\n");
} }
......
...@@ -58,9 +58,9 @@ and (`X2',`Y2',`Z2') (axis of V). The number of points ...@@ -58,9 +58,9 @@ and (`X2',`Y2',`Z2') (axis of V). The number of points
along U and V is set with the options `nPointsU' along U and V is set with the options `nPointsU'
and `nPointsV'. If `ConnectPoints' is zero, the and `nPointsV'. If `ConnectPoints' is zero, the
plugin creates points; otherwise, the plugin plugin creates points; otherwise, the plugin
generates quadrangles, lines or points depending on generates quadrangles, lines or points depending
the values of `nPointsU' and `nPointsV'. If `iView' < 0, on the values of `nPointsU' and `nPointsV'. If
the plugin is run on the current view. `iView' < 0, the plugin is run on the current view.
Plugin(CutGrid) creates one new view. Plugin(CutGrid) creates one new view.
...@@ -130,13 +130,13 @@ Default value: @code{-1} ...@@ -130,13 +130,13 @@ Default value: @code{-1}
@end table @end table
@item Plugin(CutParametric) @item Plugin(CutParametric)
Plugin(CutParametric) cuts the scalar view `iView' Plugin(CutParametric) cuts the view `iView' with
with the parametric function (`X'(u), `Y'(u), `Z'(u)), the parametric function (`X'(u), `Y'(u), `Z'(u)),
using `nPointsU' values of the parameter u in using `nPointsU' values of the parameter u in
[`MinU', `MaxU']. If `ConnectPoints' is set, the [`MinU', `MaxU']. If `ConnectPoints' is set, the
plugin creates scalar line elements; otherwise, the plugin creates line elements; otherwise, the
plugin generates scalar points. If `iView' < 0, the plugin generates points. If `iView' < 0, the plugin
plugin is run on the current view. is run on the current view.
Plugin(CutParametric) creates one new view. Plugin(CutParametric) creates one new view.
...@@ -317,8 +317,8 @@ view `iView' to the expression `Expression'. ...@@ -317,8 +317,8 @@ view `iView' to the expression `Expression'.
- the usual mathematical functions (Log, Sqrt - the usual mathematical functions (Log, Sqrt
Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^); Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^);
- the symbols x, y and z, to retrieve the coordinates - the symbols x, y and z, to retrieve the
of the current node; coordinates of the current node;
- the symbols Time and TimeStep, to retrieve the - the symbols Time and TimeStep, to retrieve the
current time and time step values; current time and time step values;
...@@ -333,11 +333,11 @@ component of the field in `iView' at the ...@@ -333,11 +333,11 @@ component of the field in `iView' at the
- the symbol w, to retrieve the `Component'-th - the symbol w, to retrieve the `Component'-th
component of the field in `ExternalView' at the component of the field in `ExternalView' at the
`ExternalTimeStep'-th time step. `ExternalView' and `ExternalTimeStep'-th time step. `ExternalView'
`iView' must be of the same type (scalar, vector and `iView' must be of the same type (scalar,
or tensor); if `ExternalView' and `iView' are not vector or tensor); if `ExternalView' and `iView'
based on the same spatial grid, `ExternalView' is are not based on the same spatial grid,
interpolated onto `iView'; `ExternalView' is interpolated onto `iView';
- the symbols w0, w1, w2, ..., w8, to retrieve each - the symbols w0, w1, w2, ..., w8, to retrieve each
component of the field in `ExternalView' at the component of the field in `ExternalView' at the
...@@ -492,8 +492,8 @@ Default value: @code{-1} ...@@ -492,8 +492,8 @@ Default value: @code{-1}
@item Plugin(Probe) @item Plugin(Probe)
Plugin(Probe) gets the value of the view `iView' at Plugin(Probe) gets the value of the view `iView' at
the point (`X',`Y',`Z'). If `iView' < 0, the plugin the point (`X',`Y',`Z'). If `iView' < 0, the plugin is
is run on the current view. run on the current view.
Plugin(Probe) creates one new view. Plugin(Probe) creates one new view.
...@@ -706,12 +706,11 @@ Default value: @code{-1} ...@@ -706,12 +706,11 @@ Default value: @code{-1}
@end table @end table
@item Plugin(Triangulate) @item Plugin(Triangulate)
Plugin(Triangulate) triangulates the points Plugin(Triangulate) triangulates the points in the
in the view `iView', assuming that all the view `iView', assuming that all the points belong
points belong to a surface that can be to a surface that can be projected one-to-one
projected into a plane in a one-to-one onto a plane. If `iView' < 0, the plugin is run on
fashion. If `iView' < 0, the plugin is run the current view.
on the current view.
Plugin(Triangulate) creates one new view. Plugin(Triangulate) creates one new view.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment