diff --git a/Fltk/pluginWindow.cpp b/Fltk/pluginWindow.cpp index c8bc3ccca97458d431e8a17a4749f13a03182a59..cfe954c56083c6be826b011ca024d5a45ce7a2ee 100644 --- a/Fltk/pluginWindow.cpp +++ b/Fltk/pluginWindow.cpp @@ -284,8 +284,9 @@ void pluginWindow::_createDialogBox(GMSH_Plugin *p, int x, int y, o->add(" "); add_multiline_in_browser(o, "", p->getHelp().c_str(), false); o->add(" "); - add_multiline_in_browser(o, "Author: ", p->getAuthor().c_str(), false); - add_multiline_in_browser(o, "Copyright (C) ", p->getCopyright().c_str(), + o->add(" "); + add_multiline_in_browser(o, "@i@.Author: ", p->getAuthor().c_str(), false); + add_multiline_in_browser(o, "@i@.Copyright (C) ", p->getCopyright().c_str(), false); o->add(" "); diff --git a/Plugin/Annotate.cpp b/Plugin/Annotate.cpp index 7f9a7f09f59e9261d97b61d720e2aa872569b4d2..91bf2cdbb2eedb45451943dccdf4935dcf2d8929 100644 --- a/Plugin/Annotate.cpp +++ b/Plugin/Annotate.cpp @@ -178,17 +178,19 @@ std::string GMSH_AnnotatePlugin::callbackAlign(int num, int action, std::string std::string GMSH_AnnotatePlugin::getHelp() const { return "Plugin(Annotate) adds the text string `Text',\n" - "in font `Font' and size `FontSize', in the view\n" - "`View'. If `ThreeD' is equal to 1, the plugin inserts\n" - "the string in model coordinates at the position\n" - "(`X',`Y',`Z'). If `ThreeD' is equal to 0, the plugin\n" - "inserts the string in screen coordinates at\n" - "the position (`X',`Y'). The string is aligned\n" - "according to `Align'. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(Annotate) is executed in-place for list-based\n" - "datasets or creates a new view for other datasets.\n"; + "in font `Font' and size `FontSize', in the view\n" + "`View'. The string is aligned according to `Align'.\n" + "\n" + "If `ThreeD' is equal to 1, the plugin inserts\n" + "the string in model coordinates at the position\n" + "(`X',`Y',`Z'). If `ThreeD' is equal to 0, the plugin\n" + "inserts the string in screen coordinates at\n" + "the position (`X',`Y').\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Annotate) is executed in-place for list-based\n" + "datasets or creates a new view for other datasets.\n"; } int GMSH_AnnotatePlugin::getNbOptions() const diff --git a/Plugin/Curl.cpp b/Plugin/Curl.cpp index 9769bf9636a3d577b1684033f6f989a6f734f63d..ea24e78d1dae4faefb118d7eefa3567d71a01422 100644 --- a/Plugin/Curl.cpp +++ b/Plugin/Curl.cpp @@ -22,10 +22,11 @@ extern "C" std::string GMSH_CurlPlugin::getHelp() const { return "Plugin(Curl) computes the curl of the field\n" - "in the view `View'. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(Curl) creates one new view.\n"; + "in the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Curl) creates one new view.\n"; } int GMSH_CurlPlugin::getNbOptions() const diff --git a/Plugin/CutGrid.cpp b/Plugin/CutGrid.cpp index 3cbdcc28c435b126165397a0ab169436505d9048..82b34726fed3d1e44618487822a20153e206efb7 100644 --- a/Plugin/CutGrid.cpp +++ b/Plugin/CutGrid.cpp @@ -168,18 +168,21 @@ double GMSH_CutGridPlugin::callbackConnect(int num, int action, double value) std::string GMSH_CutGridPlugin::getHelp() const { return "Plugin(CutGrid) cuts the view `View' with a\n" - "rectangular grid defined by the 3 points\n" - "(`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') (axis of\n" - "U) and (`X2',`Y2',`Z2') (axis of V). The number of\n" - "points along U and V is set with the options\n" - "`NumPointsU' and `NumPointsV'. If `ConnectPoints' is\n" - "zero, the plugin creates points; otherwise, the\n" - "plugin generates quadrangles, lines or points\n" - " depending on the values of `NumPointsU' and\n" - "`NumPointsV'. If `View' < 0, the plugin is run on\n" - "the current view.\n" - "\n" - "Plugin(CutGrid) creates one new view.\n"; + "rectangular grid defined by the 3 points\n" + "(`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') (axis of U)\n" + "and (`X2',`Y2',`Z2') (axis of V).\n" + "\n" + "The number of points along U and V is set with the\n" + "options `NumPointsU' and `NumPointsV'.\n" + "\n" + "If `ConnectPoints' is zero, the plugin creates points;\n" + "otherwise, the plugin generates quadrangles, lines or\n" + "points depending on the values of `NumPointsU' and\n" + "`NumPointsV'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(CutGrid) creates one new view.\n"; } int GMSH_CutGridPlugin::getNbOptions() const diff --git a/Plugin/CutParametric.cpp b/Plugin/CutParametric.cpp index ed694f558d888aa9f7723f7016d015e51d0125b0..d26295620683372dcca1d36d59a63e549c7bd95d 100644 --- a/Plugin/CutParametric.cpp +++ b/Plugin/CutParametric.cpp @@ -168,14 +168,16 @@ std::string GMSH_CutParametricPlugin::callbackZ(int num, int action, std::string std::string GMSH_CutParametricPlugin::getHelp() const { return "Plugin(CutParametric) cuts the view `View' with\n" - "the parametric function (`X'(u), `Y'(u), `Z'(u)),\n" - "using `NumPointsU' values of the parameter u in\n" - "[`MinU', `MaxU']. If `ConnectPoints' is set, the\n" - "plugin creates line elements; otherwise, the\n" - "plugin generates points. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(CutParametric) creates one new view.\n"; + "the parametric function (`X'(u), `Y'(u), `Z'(u)),\n" + "using `NumPointsU' values of the parameter u in\n" + "[`MinU', `MaxU'].\n" + "\n" + "If `ConnectPoints' is set, the plugin creates line\n" + "elements; otherwise, the plugin generates points.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(CutParametric) creates one new view.\n"; } int GMSH_CutParametricPlugin::getNbOptions() const diff --git a/Plugin/CutPlane.cpp b/Plugin/CutPlane.cpp index babca5c29968d3f7741d7b4950a925f8bc215e53..f08d75360bf047e4eb0d4d80e05ac35334d1b3be 100644 --- a/Plugin/CutPlane.cpp +++ b/Plugin/CutPlane.cpp @@ -113,13 +113,15 @@ double GMSH_CutPlanePlugin::callbackTarget(int num, int action, double value) std::string GMSH_CutPlanePlugin::getHelp() const { return "Plugin(CutPlane) cuts the view `View' with\n" - "the plane `A'*X + `B'*Y + `C'*Z + `D' = 0. If\n" - "`ExtractVolume' is nonzero, the plugin extracts\n" - "the elements on one side of the plane (depending\n" - "on the sign of `ExtractVolume'). If `View' < 0,\n" - "the plugin is run on the current view.\n" - "\n" - "Plugin(CutPlane) creates one new view.\n"; + "the plane `A'*X + `B'*Y + `C'*Z + `D' = 0.\n" + "\n" + "If `ExtractVolume' is nonzero, the plugin extracts\n" + "the elements on one side of the plane (depending\n" + "on the sign of `ExtractVolume'). \n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(CutPlane) creates one new view.\n"; } int GMSH_CutPlanePlugin::getNbOptions() const diff --git a/Plugin/CutSphere.cpp b/Plugin/CutSphere.cpp index 26fddbc230bdcb3361109df6f6316d95a6674b90..5ae4b6b966bca336f9401c577def9bdd38b9c659 100644 --- a/Plugin/CutSphere.cpp +++ b/Plugin/CutSphere.cpp @@ -110,13 +110,15 @@ double GMSH_CutSpherePlugin::callbackTarget(int num, int action, double value) std::string GMSH_CutSpherePlugin::getHelp() const { return "Plugin(CutSphere) cuts the view `View' with the\n" - "sphere (X-`Xc')^2 + (Y-`Yc')^2 + (Z-`Zc')^2 = `R'^2.\n" - "If `ExtractVolume' is nonzero, the plugin extracts\n" - "the elements inside (if `ExtractVolume' < 0) or\n" - "outside (if `ExtractVolume' > 0) the sphere. If\n" - "`View' < 0, the plugin is run on the current view.\n" - "\n" - "Plugin(CutSphere) creates one new view.\n"; + "sphere (X-`Xc')^2 + (Y-`Yc')^2 + (Z-`Zc')^2 = `R'^2.\n" + "\n" + "If `ExtractVolume' is nonzero, the plugin extracts\n" + "the elements inside (if `ExtractVolume' < 0) or\n" + "outside (if `ExtractVolume' > 0) the sphere.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(CutSphere) creates one new view.\n"; } int GMSH_CutSpherePlugin::getNbOptions() const diff --git a/Plugin/Divergence.cpp b/Plugin/Divergence.cpp index a66b297fae1d3ba607016d4c1d8c3c0c7021d0c0..f122ba430c153becc3a2834a5e686efd927b239d 100644 --- a/Plugin/Divergence.cpp +++ b/Plugin/Divergence.cpp @@ -22,10 +22,11 @@ extern "C" std::string GMSH_DivergencePlugin::getHelp() const { return "Plugin(Divergence) computes the divergence of the\n" - "field in the view `View'. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(Divergence) creates one new view.\n"; + "field in the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Divergence) creates one new view.\n"; } int GMSH_DivergencePlugin::getNbOptions() const diff --git a/Plugin/Eigenvalues.cpp b/Plugin/Eigenvalues.cpp index cbda98ec737dd4cc11a08c1aedd7eb9a008400cf..820cdc355fbeffc6514f7a19af79e6c1ee330b2a 100644 --- a/Plugin/Eigenvalues.cpp +++ b/Plugin/Eigenvalues.cpp @@ -22,10 +22,11 @@ extern "C" std::string GMSH_EigenvaluesPlugin::getHelp() const { return "Plugin(Eigenvalues) computes the three real\n" - "eigenvalues of each tensor in the view `View'.\n" - "If `View' < 0, the plugin is run on the current view.\n" - "\n" - "Plugin(Eigenvalues) creates three new scalar views.\n"; + "eigenvalues of each tensor in the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Eigenvalues) creates three new scalar views.\n"; } int GMSH_EigenvaluesPlugin::getNbOptions() const diff --git a/Plugin/Eigenvectors.cpp b/Plugin/Eigenvectors.cpp index 73c923301ac06d707a74216fc7341242b71cef23..61a061193233294ef8699705cbedc4bbb0a88f96 100644 --- a/Plugin/Eigenvectors.cpp +++ b/Plugin/Eigenvectors.cpp @@ -24,16 +24,17 @@ extern "C" std::string GMSH_EigenvectorsPlugin::getHelp() const { return "Plugin(Eigenvectors) computes the three (right)\n" - "eigenvectors of each tensor in the view `View'\n" - "and sorts them according to the value of the\n" - "associated eigenvalues. If `ScaleByEigenvalues'\n" - "is set, each eigenvector is scaled by its\n" - "associated eigenvalue. The plugin gives an error\n" - "if the eigenvectors are complex. If `View' < 0,\n" - "the plugin is run on the current view.\n" - "\n" - "Plugin(Eigenvectors) creates three new\n" - "vector views.\n"; + "eigenvectors of each tensor in the view `View'\n" + "and sorts them according to the value of the\n" + "associated eigenvalues.\n" + "\n" + "If `ScaleByEigenvalues' is set, each eigenvector is\n" + "scaled by its associated eigenvalue. The plugin\n" + "gives an error if the eigenvectors are complex.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Eigenvectors) creates three new vector view.\n"; } int GMSH_EigenvectorsPlugin::getNbOptions() const diff --git a/Plugin/ExtractElements.cpp b/Plugin/ExtractElements.cpp index 667c079310d25d49bf8ee0c2f1a2214355229320..92f6b667db8f8b5272abe41b964db57488f666a8 100644 --- a/Plugin/ExtractElements.cpp +++ b/Plugin/ExtractElements.cpp @@ -26,12 +26,13 @@ extern "C" std::string GMSH_ExtractElementsPlugin::getHelp() const { return "Plugin(ExtractElements) extracts the elements\n" - "from the view `View' whose `TimeStep'-th values\n" - "(averaged by element) are comprised between\n" - "`MinVal' and `MaxVal'. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(ExtractElements) creates one new view.\n"; + "from the view `View' whose `TimeStep'-th values\n" + "(averaged by element) are comprised between\n" + "`MinVal' and `MaxVal'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(ExtractElements) creates one new view.\n"; } int GMSH_ExtractElementsPlugin::getNbOptions() const diff --git a/Plugin/GSHHS.cpp b/Plugin/GSHHS.cpp index 004b60aaf530ee71623fdbae079df040daaa4763..6aee543602f1b2af3d893fb730cf687c73c211b6 100644 --- a/Plugin/GSHHS.cpp +++ b/Plugin/GSHHS.cpp @@ -920,38 +920,54 @@ std::string GMSH_GSHHSPlugin::getHelp() const return "Plugin(GSHHS) read different kind of contour lines data\n" "and write a .geo file on the surface of a sphere (the Earth).\n" + "\n" "The principal application is to load GSHHS data\n (see\n" "http://www.soest.hawaii.edu/wessel/gshhs/gshhs.html).\n" - "Valid values for \"Format\" are ):\n" - " -\"gshhs\" : open GSHHS file\n" - " -\"loops2\" : import 2D contour lines in simple text format :\n" + "\n" + "Valid values for \"Format\" are:\n" + "\n" + "- \"gshhs\": open GSHHS file\n" + "\n" + "- \"loops2\": import 2D contour lines in simple text format:\n" " NB_POINTS_IN_FIRST_LOOP FIRST_LOOP_IS_CLOSED\n" " COORD1 COORD2\n" " COORD1 COORD2\n" " ... ...\n" " NB_POINTS_IN_SECOND_LOOP SECOND_LOOP_IS_CLOSED\n" " ...\n" - " (LOOP_IS_CLOSED specify if this coast line describe a closed curve\n" - " (0=no, 1=yes).\n" - "In the case of \"loops2\" format, you can specify the the coordinate\n" - "system used in the input file with the \"Coordinate\" option, valid\n" - "values are\n" - " -\"lonlat\" for longitude-latidute radian,\n" - " -\"lonlat_degrees\" for longitude-latitude degrees,\n" - " -\"UTM\" for universal transverse mercartor (\"UTMZone\" option should\n" - " be specified)\n" - " -\"cartesian\" for full 3D coordinates\n" - " -\"radius\" specify the earth radius.\n" - "If the \"iField\" option is set, consecutive points closer than the\n" - "value of the field iField (in meters) will not be added.\n" - "If \"MinStraitsFactor\" >0 and if a field iField is provided, coastlines\n" - "closer than MinStraitsFactor*field(IField) are merged and inner corners\n" - " which form an angle < pi/3 are removed.\n" - "The output is always in stereographic coordinates, if the \"WritePolarSphere\"\n" - "option is not 0, a sphere is added to the geo file.\n" - "WARNING : this plugin is still experimental and need polishing and\n" - "error-handling. In particular, it will probably crash if an inexistant\n" - "field id is given or if the input/output cannot be open.\n"; + "(LOOP_IS_CLOSED specify if this coast line describe a closed\n" + "curve (0=no, 1=yes). In the case of \"loops2\" format, you\n" + "can specify the the coordinate system used in the input file\n" + "with the \"Coordinate\" option, valid values are\n" + "\n" + "- \"lonlat\" for longitude-latidute radian,\n" + "\n" + "- \"lonlat_degrees\" for longitude-latitude degrees,\n" + "\n" + "- \"UTM\" for universal transverse mercartor (\"UTMZone\"\n" + "option should be specified)\n" + "\n" + "- \"cartesian\" for full 3D coordinates\n" + "\n" + "- \"radius\" specify the earth radius.\n" + "\n" + "If the \"iField\" option is set, consecutive points closer\n" + "than the value of the field iField (in meters) will not be\n" + "added.\n" + "\n" + "If \"MinStraitsFactor\" > 0 and if a field iField is\n" + "provided, coastlines closer than MinStraitsFactor *\n" + "field(IField) are merged and inner corners which form an\n" + "angle < pi/3 are removed.\n" + "\n" + "The output is always in stereographic coordinates, if\n" + "the \"WritePolarSphere\" option is not 0, a sphere is\n" + "added to the geo file.\n" + "\n" + "WARNING: this plugin is still experimental and needs\n" + "polishing and error-handling. In particular, it will\n" + "probably crash if an inexistant field id is given or if\n" + "the input/output cannot be open.\n"; } int GMSH_GSHHSPlugin::getNbOptions() const diff --git a/Plugin/Gradient.cpp b/Plugin/Gradient.cpp index b8ebe08380dd4bc674cd058aa500693d587eab72..982e2f5b5d578cca18ba273a289626534efa6d41 100644 --- a/Plugin/Gradient.cpp +++ b/Plugin/Gradient.cpp @@ -22,10 +22,11 @@ extern "C" std::string GMSH_GradientPlugin::getHelp() const { return "Plugin(Gradient) computes the gradient of the\n" - "field in the view `View'. If `View' < 0, the\n" - "plugin is run on the current view.\n" - "\n" - "Plugin(Gradient) creates one new view.\n"; + "field in the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Gradient) creates one new view.\n"; } int GMSH_GradientPlugin::getNbOptions() const diff --git a/Plugin/HarmonicToTime.cpp b/Plugin/HarmonicToTime.cpp index 59cb1245414bb5e94a0fe08c75edbbd3f689244b..26c00a1714fa835008cb7ddcf1b081a5ad4c25a3 100644 --- a/Plugin/HarmonicToTime.cpp +++ b/Plugin/HarmonicToTime.cpp @@ -24,15 +24,17 @@ extern "C" std::string GMSH_HarmonicToTimePlugin::getHelp() const { return "Plugin(HarmonicToTime) takes the values in the\n" - "time steps `RealPart' and `ImaginaryPart' of\n" - "the view `View', and creates a new view\n" - "containing (`View'[`RealPart'] * cos(p) -\n" - "`View'[`ImaginaryPart'] * sin(p)), with\n" - "p = 2*Pi*k/`NumSteps', k = 0, ..., `NumSteps'-1.\n" - "If `View' < 0, the plugin is run on the\n" - "current view.\n" - "\n" - "Plugin(HarmonicToTime) creates one new view.\n"; + "time steps `RealPart' and `ImaginaryPart' of\n" + "the view `View', and creates a new view\n" + "containing\n" + "\n" + "`View'[`RealPart'] * cos(p) - `View'[`ImaginaryPart'] * sin(p)\n" + "\n" + "with p = 2*Pi*k/`NumSteps', k = 0, ..., `NumSteps'-1.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(HarmonicToTime) creates one new view.\n"; } int GMSH_HarmonicToTimePlugin::getNbOptions() const diff --git a/Plugin/HomologyComputation.cpp b/Plugin/HomologyComputation.cpp index 523744929cad12599d1c16b261b46bb37c6c64af..5f8df11d08f2ea61b2c880b62f652b19d101c902 100644 --- a/Plugin/HomologyComputation.cpp +++ b/Plugin/HomologyComputation.cpp @@ -39,10 +39,10 @@ extern "C" std::string GMSH_HomologyComputationPlugin::getHelp() const { - return "Plugin(Homology) computes generators \n" - "for (relative) homology groups and their thick cuts. \n" - "\n" - "Plugin(Homology) creates new views.\n"; + return "Plugin(Homology) computes generators for\n" + "(relative) homology groups and their thick cuts.\n" + "\n" + "Plugin(Homology) creates new views.\n"; } int GMSH_HomologyComputationPlugin::getNbOptions() const diff --git a/Plugin/Integrate.cpp b/Plugin/Integrate.cpp index d76c0ab1ea2f414159b5f70738228bb26df2afa1..4ed7d5559a63437857f0d9b82402048ee8774105 100644 --- a/Plugin/Integrate.cpp +++ b/Plugin/Integrate.cpp @@ -22,12 +22,13 @@ extern "C" std::string GMSH_IntegratePlugin::getHelp() const { return "Plugin(Integrate) integrates scalar fields over\n" - "all the elements in the view `View', as well\n" - "as the circulation/flux of vector fields over\n" - "line/surface elements. If `View' < 0, the\n" - "plugin is run on the current view.\n" - "\n" - "Plugin(Integrate) creates one new view.\n"; + "all the elements in the view `View', as well\n" + "as the circulation/flux of vector fields over\n" + "line/surface elements.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Integrate) creates one new view.\n"; } int GMSH_IntegratePlugin::getNbOptions() const diff --git a/Plugin/Isosurface.cpp b/Plugin/Isosurface.cpp index d658b42f5054265da3d47a29172f8eede093e8f1..d08a1cdb03552f1505477ff24b9c2d7762ba8867 100644 --- a/Plugin/Isosurface.cpp +++ b/Plugin/Isosurface.cpp @@ -80,20 +80,24 @@ double GMSH_IsosurfacePlugin::callbackTarget(int num, int action, double value) std::string GMSH_IsosurfacePlugin::getHelp() const { return "Plugin(Isosurface) extracts the isosurface of value\n" - "`Value' from the view `View', and draws the\n" - "`OtherTimeStep'-th step of the view `OtherView' on\n" - "this isosurface. If `View' < 0, the plugin is run\n" - "on the current view. If `OtherTimeStep' < 0, the\n" - "plugin uses, for each time step in `View', the\n" - "corresponding time step in `OtherView'. If `OtherView'\n" - "< 0, the plugin uses `View' as the value source.\n" - "If `ExtractVolume' is nonzero, the plugin\n" - "extracts the isovolume with values greater (if\n" - "`ExtractVolume' > 0) or smaller (if `ExtractVolume'\n" - "< 0) than the isosurface `Value'.\n" - "\n" - "Plugin(Isosurface) creates as many views as there\n" - "are time steps in `View'.\n"; + "`Value' from the view `View', and draws the\n" + "`OtherTimeStep'-th step of the view `OtherView' on\n" + "this isosurface.\n" + "\n" + "If `ExtractVolume' is nonzero, the plugin extracts the\n" + "isovolume with values greater (if `ExtractVolume' > 0)\n" + "or smaller (if `ExtractVolume' < 0) than the isosurface\n" + "`Value'.\n" + "\n" + "If `OtherTimeStep' < 0, the plugin uses, for each time\n" + "step in `View', the corresponding time step in `OtherView'.\n" + "If `OtherView' < 0, the plugin uses `View' as the value\n" + "source.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Isosurface) creates as many views as there are\n" + "time steps in `View'.\n"; } int GMSH_IsosurfacePlugin::getNbOptions() const diff --git a/Plugin/Lambda2.cpp b/Plugin/Lambda2.cpp index 36c238b4461757537c6e7cfef1f0394a66961932..474b88443f0621cb8bbabf0b49ba0d3837713b0f 100644 --- a/Plugin/Lambda2.cpp +++ b/Plugin/Lambda2.cpp @@ -22,21 +22,25 @@ extern "C" std::string GMSH_Lambda2Plugin::getHelp() const { return "Plugin(Lambda2) computes the eigenvalues\n" - "Lambda(1,2,3) of the tensor (S_ik S_kj +\n" - "Om_ik Om_kj), where S_ij = 0.5 (ui,j + uj,i)\n" - "and Om_ij = 0.5 (ui,j - uj,i) are respectively\n" - "the symmetric and antisymmetric parts of the\n" - "velocity gradient tensor. Vortices are well\n" - "represented by regions where Lambda(2) is\n" - "negative. If `View' contains tensor elements,\n" - "the plugin directly uses the tensors as the\n" - "values of the velocity gradient tensor; if\n" - "`View' contains vector elements, the plugin\n" - "uses them as the velocities from which to derive\n" - "the velocity gradient tensor. If `View' < 0,\n" - "the plugin is run on the current view.\n" - "\n" - "Plugin(Lambda2) creates one new view.\n"; + "Lambda(1,2,3) of the tensor (S_ik S_kj +\n" + "Om_ik Om_kj), where S_ij = 0.5 (ui,j + uj,i)\n" + "and Om_ij = 0.5 (ui,j - uj,i) are respectively\n" + "the symmetric and antisymmetric parts of the\n" + "velocity gradient tensor.\n" + "\n" + "Vortices are well represented by regions where\n" + "Lambda(2) is negative.\n" + "\n" + "If `View' contains tensor elements, the plugin\n" + "directly uses the tensors as the values of the\n" + "velocity gradient tensor; if `View' contains\n" + "vector elements, the plugin uses them as the\n" + "velocities from which to derive the velocity\n" + "gradient tensor.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Lambda2) creates one new view.\n"; } int GMSH_Lambda2Plugin::getNbOptions() const diff --git a/Plugin/LongitudeLatitude.cpp b/Plugin/LongitudeLatitude.cpp index da383f49e10013070e5158a2875e9990141a156e..f0e4efb99b87a832ca55769bd349337044459746 100644 --- a/Plugin/LongitudeLatitude.cpp +++ b/Plugin/LongitudeLatitude.cpp @@ -21,10 +21,11 @@ extern "C" std::string GMSH_LongituteLatitudePlugin::getHelp() const { return "Plugin(LongituteLatitude) projects the view `View'\n" - "in longitude-latitude. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(LongituteLatitude) is executed in place.\n"; + "in longitude-latitude.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(LongituteLatitude) is executed in place.\n"; } int GMSH_LongituteLatitudePlugin::getNbOptions() const diff --git a/Plugin/MakeSimplex.cpp b/Plugin/MakeSimplex.cpp index d64a521a2936b7f6b072f59a6dec814ecec85716..96ed85dc1983304191d3656d232ac92a7cf7a3ae 100644 --- a/Plugin/MakeSimplex.cpp +++ b/Plugin/MakeSimplex.cpp @@ -20,13 +20,13 @@ extern "C" std::string GMSH_MakeSimplexPlugin::getHelp() const { return "Plugin(MakeSimplex) decomposes all non-\n" - "simplectic elements (quadrangles, prisms,\n" - "hexahedra, pyramids) in the view `View' into\n" - "simplices (triangles, tetrahedra). If `View' < 0,\n" - "the plugin is run on the current view.\n" - "\n" - "Plugin(MakeSimplex) is executed\n" - "in-place.\n"; + "simplectic elements (quadrangles, prisms,\n" + "hexahedra, pyramids) in the view `View' into\n" + "simplices (triangles, tetrahedra).\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(MakeSimplex) is executed in-place.\n"; } int GMSH_MakeSimplexPlugin::getNbOptions() const diff --git a/Plugin/MathEval.cpp b/Plugin/MathEval.cpp index c99cf0a25d36fd1a5a4fc2987e6a46e90960d1c5..8d9483492548ae172e7695efc749a4e8939f6dfb 100644 --- a/Plugin/MathEval.cpp +++ b/Plugin/MathEval.cpp @@ -39,28 +39,37 @@ extern "C" std::string GMSH_MathEvalPlugin::getHelp() const { return "Plugin(MathEval) creates a new view using\n" - "data from the time step `TimeStep' in the view\n" - "`View'. If only `Expression0' is given\n" - "(and `Expression1', ..., `Expression8' are all\n" - "empty), the plugin creates a scalar view.\n" - "If `Expression0', `Expression1' and/or\n" - "`Expression2' are given (and `Expression3',\n" - "..., `Expression8' are all empty) the plugin\n" - "creates a vector view. Otherwise the plugin\n" - "creates a tensor view. In addition to the usual\n" - "mathematical functions (Exp, Log, Sqrt, Sin, Cos,\n" - "Fabs, etc.) and operators (+, -, *, /, ^), all\n" - "expressions can contain the symbols v0, v1, v2,\n" - "..., vn, which represent the n components in\n" - "`View'; w0, w1, w2,..., wn, which represent the n\n" - "components of `OtherView' (at time step `OtherTimeStep');\n" - "and the symbols x, y and z, which represent the three\n" - "spatial coordinates. If `TimeStep' < 0, the plugin\n" - "extracts data from all the time steps in the view.\n" - "If `View' < 0, the plugin is run on the current\n" - "view.\n" - "\n" - "Plugin(MathEval) creates one new view.\n"; + "data from the time step `TimeStep' in the view\n" + "`View'.\n" + "\n" + "If only `Expression0' is given (and `Expression1',\n" + "..., `Expression8' are all empty), the plugin\n" + "creates a scalar view. If `Expression0', `Expression1'\n" + "and/or `Expression2' are given (and `Expression3',\n" + "..., `Expression8' are all empty) the plugin creates\n" + "a vector view. Otherwise the plugin creates a tensor\n" + "view.\n" + "\n" + "In addition to the usual mathematical functions\n" + "(Exp, Log, Sqrt, Sin, Cos, Fabs, etc.) and operators\n" + "(+, -, *, /, ^), all expressions can contain:\n" + "\n" + "- the symbols v0, v1, v2, ..., vn, which represent\n" + "the n components in `View';\n" + "\n" + "- the symbols w0, w1, w2, ..., wn, which represent\n" + "the n components of `OtherView', at time step\n" + "`OtherTimeStep';\n" + "\n" + "- the symbols x, y and z, which represent the three\n" + "spatial coordinates.\n" + "\n" + "If `TimeStep' < 0, the plugin extracts data from all\n" + "the time steps in the view.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(MathEval) creates one new view.\n"; } int GMSH_MathEvalPlugin::getNbOptions() const diff --git a/Plugin/ModifyComponent.cpp b/Plugin/ModifyComponent.cpp index 110ec99f1f5b9a096be1baa1fb0020de24d003e1..1d112ced881e5e83229eeadfa93c91b624414eed 100644 --- a/Plugin/ModifyComponent.cpp +++ b/Plugin/ModifyComponent.cpp @@ -32,50 +32,55 @@ extern "C" std::string GMSH_ModifyComponentPlugin::getHelp() const { return "Plugin(ModifyComponent) sets the `Component'-th\n" - "component of the `TimeStep'-th time step in the\n" - "view `View' to the expression `Expression'.\n" - "`Expression' can contain:\n" - "\n" - "- the usual mathematical functions (Log, Sqrt,\n" - "Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^);\n" - "\n" - "- the symbols x, y and z, to retrieve the\n" - "coordinates of the current node;\n" - "\n" - "- the symbols Time and TimeStep, to retrieve the\n" - "current time and time step values;\n" - "\n" - "- the symbol v, to retrieve the `Component'-th\n" - "component of the field in `View' at the\n" - "`TimeStep'-th time step;\n" - "\n" - "- the symbols v0, v1, v2, ..., v8, to retrieve each\n" - "component of the field in `View' at the\n" - "`TimeStep'-th time step;\n" - "\n" - "- the symbol w, to retrieve the `Component'-th\n" - "component of the field in `OtherView' at the\n" - "`OtherTimeStep'-th time step. If `OtherView'\n" - "and `View' are based on different spatial grids,\n" - "or if their data types are different, `OtherView'\n" - "is interpolated onto `View';\n" - "\n" - "- the symbols w0, w1, w2, ..., w8, to retrieve each\n" - "component of the field in `OtherView' at the\n" - "`OtherTimeStep'-th time step.\n" - "\n" - "If `TimeStep' < 0, the plugin automatically loops\n" - "over all the time steps in `View' and evaluates\n" - "`Expression' for each one. If `OtherTimeStep'\n" - "< 0, the plugin uses `TimeStep' instead. If\n" - "`Component' < 0, the plugin automatically loops\n" - "over all the components in the view and\n" - "evaluates `Expression' for each one. If `View'\n" - "< 0, the plugin is run on the current view. If\n" - "`OtherView' < 0, the plugin uses `View'\n" - "instead.\n" - "\n" - "Plugin(ModifyComponent) is executed in-place.\n"; + "component of the `TimeStep'-th time step in the\n" + "view `View' to the expression `Expression'.\n" + "\n" + "`Expression' can contain:\n" + "\n" + "- the usual mathematical functions (Log, Sqrt,\n" + "Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^);\n" + "\n" + "- the symbols x, y and z, to retrieve the\n" + "coordinates of the current node;\n" + "\n" + "- the symbols Time and TimeStep, to retrieve the\n" + "current time and time step values;\n" + "\n" + "- the symbol v, to retrieve the `Component'-th\n" + "component of the field in `View' at the\n" + "`TimeStep'-th time step;\n" + "\n" + "- the symbols v0, v1, v2, ..., v8, to retrieve each\n" + "component of the field in `View' at the\n" + "`TimeStep'-th time step;\n" + "\n" + "- the symbol w, to retrieve the `Component'-th\n" + "component of the field in `OtherView' at the\n" + "`OtherTimeStep'-th time step. If `OtherView'\n" + "and `View' are based on different spatial grids,\n" + "or if their data types are different, `OtherView'\n" + "is interpolated onto `View';\n" + "\n" + "- the symbols w0, w1, w2, ..., w8, to retrieve each\n" + "component of the field in `OtherView' at the\n" + "`OtherTimeStep'-th time step.\n" + "\n" + "If `TimeStep' < 0, the plugin automatically loops\n" + "over all the time steps in `View' and evaluates\n" + "`Expression' for each one.\n" + "\n" + "If `OtherTimeStep' < 0, the plugin uses `TimeStep'\n" + "instead.\n" + "\n" + "If `Component' < 0, the plugin automatically loops\n" + "over all the components in the view and\n" + "evaluates `Expression' for each one.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "If `OtherView' < 0, the plugin uses `View' instead.\n" + "\n" + "Plugin(ModifyComponent) is executed in-place.\n"; } int GMSH_ModifyComponentPlugin::getNbOptions() const diff --git a/Plugin/ModulusPhase.cpp b/Plugin/ModulusPhase.cpp index 08d3dd53f813ba71440465afd79cbdf5d02c3934..b7616004301c71ad3244602a0b0b38c7da53e074 100644 --- a/Plugin/ModulusPhase.cpp +++ b/Plugin/ModulusPhase.cpp @@ -22,13 +22,14 @@ extern "C" std::string GMSH_ModulusPhasePlugin::getHelp() const { return "Plugin(ModulusPhase) interprets the time steps\n" - "`realPart' and `imaginaryPart' in the view `View'\n" - "as the real and imaginary parts of a complex field\n" - "and replaces them with their corresponding\n" - "modulus and phase. If `View' < 0, the plugin is\n" - "run on the current view.\n" - "\n" - "Plugin(ModulusPhase) is executed in-place.\n"; + "`realPart' and `imaginaryPart' in the view `View'\n" + "as the real and imaginary parts of a complex field\n" + "and replaces them with their corresponding\n" + "modulus and phase.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(ModulusPhase) is executed in-place.\n"; } int GMSH_ModulusPhasePlugin::getNbOptions() const diff --git a/Plugin/Particles.cpp b/Plugin/Particles.cpp index 5b6616168ada2f195c23e42746a29815965cb8a8..5486db4c4e8ceee61499f08a2620d113778900c3 100644 --- a/Plugin/Particles.cpp +++ b/Plugin/Particles.cpp @@ -151,19 +151,27 @@ std::string GMSH_ParticlesPlugin::getHelp() const "Plugin(Particles) computes the trajectory\n" "of particules in the force field given by the\n" "`TimeStep'-th time step of a vector view\n" - "`View'. The plugin takes as input a grid defined\n" - "by the 3 points (`X0',`Y0',`Z0') (origin),\n" - "(`X1',`Y1',`Z1') (axis of U) and (`X2',`Y2',`Z2')\n" - "(axis of V). The number of particles along U and V\n" - "that are to be transported is set with the\n" - "options `NumPointsU' and `NumPointsV'. The equation\n" - "A2*d^2X(t)/dt^2+A1*dX(t)/dt+A0*X(t)=F is then\n" - "solved with the initial conditions X(t=0) chosen\n" - "as the grid, dX/dt(t=0)=0, and with F\n" - "interpolated from the vector view. Time stepping\n" - "is done using a Newmark scheme with step size `DT'\n" - "and `MaxIter' maximum number of iterations. If\n" - "`View' < 0 the plugin is run on the current view.\n" + "`View'.\n" + "\n" + "The plugin takes as input a grid defined by the\n" + "3 points (`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1')\n" + "(axis of U) and (`X2',`Y2',`Z2') (axis of V).\n" + "\n" + "The number of particles along U and V that are to\n" + "be transported is set with the options `NumPointsU'\n" + "and `NumPointsV'. The equation\n" + "\n" + "A2 * d^2X(t)/dt^2 + A1 * dX(t)/dt + A0 * X(t) = F\n" + "\n" + "is then solved with the initial conditions X(t=0)\n" + "chosen as the grid, dX/dt(t=0)=0, and with F\n" + "interpolated from the vector view.\n" + "\n" + "Time stepping is done using a Newmark scheme with\n" + "step size `DT' and `MaxIter' maximum number of\n" + "iterations.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" "\n" "Plugin(Particles) creates one new view containing\n" "multi-step vector points.\n"; diff --git a/Plugin/Probe.cpp b/Plugin/Probe.cpp index 8c879a2e1a691a1bc502c45590a8b652b7f93b53..6dd63be0cf3a442f54d4544a248dfb94aa5d154e 100644 --- a/Plugin/Probe.cpp +++ b/Plugin/Probe.cpp @@ -98,10 +98,11 @@ double GMSH_ProbePlugin::callbackZ(int num, int action, double value) std::string GMSH_ProbePlugin::getHelp() const { return "Plugin(Probe) gets the value of the view `View' at\n" - "the point (`X',`Y',`Z'). If `View' < 0, the plugin is\n" - "run on the current view.\n" - "\n" - "Plugin(Probe) creates one new view.\n"; + "the point (`X',`Y',`Z').\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Probe) creates one new view.\n"; } int GMSH_ProbePlugin::getNbOptions() const diff --git a/Plugin/Probe.h b/Plugin/Probe.h index 43a7eb6f43f6d76019d50795eab45d2d62e1fa3d..6287a585cc76d5e8b9758c5a7165f08a12d9f329 100644 --- a/Plugin/Probe.h +++ b/Plugin/Probe.h @@ -23,7 +23,7 @@ class GMSH_ProbePlugin : public GMSH_PostPlugin std::string getName() const { return "Probe"; } std::string getShortHelp() const { - return "Get value of a view at one given point"; + return "Get value at point (X, Y, Z)"; } std::string getHelp() const; int getNbOptions() const; diff --git a/Plugin/Remove.cpp b/Plugin/Remove.cpp index 24be57a9a7e60d2eb89d476f212e9db57056b15b..c57c0b7bd56dcd17276f287273f73957f392c761 100644 --- a/Plugin/Remove.cpp +++ b/Plugin/Remove.cpp @@ -33,10 +33,11 @@ extern "C" std::string GMSH_RemovePlugin::getHelp() const { return "Plugin(Remove) removes the marked items\n" - "from the view `View'. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(Remove) is executed in-place.\n"; + "from the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Remove) is executed in-place.\n"; } int GMSH_RemovePlugin::getNbOptions() const diff --git a/Plugin/Skin.cpp b/Plugin/Skin.cpp index 4d4e7b4b0971815e4e9eedca15f82b29fd5cad35..29f771f76c454a13e8f9d5189261d3919050dade 100644 --- a/Plugin/Skin.cpp +++ b/Plugin/Skin.cpp @@ -22,11 +22,12 @@ extern "C" std::string GMSH_SkinPlugin::getHelp() const { - return "Plugin(Skin) extracts the skin (the boundary) of\n" - "the view `View'. If `View' < 0, the plugin is run\n" - "on the current view.\n" - "\n" - "Plugin(Skin) creates one new view.\n"; + return "Plugin(Skin) extracts the boundary (skin) of\n" + "the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Skin) creates one new view.\n"; } int GMSH_SkinPlugin::getNbOptions() const diff --git a/Plugin/Smooth.cpp b/Plugin/Smooth.cpp index d15b5354ee6a8357496b32ac56877645d733fc42..be078aef4c1317e7824f3c9c38231089bea1037e 100644 --- a/Plugin/Smooth.cpp +++ b/Plugin/Smooth.cpp @@ -20,10 +20,11 @@ extern "C" std::string GMSH_SmoothPlugin::getHelp() const { return "Plugin(Smooth) averages the values at the nodes\n" - "of the scalar view `View'. If `View' < 0, the\n" - "plugin is run on the current view.\n" - "\n" - "Plugin(Smooth) is executed in-place.\n"; + "of the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Smooth) is executed in-place.\n"; } int GMSH_SmoothPlugin::getNbOptions() const diff --git a/Plugin/SphericalRaise.cpp b/Plugin/SphericalRaise.cpp index 38313d7baa5ed213321e227cb5ecc25ae7a51f8f..22ef42e0c3f5bfb450a97c123bda5c41adcce9bf 100644 --- a/Plugin/SphericalRaise.cpp +++ b/Plugin/SphericalRaise.cpp @@ -27,20 +27,23 @@ extern "C" std::string GMSH_SphericalRaisePlugin::getHelp() const { return "Plugin(SphericalRaise) transforms the\n" - "coordinates of the elements in the view\n" - "`View' using the values associated with the\n" - "`TimeStep'-th time step. Instead of elevating\n" - "the nodes along the X, Y and Z axes as in\n" - "View[`View'].RaiseX, View[`View'].RaiseY\n" - "and View[`View'].RaiseZ, the raise is applied\n" - " along the radius of a sphere centered at\n" - "(`Xc', `Yc', `Zc'). To produce a standard\n" - "radiation pattern, set `Offset' to minus the\n" - "radius of the sphere the original data lives on.\n" - "If `View' < 0, the plugin is run on the current\n" - "view.\n" - "\n" - "Plugin(SphericalRaise) is executed in-place.\n"; + "coordinates of the elements in the view\n" + "`View' using the values associated with the\n" + "`TimeStep'-th time step.\n" + "\n" + "Instead of elevating the nodes along the X, Y\n" + "and Z axes as with the View[`View'].RaiseX,\n" + "View[`View'].RaiseY and View[`View'].RaiseZ\n" + "options, the raise is applied along the radius\n" + "of a sphere centered at (`Xc', `Yc', `Zc').\n" + "\n" + "To produce a standard radiation pattern, set\n" + "`Offset' to minus the radius of the sphere the\n" + "original data lives on.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(SphericalRaise) is executed in-place.\n"; } int GMSH_SphericalRaisePlugin::getNbOptions() const diff --git a/Plugin/StreamLines.cpp b/Plugin/StreamLines.cpp index 5f4825fd119603cd66ba6921a4937231bcdf697c..1ba674940035471784ed5ef82cc6b23f83f6dbf6 100644 --- a/Plugin/StreamLines.cpp +++ b/Plugin/StreamLines.cpp @@ -139,27 +139,36 @@ double GMSH_StreamLinesPlugin::callbackV(int num, int action, double value) std::string GMSH_StreamLinesPlugin::getHelp() const { return "Plugin(StreamLines) computes stream lines\n" - "from the `TimeStep'-th time step of a vector\n" - "view `View' and optionally interpolates the\n" - "scalar view `OtherView' on the resulting stream\n" - "lines. The plugin takes as input a grid defined\n" - "by the 3 points (`X0',`Y0',`Z0') (origin),\n" - "(`X1',`Y1',`Z1') (axis of U) and (`X2',`Y2',`Z2')\n" - "(axis of V). The number of points along U and V\n" - "that are to be transported is set with the\n" - "options `NumPointsU' and `NumPointsV'. The equation\n" - "dX(t)/dt=V(x,y,z) is then solved with the initial\n" - "condition X(t=0) chosen as the grid and with V(x,y,z)\n" - "interpolated on the vector view. The time stepping\n" - "scheme is a RK44 with step size `DT' and `MaxIter'\n" - "maximum number of iterations. If `View' < 0, the\n" - "plugin is run on the current view. If `TimeStep' < 0,\n" - "the plugin tries to compute streamlines of the unsteady\n" - "flow.\n" - "\n" - "Plugin(StreamLines) creates one new view. This\n" - "view contains multi-step vector points if `OtherView'\n" - "< 0, or single-step scalar lines if `OtherView' >= 0.\n"; + "from the `TimeStep'-th time step of a vector\n" + "view `View' and optionally interpolates the\n" + "scalar view `OtherView' on the resulting stream\n" + "lines.\n" + "\n" + "The plugin takes as input a grid defined by the\n" + "3 points (`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1')\n" + "(axis of U) and (`X2',`Y2',`Z2') (axis of V).\n" + "\n" + "The number of points along U and V that are to be\n" + "transported is set with the options `NumPointsU'\n" + "and `NumPointsV'. The equation\n" + "\n" + "dX(t)/dt = V(x,y,z)\n" + "\n" + "is then solved with the initial condition X(t=0)\n" + "chosen as the grid and with V(x,y,z) interpolated\n" + "on the vector view.\n" + "\n" + "The time stepping scheme is a RK44 with step size\n" + "`DT' and `MaxIter' maximum number of iterations.\n" + "\n" + "If `TimeStep' < 0, the plugin tries to compute\n" + "streamlines of the unsteady flow.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(StreamLines) creates one new view. This\n" + "view contains multi-step vector points if `OtherView'\n" + "< 0, or single-step scalar lines if `OtherView' >= 0.\n"; } int GMSH_StreamLinesPlugin::getNbOptions() const diff --git a/Plugin/Tetrahedralize.cpp b/Plugin/Tetrahedralize.cpp index 3599fab72677167e2cc67c84c4c6169abb0b0899..b14d9a4aaa77f6841059f620af7742cde1e7d431 100644 --- a/Plugin/Tetrahedralize.cpp +++ b/Plugin/Tetrahedralize.cpp @@ -26,11 +26,12 @@ extern "C" std::string GMSH_TetrahedralizePlugin::getHelp() const { - return "Plugin(Tetrahedralize) tetrahedralizes the points in the\n" - "view `View'. If `View' < 0, the plugin is run on\n" - "the current view.\n" - "\n" - "Plugin(Tetrahedralize) creates one new view.\n"; + return "Plugin(Tetrahedralize) tetrahedralizes the points in\n" + "the view `View'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Tetrahedralize) creates one new view.\n"; } int GMSH_TetrahedralizePlugin::getNbOptions() const diff --git a/Plugin/Transform.cpp b/Plugin/Transform.cpp index 3e45ca79c57f0e960ec8a5060a7e1542aceb3077..563d057ab0f7786834f288f652fd74bcb03ed39b 100644 --- a/Plugin/Transform.cpp +++ b/Plugin/Transform.cpp @@ -33,16 +33,19 @@ extern "C" std::string GMSH_TransformPlugin::getHelp() const { return "Plugin(Transform) transforms the homogeneous\n" - "node coordinates (x,y,z,1) of the elements in\n" - "the view `View' by the matrix\n" - "[`A11' `A12' `A13' `Tx']\n" - "[`A21' `A22' `A23' `Ty']\n" - "[`A31' `A32' `A33' `Tz'].\n" - "If `SwapOrientation' is set, the orientation of the\n" - "elements is reversed. If `View' < 0, the plugin\n" - "is run on the current view.\n" - "\n" - "Plugin(Transform) is executed in-place.\n"; + "node coordinates (x,y,z,1) of the elements in\n" + "the view `View' by the matrix\n" + "\n" + "[`A11' `A12' `A13' `Tx']\n" + "[`A21' `A22' `A23' `Ty']\n" + "[`A31' `A32' `A33' `Tz'].\n" + "\n" + "If `SwapOrientation' is set, the orientation of the\n" + "elements is reversed.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Transform) is executed in-place.\n"; } int GMSH_TransformPlugin::getNbOptions() const diff --git a/Plugin/Triangulate.cpp b/Plugin/Triangulate.cpp index a9db837dc12f1660c2d980362e14f30dbdc8f020..3730d05b05239840d20a6773b4bd0aefa49ee3ba 100644 --- a/Plugin/Triangulate.cpp +++ b/Plugin/Triangulate.cpp @@ -28,12 +28,13 @@ extern "C" std::string GMSH_TriangulatePlugin::getHelp() const { return "Plugin(Triangulate) triangulates the points in the\n" - "view `View', assuming that all the points belong\n" - "to a surface that can be projected one-to-one\n" - "onto a plane. If `View' < 0, the plugin is run on\n" - "the current view.\n" - "\n" - "Plugin(Triangulate) creates one new view.\n"; + "view `View', assuming that all the points belong\n" + "to a surface that can be projected one-to-one\n" + "onto a plane.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "Plugin(Triangulate) creates one new view.\n"; } int GMSH_TriangulatePlugin::getNbOptions() const diff --git a/Plugin/Warp.cpp b/Plugin/Warp.cpp index 90bedb82834bec23fe7f75338eda39a463577b53..3ac3951bb764b186c4b0c4b35c0ab39c977b3a6a 100644 --- a/Plugin/Warp.cpp +++ b/Plugin/Warp.cpp @@ -26,17 +26,19 @@ extern "C" std::string GMSH_WarpPlugin::getHelp() const { return "Plugin(Warp) transforms the elements in the\n" - "view `View' by adding to their node coordinates\n" - "the vector field stored in the `TimeStep'-th time\n" - "step of the view `OtherView', scaled by `Factor'. If\n" - "`OtherView' < 0, the vector field is taken as the field\n" - "of surface normals multiplied by the `TimeStep'\n" - "value in `View'. (The smoothing of the surface\n" - "normals is controlled by the `SmoothingAngle'\n" - "parameter.) If `View' < 0, the plugin is run on\n" - "the current view.\n" - "\n" - "Plugin(Warp) is executed in-place.\n"; + "view `View' by adding to their node coordinates\n" + "the vector field stored in the `TimeStep'-th time\n" + "step of the view `OtherView', scaled by `Factor'.\n" + "\n" + "If `View' < 0, the plugin is run on the current view.\n" + "\n" + "If `OtherView' < 0, the vector field is taken as the\n" + "field of surface normals multiplied by the `TimeStep'\n" + "value in `View'. (The smoothing of the surface\n" + "normals is controlled by the `SmoothingAngle'\n" + "parameter.)\n" + "\n" + "Plugin(Warp) is executed in-place.\n"; } int GMSH_WarpPlugin::getNbOptions() const diff --git a/doc/texinfo/opt_fields.texi b/doc/texinfo/opt_fields.texi index fccf36bd010f8bab546e12f286ac04ebafe2262c..6bfea3c35636beee6fb86d4d0e1767ad408c54f6 100644 --- a/doc/texinfo/opt_fields.texi +++ b/doc/texinfo/opt_fields.texi @@ -21,11 +21,11 @@ give strange results for complex surfaces)@* type: list@* default value: @code{@{@}} @item NNodesByEdge -Number of nodes used to discetized each curve@* +Number of nodes used to discretized each curve@* type: integer@* default value: @code{20} @item NodesList -Indices of nodes in the geomtric model@* +Indices of nodes in the geometric model@* type: list@* default value: @code{@{@}} @end table diff --git a/doc/texinfo/opt_general.texi b/doc/texinfo/opt_general.texi index 4a41aab655a87d5035edcfff25ddd82729d95ddd..48da2b3da1c2612b74027da611cd25898fbcde05 100644 --- a/doc/texinfo/opt_general.texi +++ b/doc/texinfo/opt_general.texi @@ -74,6 +74,31 @@ Option file created with `Tools->Options->Save'; automatically read on startup@* Default value: @code{".gmsh-options"}@* Saved in: @code{General.SessionFileName} +@item General.RecentFile1 +Most recent opened file@* +Default value: @code{""}@* +Saved in: @code{General.SessionFileName} + +@item General.RecentFile2 +2nd most recent opened file@* +Default value: @code{""}@* +Saved in: @code{General.SessionFileName} + +@item General.RecentFile3 +3rd most recent opened file@* +Default value: @code{""}@* +Saved in: @code{General.SessionFileName} + +@item General.RecentFile4 +4th most recent opened file@* +Default value: @code{""}@* +Saved in: @code{General.SessionFileName} + +@item General.RecentFile5 +5th most recent opened file@* +Default value: @code{""}@* +Saved in: @code{General.SessionFileName} + @item General.SessionFileName Option file into which session specific information is saved; automatically read on startup@* Default value: @code{".gmshrc"}@* diff --git a/doc/texinfo/opt_mesh.texi b/doc/texinfo/opt_mesh.texi index ef8b0a0d4dfd9fdb88940b561406f3faf554540d..06cf7e20ba5e1d4577f63c608785937d286abd6c 100644 --- a/doc/texinfo/opt_mesh.texi +++ b/doc/texinfo/opt_mesh.texi @@ -56,7 +56,7 @@ Saved in: @code{General.OptionsFileName} @item Mesh.ChacoHypercubeDim (Adv. Chaco): Dimensional partitioning for a hypercube topology@* -Default value: @code{2}@* +Default value: @code{0}@* Saved in: @code{General.OptionsFileName} @item Mesh.ChacoLocalMethod @@ -66,7 +66,7 @@ Saved in: @code{General.OptionsFileName} @item Mesh.ChacoMeshDim1 (Adv. Chaco): Number of partitions in the first dimension of a mesh topology@* -Default value: @code{4}@* +Default value: @code{1}@* Saved in: @code{General.OptionsFileName} @item Mesh.ChacoMeshDim2 @@ -266,7 +266,12 @@ Saved in: @code{General.OptionsFileName} @item Mesh.MshFileVersion Version of the MSH file format to use@* -Default value: @code{2.1}@* +Default value: @code{2.2}@* +Saved in: @code{General.OptionsFileName} + +@item Mesh.MshFilePartitioned +Split MSH file by mesh partition@* +Default value: @code{0}@* Saved in: @code{General.OptionsFileName} @item Mesh.NbHexahedra @@ -281,7 +286,7 @@ Saved in: @code{-} @item Mesh.NbPartitions Number of partitions@* -Default value: @code{4}@* +Default value: @code{1}@* Saved in: @code{General.OptionsFileName} @item Mesh.NbPrisms @@ -429,6 +434,11 @@ Save parametric coordinates of nodes@* Default value: @code{0}@* Saved in: @code{General.OptionsFileName} +@item Mesh.SaveDistance +Save distance of nodes to boundaries@* +Default value: @code{0}@* +Saved in: @code{General.OptionsFileName} + @item Mesh.SaveGroupsOfNodes Save groups of nodes for each physical line and surface (UNV mesh format only)@* Default value: @code{0}@* diff --git a/doc/texinfo/opt_plugin.texi b/doc/texinfo/opt_plugin.texi index 4f2a404cbfd60b7a63adfb6a9fae0c9795ee4d5d..33aefd78075bf47efaeadaf67349a81ac6ce6c85 100644 --- a/doc/texinfo/opt_plugin.texi +++ b/doc/texinfo/opt_plugin.texi @@ -7,13 +7,15 @@ @item Plugin(Annotate) Plugin(Annotate) adds the text string `Text', in font `Font' and size `FontSize', in the view -`iView'. If `ThreeD' is equal to 1, the plugin inserts +`View'. The string is aligned according to `Align'. + +If `ThreeD' is equal to 1, the plugin inserts the string in model coordinates at the position (`X',`Y',`Z'). If `ThreeD' is equal to 0, the plugin inserts the string in screen coordinates at -the position (`X',`Y'). The string is aligned -according to `Align'. If `iView' < 0, the plugin -is run on the current view. +the position (`X',`Y'). + +If `View' < 0, the plugin is run on the current view. Plugin(Annotate) is executed in-place for list-based datasets or creates a new view for other datasets. @@ -35,39 +37,43 @@ Default value: @code{50} Default value: @code{30} @item Z Default value: @code{0} -@item ThereD +@item ThreeD Default value: @code{0} @item FontSize Default value: @code{14} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Curl) Plugin(Curl) computes the curl of the field -in the view `iView'. If `iView' < 0, the plugin -is run on the current view. +in the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Curl) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(CutGrid) -Plugin(CutGrid) cuts the view `iView' with a +Plugin(CutGrid) cuts the view `View' with a rectangular grid defined by the 3 points -(`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') (axis of -U) and (`X2',`Y2',`Z2') (axis of V). The number of -points along U and V is set with the options -`nPointsU' and `nPointsV'. If `ConnectPoints' is -zero, the plugin creates points; otherwise, the -plugin generates quadrangles, lines or points - depending on the values of `nPointsU' and -`nPointsV'. If `iView' < 0, the plugin is run on -the current view. +(`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') (axis of U) +and (`X2',`Y2',`Z2') (axis of V). + +The number of points along U and V is set with the +options `NumPointsU' and `NumPointsV'. + +If `ConnectPoints' is zero, the plugin creates points; +otherwise, the plugin generates quadrangles, lines or +points depending on the values of `NumPointsU' and +`NumPointsV'. + +If `View' < 0, the plugin is run on the current view. Plugin(CutGrid) creates one new view. @@ -91,68 +97,35 @@ Default value: @code{0} Default value: @code{1} @item Z2 Default value: @code{0} -@item nPointsU +@item NumPointsU Default value: @code{20} -@item nPointsV +@item NumPointsV Default value: @code{20} @item ConnectPoints Default value: @code{1} -@item iView -Default value: @code{-1} -@end table - -@item Plugin(CutMap) -Plugin(CutMap) extracts the isosurface of value -`A' from the view `iView' and draws the -`dTimeStep'-th value of the view `dView' on the -isosurface. If `iView' < 0, the plugin is run -on the current view. If `dTimeStep' < 0, the -plugin uses, for each time step in `iView', the -corresponding time step in `dView'. If `dView' -< 0, the plugin uses `iView' as the value source. -If `ExtractVolume' is nonzero, the plugin -extracts the isovolume with values greater (if -`ExtractVolume' > 0) or smaller (if `ExtractVolume' -< 0) than the isosurface `A'. - -Plugin(CutMap) creates as many views as there -are time steps in `iView'. - -Numeric options: -@table @code -@item A -Default value: @code{0} -@item dTimeStep -Default value: @code{-1} -@item dView -Default value: @code{-1} -@item ExtractVolume -Default value: @code{0} -@item RecurLevel -Default value: @code{4} -@item TargetError -Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(CutParametric) -Plugin(CutParametric) cuts the view `iView' with +Plugin(CutParametric) cuts the view `View' with the parametric function (`X'(u), `Y'(u), `Z'(u)), -using `nPointsU' values of the parameter u in -[`MinU', `MaxU']. If `ConnectPoints' is set, the -plugin creates line elements; otherwise, the -plugin generates points. If `iView' < 0, the plugin -is run on the current view. +using `NumPointsU' values of the parameter u in +[`MinU', `MaxU']. + +If `ConnectPoints' is set, the plugin creates line +elements; otherwise, the plugin generates points. + +If `View' < 0, the plugin is run on the current view. Plugin(CutParametric) creates one new view. String options: @table @code @item X -Default value: @code{"0 + 1 * Cos(u)"} +Default value: @code{"0.1 + 0.5 * Cos(u)"} @item Y -Default value: @code{"0 + 1 * Sin(u)"} +Default value: @code{"0.1 + 0.5 * Sin(u)"} @item Z Default value: @code{"0"} @end table @@ -162,21 +135,23 @@ Numeric options: Default value: @code{0} @item MaxU Default value: @code{6.2832} -@item nPointsU +@item NumPointsU Default value: @code{360} @item ConnectPoints Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(CutPlane) -Plugin(CutPlane) cuts the view `iView' with -the plane `A'*X + `B'*Y + `C'*Z + `D' = 0. If -`ExtractVolume' is nonzero, the plugin extracts +Plugin(CutPlane) cuts the view `View' with +the plane `A'*X + `B'*Y + `C'*Z + `D' = 0. + +If `ExtractVolume' is nonzero, the plugin extracts the elements on one side of the plane (depending -on the sign of `ExtractVolume'). If `iView' < 0, -the plugin is run on the current view. +on the sign of `ExtractVolume'). + +If `View' < 0, the plugin is run on the current view. Plugin(CutPlane) creates one new view. @@ -196,17 +171,19 @@ Default value: @code{0} Default value: @code{4} @item TargetError Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(CutSphere) -Plugin(CutSphere) cuts the view `iView' with the +Plugin(CutSphere) cuts the view `View' with the sphere (X-`Xc')^2 + (Y-`Yc')^2 + (Z-`Zc')^2 = `R'^2. + If `ExtractVolume' is nonzero, the plugin extracts the elements inside (if `ExtractVolume' < 0) or -outside (if `ExtractVolume' > 0) the sphere. If -`iView' < 0, the plugin is run on the current view. +outside (if `ExtractVolume' > 0) the sphere. + +If `View' < 0, the plugin is run on the current view. Plugin(CutSphere) creates one new view. @@ -224,181 +201,69 @@ Default value: @code{0.25} Default value: @code{0} @item RecurLevel Default value: @code{4} -@item iView +@item TargetError +Default value: @code{0} +@item View Default value: @code{-1} @end table @item Plugin(Divergence) Plugin(Divergence) computes the divergence of the -field in the view `iView'. If `iView' < 0, the plugin -is run on the current view. +field in the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Divergence) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Eigenvalues) Plugin(Eigenvalues) computes the three real -eigenvalues of each tensor in the view `iView'. -If `iView' < 0, the plugin is run on the current view. +eigenvalues of each tensor in the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Eigenvalues) creates three new scalar views. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Eigenvectors) Plugin(Eigenvectors) computes the three (right) -eigenvectors of each tensor in the view `iView' +eigenvectors of each tensor in the view `View' and sorts them according to the value of the -associated eigenvalues. If `ScaleByEigenvalues' -is set, each eigenvector is scaled by its -associated eigenvalue. The plugin gives an error -if the eigenvectors are complex. If `iView' < 0, -the plugin is run on the current view. - -Plugin(Eigenvectors) creates three new -vector views. +associated eigenvalues. -Numeric options: -@table @code -@item ScaleByEigenvalues -Default value: @code{1} -@item iView -Default value: @code{-1} -@end table - -@item Plugin(Evaluate) -Plugin(Evaluate) sets the `Component'-th -component of the `TimeStep'-th time step in the -view `iView' to the expression `Expression'. -`Expression' can contain: - -- the usual mathematical functions (Log, Sqrt, -Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^); - -- the symbols x, y and z, to retrieve the -coordinates of the current node; - -- the symbols Time and TimeStep, to retrieve the -current time and time step values; - -- the symbol v, to retrieve the `Component'-th -component of the field in `iView' at the -`TimeStep'-th time step; - -- the symbols v0, v1, v2, ..., v8, to retrieve each -component of the field in `iView' at the -`TimeStep'-th time step; - -- the symbol w, to retrieve the `Component'-th -component of the field in `ExternalView' at the -`ExternalTimeStep'-th time step. If `ExternalView' -and `iView' are based on different spatial grids, -or if their data types are different, `ExternalView' -is interpolated onto `iView'; - -- the symbols w0, w1, w2, ..., w8, to retrieve each -component of the field in `ExternalView' at the -`ExternalTimeStep'-th time step. - -If `TimeStep' < 0, the plugin automatically loops -over all the time steps in `iView' and evaluates -`Expression' for each one. If `ExternalTimeStep' -< 0, the plugin uses `TimeStep' instead. If -`Component' < 0, the plugin automatically loops -over all the components in the view and -evaluates `Expression' for each one. If `iView' -< 0, the plugin is run on the current view. If -`ExternalView' < 0, the plugin uses `iView' -instead. - -Plugin(Evaluate) is executed in-place. - -String options: -@table @code -@item Expression -Default value: @code{"v0*Sin(x)"} -@end table -Numeric options: -@table @code -@item Component -Default value: @code{-1} -@item TimeStep -Default value: @code{-1} -@item ExternalView -Default value: @code{-1} -@item ExternalTimeStep -Default value: @code{-1} -@item iView -Default value: @code{-1} -@end table +If `ScaleByEigenvalues' is set, each eigenvector is +scaled by its associated eigenvalue. The plugin +gives an error if the eigenvectors are complex. -@item Plugin(Extract) -Plugin(Extract) extracts a combination of -components from the `TimeStep'th time step -in the view `iView'. If only `Expression0' is -given (and `Expression1', ..., `Expression8' are -all empty), the plugin creates a scalar view. -If `Expression0', `Expression1' and/or -`Expression2' are given (and `Expression3', -..., `Expression8' are all empty) the plugin -creates a vector view. Otherwise the plugin -creates a tensor view. In addition to the usual -mathematical functions (Exp, Log, Sqrt, Sin, Cos, -Fabs, etc.) and operators (+, -, *, /, ^), all -expressions can contain the symbols v0, v1, v2, - ..., vn, which represent the n components of the -field, and the symbols x, y and z, which represent -the three spatial coordinates. If `TimeStep' < 0, -the plugin extracts data from all the time steps -in the view. If `iView' < 0, the plugin is run on -the current view. +If `View' < 0, the plugin is run on the current view. -Plugin(Extract) creates one new view. +Plugin(Eigenvectors) creates three new vector view. -String options: -@table @code -@item Expression0 -Default value: @code{"Sqrt(v0^2+v1^2+v2^2)"} -@item Expression1 -Default value: @code{""} -@item Expression2 -Default value: @code{""} -@item Expression3 -Default value: @code{""} -@item Expression4 -Default value: @code{""} -@item Expression5 -Default value: @code{""} -@item Expression6 -Default value: @code{""} -@item Expression7 -Default value: @code{""} -@item Expression8 -Default value: @code{""} -@end table Numeric options: @table @code -@item TimeStep -Default value: @code{-1} -@item iView +@item ScaleByEigenvalues +Default value: @code{1} +@item View Default value: @code{-1} @end table @item Plugin(ExtractElements) Plugin(ExtractElements) extracts the elements -from the view `iView' whose `TimeStep'-th values +from the view `View' whose `TimeStep'-th values (averaged by element) are comprised between -`MinVal' and `MaxVal'. If `iView' < 0, the plugin -is run on the current view. +`MinVal' and `MaxVal'. + +If `View' < 0, the plugin is run on the current view. Plugin(ExtractElements) creates one new view. @@ -410,59 +275,62 @@ Default value: @code{0} Default value: @code{1} @item TimeStep Default value: @code{0} -@item iView -Default value: @code{-1} -@end table - -@item Plugin(FieldView) -Plugin(FieldView) evaluates a field on the choosen view. - -Numeric options: -@table @code -@item Component -Default value: @code{-1} -@item iView -Default value: @code{-1} -@item iField +@item View Default value: @code{-1} @end table @item Plugin(GSHHS) Plugin(GSHHS) read different kind of contour lines data and write a .geo file on the surface of a sphere (the Earth). + The principal application is to load GSHHS data (see http://www.soest.hawaii.edu/wessel/gshhs/gshhs.html). -Valid values for "Format" are ): - -"gshhs" : open GSHHS file - -"loops2" : import 2D contour lines in simple text format : + +Valid values for "Format" are: + +- "gshhs": open GSHHS file + +- "loops2": import 2D contour lines in simple text format: NB_POINTS_IN_FIRST_LOOP FIRST_LOOP_IS_CLOSED COORD1 COORD2 COORD1 COORD2 ... ... NB_POINTS_IN_SECOND_LOOP SECOND_LOOP_IS_CLOSED ... - (LOOP_IS_CLOSED specify if this coast line describe a closed curve - (0=no, 1=yes). -In the case of "loops2" format, you can specify the the coordinate -system used in the input file with the "Coordinate" option, valid -values are - -"lonlat" for longitude-latidute radian, - -"lonlat_degrees" for longitude-latitude degrees, - -"UTM" for universal transverse mercartor ("UTMZone" option should - be specified) - -"cartesian" for full 3D coordinates - -"radius" specify the earth radius. -If the "iField" option is set, consecutive points closer than the -value of the field iField (in meters) will not be added. -If "MinStraitsFactor" >0 and if a field iField is provided, coastlines -closer than MinStraitsFactor*field(IField) are merged and inner corners - which form an angle < pi/3 are removed. -The output is always in stereographic coordinates, if the "WritePolarSphere" -option is not 0, a sphere is added to the geo file. -WARNING : this plugin is still experimental and need polishing and -error-handling. In particular, it will probably crash if an inexistant -field id is given or if the input/output cannot be open. +(LOOP_IS_CLOSED specify if this coast line describe a closed +curve (0=no, 1=yes). In the case of "loops2" format, you +can specify the the coordinate system used in the input file +with the "Coordinate" option, valid values are + +- "lonlat" for longitude-latidute radian, + +- "lonlat_degrees" for longitude-latitude degrees, + +- "UTM" for universal transverse mercartor ("UTMZone" +option should be specified) + +- "cartesian" for full 3D coordinates + +- "radius" specify the earth radius. + +If the "iField" option is set, consecutive points closer +than the value of the field iField (in meters) will not be +added. + +If "MinStraitsFactor" > 0 and if a field iField is +provided, coastlines closer than MinStraitsFactor * +field(IField) are merged and inner corners which form an +angle < pi/3 are removed. + +The output is always in stereographic coordinates, if +the "WritePolarSphere" option is not 0, a sphere is +added to the geo file. + +WARNING: this plugin is still experimental and needs +polishing and error-handling. In particular, it will +probably crash if an inexistant field id is given or if +the input/output cannot be open. String options: @table @code @@ -495,26 +363,29 @@ Default value: @code{1} @item Plugin(Gradient) Plugin(Gradient) computes the gradient of the -field in the view `iView'. If `iView' < 0, the -plugin is run on the current view. +field in the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Gradient) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(HarmonicToTime) Plugin(HarmonicToTime) takes the values in the time steps `RealPart' and `ImaginaryPart' of -the view `iView', and creates a new view -containing (`iView'[`RealPart'] * cos(p) - -`iView'[`ImaginaryPart'] * sin(p)), with -p = 2*Pi*k/`nSteps', k = 0, ..., `nSteps'-1. -If `iView' < 0, the plugin is run on the -current view. +the view `View', and creates a new view +containing + +`View'[`RealPart'] * cos(p) - `View'[`ImaginaryPart'] * sin(p) + +with p = 2*Pi*k/`NumSteps', k = 0, ..., `NumSteps'-1. + +If `View' < 0, the plugin is run on the current view. Plugin(HarmonicToTime) creates one new view. @@ -524,17 +395,17 @@ Numeric options: Default value: @code{0} @item ImaginaryPart Default value: @code{1} -@item nSteps +@item NumSteps Default value: @code{20} -@item iView +@item View Default value: @code{-1} @end table -@item Plugin(HomologyComputation) -Plugin(HomologyComputation) computes generators -for (relative) homology groups and their thick cuts. +@item Plugin(Homology) +Plugin(Homology) computes generators for +(relative) homology groups and their thick cuts. -Plugin(HomologyComputation) creates new views. +Plugin(Homology) creates new views. String options: @table @code @@ -561,16 +432,56 @@ Default value: @code{0} @item Plugin(Integrate) Plugin(Integrate) integrates scalar fields over -all the elements in the view `iView', as well +all the elements in the view `View', as well as the circulation/flux of vector fields over -line/surface elements. If `iView' < 0, the -plugin is run on the current view. +line/surface elements. + +If `View' < 0, the plugin is run on the current view. Plugin(Integrate) creates one new view. Numeric options: @table @code -@item iView +@item View +Default value: @code{-1} +@end table + +@item Plugin(Isosurface) +Plugin(Isosurface) extracts the isosurface of value +`Value' from the view `View', and draws the +`OtherTimeStep'-th step of the view `OtherView' on +this isosurface. + +If `ExtractVolume' is nonzero, the plugin extracts the +isovolume with values greater (if `ExtractVolume' > 0) +or smaller (if `ExtractVolume' < 0) than the isosurface +`Value'. + +If `OtherTimeStep' < 0, the plugin uses, for each time +step in `View', the corresponding time step in `OtherView'. +If `OtherView' < 0, the plugin uses `View' as the value +source. + +If `View' < 0, the plugin is run on the current view. + +Plugin(Isosurface) creates as many views as there are +time steps in `View'. + +Numeric options: +@table @code +@item Value +Default value: @code{0} +@item ExtractVolume +Default value: @code{0} +@item RecurLevel +Default value: @code{4} +@item TargetError +Default value: @code{0} +@item View +Default value: @code{-1} +@item OtherTimeStep +Default value: @code{-1} +@item OtherView Default value: @code{-1} @end table @@ -580,15 +491,19 @@ Lambda(1,2,3) of the tensor (S_ik S_kj + Om_ik Om_kj), where S_ij = 0.5 (ui,j + uj,i) and Om_ij = 0.5 (ui,j - uj,i) are respectively the symmetric and antisymmetric parts of the -velocity gradient tensor. Vortices are well -represented by regions where Lambda(2) is -negative. If `iView' contains tensor elements, -the plugin directly uses the tensors as the -values of the velocity gradient tensor; if -`iView' contains vector elements, the plugin -uses them as the velocities from which to derive -the velocity gradient tensor. If `iView' < 0, -the plugin is run on the current view. +velocity gradient tensor. + +Vortices are well represented by regions where +Lambda(2) is negative. + +If `View' contains tensor elements, the plugin +directly uses the tensors as the values of the +velocity gradient tensor; if `View' contains +vector elements, the plugin uses them as the +velocities from which to derive the velocity +gradient tensor. + +If `View' < 0, the plugin is run on the current view. Plugin(Lambda2) creates one new view. @@ -596,46 +511,186 @@ Numeric options: @table @code @item Eigenvalue Default value: @code{2} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(LongitudeLatitude) -Plugin(LongituteLatitude) Project the view `iView' -in Longitude-Latitude. If `iView' < 0, the plugin -is run on the current view. +Plugin(LongituteLatitude) projects the view `View' +in longitude-latitude. + +If `View' < 0, the plugin is run on the current view. Plugin(LongituteLatitude) is executed in place. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(MakeSimplex) Plugin(MakeSimplex) decomposes all non- simplectic elements (quadrangles, prisms, -hexahedra, pyramids) in the view `iView' into -simplices (triangles, tetrahedra). If `iView' < 0, -the plugin is run on the current view. +hexahedra, pyramids) in the view `View' into +simplices (triangles, tetrahedra). + +If `View' < 0, the plugin is run on the current view. + +Plugin(MakeSimplex) is executed in-place. + +Numeric options: +@table @code +@item View +Default value: @code{-1} +@end table + +@item Plugin(MathEval) +Plugin(MathEval) creates a new view using +data from the time step `TimeStep' in the view +`View'. + +If only `Expression0' is given (and `Expression1', +..., `Expression8' are all empty), the plugin +creates a scalar view. If `Expression0', `Expression1' +and/or `Expression2' are given (and `Expression3', +..., `Expression8' are all empty) the plugin creates +a vector view. Otherwise the plugin creates a tensor +view. + +In addition to the usual mathematical functions +(Exp, Log, Sqrt, Sin, Cos, Fabs, etc.) and operators +(+, -, *, /, ^), all expressions can contain: + +- the symbols v0, v1, v2, ..., vn, which represent +the n components in `View'; + +- the symbols w0, w1, w2, ..., wn, which represent +the n components of `OtherView', at time step +`OtherTimeStep'; + +- the symbols x, y and z, which represent the three +spatial coordinates. + +If `TimeStep' < 0, the plugin extracts data from all +the time steps in the view. + +If `View' < 0, the plugin is run on the current view. + +Plugin(MathEval) creates one new view. + +String options: +@table @code +@item Expression0 +Default value: @code{"Sqrt(v0^2+v1^2+v2^2)"} +@item Expression1 +Default value: @code{""} +@item Expression2 +Default value: @code{""} +@item Expression3 +Default value: @code{""} +@item Expression4 +Default value: @code{""} +@item Expression5 +Default value: @code{""} +@item Expression6 +Default value: @code{""} +@item Expression7 +Default value: @code{""} +@item Expression8 +Default value: @code{""} +@end table +Numeric options: +@table @code +@item TimeStep +Default value: @code{-1} +@item View +Default value: @code{-1} +@item OtherTimeStep +Default value: @code{-1} +@item OtherView +Default value: @code{-1} +@end table + +@item Plugin(ModifyComponent) +Plugin(ModifyComponent) sets the `Component'-th +component of the `TimeStep'-th time step in the +view `View' to the expression `Expression'. + +`Expression' can contain: + +- the usual mathematical functions (Log, Sqrt, +Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^); + +- the symbols x, y and z, to retrieve the +coordinates of the current node; + +- the symbols Time and TimeStep, to retrieve the +current time and time step values; + +- the symbol v, to retrieve the `Component'-th +component of the field in `View' at the +`TimeStep'-th time step; + +- the symbols v0, v1, v2, ..., v8, to retrieve each +component of the field in `View' at the +`TimeStep'-th time step; + +- the symbol w, to retrieve the `Component'-th +component of the field in `OtherView' at the +`OtherTimeStep'-th time step. If `OtherView' +and `View' are based on different spatial grids, +or if their data types are different, `OtherView' +is interpolated onto `View'; + +- the symbols w0, w1, w2, ..., w8, to retrieve each +component of the field in `OtherView' at the +`OtherTimeStep'-th time step. + +If `TimeStep' < 0, the plugin automatically loops +over all the time steps in `View' and evaluates +`Expression' for each one. + +If `OtherTimeStep' < 0, the plugin uses `TimeStep' +instead. + +If `Component' < 0, the plugin automatically loops +over all the components in the view and +evaluates `Expression' for each one. + +If `View' < 0, the plugin is run on the current view. + +If `OtherView' < 0, the plugin uses `View' instead. -Plugin(MakeSimplex) is executed -in-place. +Plugin(ModifyComponent) is executed in-place. +String options: +@table @code +@item Expression +Default value: @code{"v0 * Sin(x)"} +@end table Numeric options: @table @code -@item iView +@item Component +Default value: @code{-1} +@item TimeStep +Default value: @code{-1} +@item View +Default value: @code{-1} +@item OtherTimeStep +Default value: @code{-1} +@item OtherView Default value: @code{-1} @end table @item Plugin(ModulusPhase) Plugin(ModulusPhase) interprets the time steps -`realPart' and `imaginaryPart' in the view `iView' +`realPart' and `imaginaryPart' in the view `View' as the real and imaginary parts of a complex field and replaces them with their corresponding -modulus and phase. If `iView' < 0, the plugin is -run on the current view. +modulus and phase. + +If `View' < 0, the plugin is run on the current view. Plugin(ModulusPhase) is executed in-place. @@ -645,14 +700,84 @@ Numeric options: Default value: @code{0} @item ImaginaryPart Default value: @code{1} -@item iView +@item View +Default value: @code{-1} +@end table + +@item Plugin(Particles) +Plugin(Particles) computes the trajectory +of particules in the force field given by the +`TimeStep'-th time step of a vector view +`View'. + +The plugin takes as input a grid defined by the +3 points (`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') +(axis of U) and (`X2',`Y2',`Z2') (axis of V). + +The number of particles along U and V that are to +be transported is set with the options `NumPointsU' +and `NumPointsV'. The equation + +A2 * d^2X(t)/dt^2 + A1 * dX(t)/dt + A0 * X(t) = F + +is then solved with the initial conditions X(t=0) +chosen as the grid, dX/dt(t=0)=0, and with F +interpolated from the vector view. + +Time stepping is done using a Newmark scheme with +step size `DT' and `MaxIter' maximum number of +iterations. + +If `View' < 0, the plugin is run on the current view. + +Plugin(Particles) creates one new view containing +multi-step vector points. + +Numeric options: +@table @code +@item X0 +Default value: @code{0} +@item Y0 +Default value: @code{0} +@item Z0 +Default value: @code{0} +@item X1 +Default value: @code{1} +@item Y1 +Default value: @code{0} +@item Z1 +Default value: @code{0} +@item X2 +Default value: @code{0} +@item Y2 +Default value: @code{1} +@item Z2 +Default value: @code{0} +@item NumPointsU +Default value: @code{10} +@item NumPointsV +Default value: @code{1} +@item A2 +Default value: @code{1} +@item A1 +Default value: @code{0} +@item A0 +Default value: @code{0} +@item DT +Default value: @code{0.1} +@item MaxIter +Default value: @code{100} +@item TimeStep +Default value: @code{0} +@item View Default value: @code{-1} @end table @item Plugin(Probe) -Plugin(Probe) gets the value of the view `iView' at -the point (`X',`Y',`Z'). If `iView' < 0, the plugin is -run on the current view. +Plugin(Probe) gets the value of the view `View' at +the point (`X',`Y',`Z'). + +If `View' < 0, the plugin is run on the current view. Plugin(Probe) creates one new view. @@ -664,14 +789,15 @@ Default value: @code{0} Default value: @code{0} @item Z Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Remove) Plugin(Remove) removes the marked items -from the view `iView'. If `iView' < 0, the plugin -is run on the current view. +from the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Remove) is executed in-place. @@ -703,50 +829,55 @@ Default value: @code{1} Default value: @code{1} @item Tensor Default value: @code{1} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Skin) -Plugin(Skin) extracts the skin (the boundary) of -the view `iView'. If `iView' < 0, the plugin is run -on the current view. +Plugin(Skin) extracts the boundary (skin) of +the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Skin) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Smooth) Plugin(Smooth) averages the values at the nodes -of the scalar view `iView'. If `iView' < 0, the -plugin is run on the current view. +of the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Smooth) is executed in-place. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(SphericalRaise) Plugin(SphericalRaise) transforms the coordinates of the elements in the view -`iView' using the values associated with the -`TimeStep'-th time step. Instead of elevating -the nodes along the X, Y and Z axes as in -View[`iView'].RaiseX, View[`iView'].RaiseY -and View[`iView'].RaiseZ, the raise is applied - along the radius of a sphere centered at -(`Xc', `Yc', `Zc'). To produce a standard -radiation pattern, set `Offset' to minus the -radius of the sphere the original data lives on. -If `iView' < 0, the plugin is run on the current -view. +`View' using the values associated with the +`TimeStep'-th time step. + +Instead of elevating the nodes along the X, Y +and Z axes as with the View[`View'].RaiseX, +View[`View'].RaiseY and View[`View'].RaiseZ +options, the raise is applied along the radius +of a sphere centered at (`Xc', `Yc', `Zc'). + +To produce a standard radiation pattern, set +`Offset' to minus the radius of the sphere the +original data lives on. + +If `View' < 0, the plugin is run on the current view. Plugin(SphericalRaise) is executed in-place. @@ -764,33 +895,42 @@ Default value: @code{1} Default value: @code{0} @item TimeStep Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(StreamLines) Plugin(StreamLines) computes stream lines from the `TimeStep'-th time step of a vector -view `iView' and optionally interpolates the -scalar view `dView' on the resulting stream -lines. The plugin takes as input a grid defined -by the 3 points (`X0',`Y0',`Z0') (origin), -(`X1',`Y1',`Z1') (axis of U) and (`X2',`Y2',`Z2') -(axis of V). The number of points that are to -be transported along U and V is set with the -options `nPointsU' and `nPointsV'. The equation -DX(t)/dt=V(x,y,z) is then solved with the initial -condition X(t=0) chosen as the grid and with V(x,y,z) -interpolated on the vector view. The time stepping -scheme is a RK44 with step size `DT' and `MaxIter' -maximum number of iterations. If `iView' < 0, the -plugin is run on the current view. If `TimeStep' < 0, -the plugin tries to compute streamlines of the unsteady -flow. +view `View' and optionally interpolates the +scalar view `OtherView' on the resulting stream +lines. + +The plugin takes as input a grid defined by the +3 points (`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') +(axis of U) and (`X2',`Y2',`Z2') (axis of V). + +The number of points along U and V that are to be +transported is set with the options `NumPointsU' +and `NumPointsV'. The equation + +dX(t)/dt = V(x,y,z) + +is then solved with the initial condition X(t=0) +chosen as the grid and with V(x,y,z) interpolated +on the vector view. + +The time stepping scheme is a RK44 with step size +`DT' and `MaxIter' maximum number of iterations. + +If `TimeStep' < 0, the plugin tries to compute +streamlines of the unsteady flow. + +If `View' < 0, the plugin is run on the current view. Plugin(StreamLines) creates one new view. This -view contains multi-step vector points if `dView' -< 0, or single-step scalar lines if `dView' >= 0. +view contains multi-step vector points if `OtherView' +< 0, or single-step scalar lines if `OtherView' >= 0. Numeric options: @table @code @@ -812,45 +952,49 @@ Default value: @code{0} Default value: @code{1} @item Z2 Default value: @code{0} -@item nPointsU +@item NumPointsU Default value: @code{10} -@item nPointsV +@item NumPointsV Default value: @code{1} -@item MaxIter -Default value: @code{100} @item DT Default value: @code{0.1} +@item MaxIter +Default value: @code{100} @item TimeStep Default value: @code{0} -@item dView +@item View Default value: @code{-1} -@item iView +@item OtherView Default value: @code{-1} @end table @item Plugin(Tetrahedralize) -Plugin(Tetrahedralize) tetrahedralizes the points in the -view `iView'. If `iView' < 0, the plugin is run on -the current view. +Plugin(Tetrahedralize) tetrahedralizes the points in +the view `View'. + +If `View' < 0, the plugin is run on the current view. Plugin(Tetrahedralize) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Transform) Plugin(Transform) transforms the homogeneous node coordinates (x,y,z,1) of the elements in -the view `iView' by the matrix +the view `View' by the matrix + [`A11' `A12' `A13' `Tx'] [`A21' `A22' `A23' `Ty'] [`A31' `A32' `A33' `Tz']. + If `SwapOrientation' is set, the orientation of the -elements is reversed. If `iView' < 0, the plugin -is run on the current view. +elements is reversed. + +If `View' < 0, the plugin is run on the current view. Plugin(Transform) is executed in-place. @@ -882,36 +1026,39 @@ Default value: @code{0} Default value: @code{0} @item SwapOrientation Default value: @code{0} -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Triangulate) Plugin(Triangulate) triangulates the points in the -view `iView', assuming that all the points belong +view `View', assuming that all the points belong to a surface that can be projected one-to-one -onto a plane. If `iView' < 0, the plugin is run on -the current view. +onto a plane. + +If `View' < 0, the plugin is run on the current view. Plugin(Triangulate) creates one new view. Numeric options: @table @code -@item iView +@item View Default value: @code{-1} @end table @item Plugin(Warp) Plugin(Warp) transforms the elements in the -view `iView' by adding to their node coordinates +view `View' by adding to their node coordinates the vector field stored in the `TimeStep'-th time -step of the view `dView', scaled by `Factor'. If -`dView' < 0, the vector field is taken as the field -of surface normals multiplied by the `TimeStep' -value in `iView'. (The smoothing of the surface +step of the view `OtherView', scaled by `Factor'. + +If `View' < 0, the plugin is run on the current view. + +If `OtherView' < 0, the vector field is taken as the +field of surface normals multiplied by the `TimeStep' +value in `View'. (The smoothing of the surface normals is controlled by the `SmoothingAngle' -parameter.) If `iView' < 0, the plugin is run on -the current view. +parameter.) Plugin(Warp) is executed in-place. @@ -923,9 +1070,9 @@ Default value: @code{1} Default value: @code{0} @item SmoothingAngle Default value: @code{180} -@item dView +@item View Default value: @code{-1} -@item iView +@item OtherView Default value: @code{-1} @end table diff --git a/doc/texinfo/opt_post.texi b/doc/texinfo/opt_post.texi index b83879417dca75dc4a35fe16bda0a1d5dd192810..fe7b7104304df3573fdfac970278d9d44fa102fd 100644 --- a/doc/texinfo/opt_post.texi +++ b/doc/texinfo/opt_post.texi @@ -20,7 +20,7 @@ Default value: @code{1}@* Saved in: @code{General.OptionsFileName} @item PostProcessing.Format -Default file format for post-processing views (0=ASCII view, 1=binary view, 2=parsed view, 3=STL triangulation, 4=text, 5=mesh)@* +Default file format for post-processing views (0=ASCII view, 1=binary view, 2=parsed view, 3=STL triangulation, 4=raw text, 5=Gmsh mesh, 6=MED file)@* Default value: @code{0}@* Saved in: @code{General.OptionsFileName} diff --git a/doc/texinfo/opt_print.texi b/doc/texinfo/opt_print.texi index baa3295eb9c2953df9e5ff365874f7a79db6a4f2..176b0b983b4c487e0b7232b56480a7d0c9bff209 100644 --- a/doc/texinfo/opt_print.texi +++ b/doc/texinfo/opt_print.texi @@ -26,7 +26,7 @@ Saved in: @code{General.OptionsFileName} @item Print.EpsLineWidthFactor Width factor for lines in PostScript/PDF output@* -Default value: @code{0.5}@* +Default value: @code{1}@* Saved in: @code{General.OptionsFileName} @item Print.EpsOcclusionCulling