diff --git a/README.txt b/README.txt index ead75106026273d236e18fc4d8808932940e2e1b..d814dcc38a64120e99966b0191c1d655dab80d03 100644 --- a/README.txt +++ b/README.txt @@ -2,8 +2,8 @@ This is Gmsh, an automatic three-dimensional finite element mesh generator with built-in pre- and post-processing facilities. Gmsh is distributed under the terms of the GNU General Public License, -with an exception to allow for easier linking with external mesh -generators. See doc/LICENSE.txt and doc/CREDITS.txt for more +with an exception to allow for easier linking with external +libraries. See doc/LICENSE.txt and doc/CREDITS.txt for more information. See the doc/ and tutorial/ directories for documentation. The diff --git a/doc/gmsh.1 b/doc/gmsh.1 index f43f3bbfd8ec226ea514e938943322eb5bbb3831..0c644ace787b5882175d3e9033e2d62abe6b17c9 100644 --- a/doc/gmsh.1 +++ b/doc/gmsh.1 @@ -9,10 +9,10 @@ post-processor .B gmsh [file(s)] [option(s)] .\" ******************************************************************** .SH DESCRIPTION -\fIGmsh\fR is an automatic three-dimensional finite element mesh -generator with build-in CAD and post-processing facilities. Its design -goal is to provide a simple meshing tool for academic problems with -parametric input and advanced visualization capabilities. +\fIGmsh\fR is a 3D finite element grid generator with a build-in CAD +engine and post-processor. Its design goal is to provide a fast, light +and user-friendly meshing tool with parametric input and advanced +visualization capabilities. .PP \fIGmsh\fR is built around four modules: geometry, mesh, solver and post-processing. The specification of any input to these modules is @@ -159,7 +159,7 @@ Christophe Geuzaine (cgeuzaine@ulg.ac.be) and Jean-Francois Remacle .br Gmsh examples (\fI/usr/share/doc/gmsh-*/\fR), .br -Gmsh homepage (\fIhttp://www.geuz.org/gmsh/\fR). +Gmsh homepage (\fIhttp://geuz.org/gmsh/\fR). .PP The full documentation for Gmsh is maintained as a Texinfo manual. If the diff --git a/doc/texinfo/gmsh.texi b/doc/texinfo/gmsh.texi index 31007a22470c64e61f0ab8b5bf45b51a4fa8d93f..c463284a13463615ac356ba35856a8f73575dc17 100644 --- a/doc/texinfo/gmsh.texi +++ b/doc/texinfo/gmsh.texi @@ -500,11 +500,9 @@ interfaces, and others can be easily added (@pxref{Solver module}); visualize and export computational results in a great variety of ways. Gmsh can display scalar, vector and tensor datasets, perform various operations on the resulting post-processing views -(@pxref{Post-processing module}), and export plots in many different -formats: vector PostScript or encapsulated PostScript, LaTeX, PNG, JPEG, -@dots{} (@pxref{General options list}); -@item -generate complex animations (see @ref{General tools}, and @ref{t8.geo}); +(@pxref{Post-processing module}), can export plots in many different +formats (@pxref{General options list}), and can generate complex +animations (see @ref{General tools}, and @ref{t8.geo}); @item run on low end machines and/or machines with no graphical interface. Gmsh can be compiled with or without the GUI, and all @@ -4620,7 +4618,7 @@ and @file{Geo/GRegion.h}). Concrete implementations of the geometrical entity classes are provided for each supported CAD kernel (e.g. @file{Geo/gmshVertex.h} for geometry points in Gmsh's native CAD format, or @file{Geo/OCCVertex.h} for geometry points from -OpenCascade). The post-processing module is based on the concept of +OpenCASCADE). The post-processing module is based on the concept of views (@file{Post/PView.h}) and abstract data containers (derived from @file{Post/PViewData.h}). @@ -4720,7 +4718,7 @@ optional: create the associated widget in @file{Fltk/optionWindow.cpp}; @c @node Compiling with OpenCASCADE, , Coding style, Information for developers @c @section Compiling with OpenCASCADE -@c How to build OpenCascade 6.3 (OCC) for Gmsh: +@c How to build OpenCASCADE 6.3 (OCC) for Gmsh: @c - Get the source distribution of OCC and unpack it (you only need the @c "ros" subdirectory). In the following <OpenCascade dir> refers to @@ -4750,13 +4748,13 @@ optional: create the associated widget in @file{Fltk/optionWindow.cpp}; @c lipo -create libi386.a libppc.a -output libuniversal.a -@c - Go to the <OpenCascade dir>/ros directory and type +@c - Go to the <OpenCASCADE dir>/ros directory and type @c ./configure --prefix=/usr/local/opencascade --enable-debug=no @c --enable-production=yes --enable-static=yes --enable-shared=no @c --disable-dependency-tracking -@c - Then go to the <OpenCascade dir>/ros/adm/make/ directory and +@c - Then go to the <OpenCASCADE dir>/ros/adm/make/ directory and @c run "make" in the following subdirectories, e.g. by running the @c following bash script: @@ -4783,12 +4781,12 @@ optional: create the associated widget in @file{Fltk/optionWindow.cpp}; @c cd $lib && make install; cd ..; @c done -@c and copy config.h and the <OpenCascade dir>/ros/inc/ subdirectory +@c and copy config.h and the <OpenCASCADE dir>/ros/inc/ subdirectory @c to /usr/local/opencascade (This is the same as a doing a partial @c 'make install') -@c OpenCascade is now installed and ready to be used by Gmsh. To compile -@c Gmsh with OpenCascade support: +@c OpenCASCADE is now installed and ready to be used by Gmsh. To compile +@c Gmsh with OpenCASCADE support: @c - Go to the gmsh source directory @@ -4933,7 +4931,7 @@ Are you are executing Gmsh from a remote host (via the network) without GLX? You should turn double buffering off (with the `-nodb' command line option). -@item There is an ugly "ghost triangulation" in the vector PostScript/PDF files generated by Gmsh! +@item There is an ugly ``ghost triangulation'' in the vector PostScript/PDF files generated by Gmsh! No, there isn't. This ``ghost triangulation'' is due to the fact that most PostScript previewers nowadays antialias the graphic primitives when @@ -4945,7 +4943,7 @@ ghost triangulation in the printed output (on paper). Just choose the appropriate format in `File->Save As'. By default Gmsh guesses the format from the file extension, so you can just type -"myfile.jpg" in the dialog and Gmsh will automatically create a JPEG +@file{myfile.jpg} in the dialog and Gmsh will automatically create a JPEG image file. @item How can I save MPEG, AVI, ..., animations? @@ -4977,7 +4975,7 @@ clipboard. @item Does Gmsh support NURBS curves/surfaces? Yes, but only via STEP, IGES or BREP model import (not in @file{.geo} -files). Gmsh has to be compiled with OpenCascade support for this to +files). Gmsh has to be compiled with OpenCASCADE support for this to work. @item Gmsh is very slow when I use many transformations (Translate, Rotate, Symmetry, Extrude, etc. ). What's wrong? @@ -5012,7 +5010,7 @@ define volumes and physical groups, or delete entities. The easiest way to do this is to merge the model in a @file{.geo} file using @code{Merge "file.step";} and add the relevant scripting command after that. We plan to add more advanced editing features in the future (to delete entities, -to create "mixed" surfaces and volumes, to export in @file{.geo} format, +to create ``mixed'' surfaces and volumes, to export in @file{.geo} format, etc.). @item How can I build modular geometries? @@ -5043,13 +5041,26 @@ system and the full geometry. Verify that the surfaces in your model do not self-intersect or partially overlap. If they don't, try the other 3D algorithms -(Tool->Options->Mesh->General->3D algorithm) or try to adapt the +(`Tool->Options->Mesh->General->3D algorithm') or try to adapt the characteristic lengths in your input file so that the surface mesh better matches the geometrical details of the model. If nothing works, file a bug report with the version of your operating system and and the full geometry. +@item My 2D meshes of IGES files present gaps between surfaces + +IGES files do not contain the topology of the model, and tolerance +problems can thus appear when the OpenCASCADE importer cannot identify +two (close) curves as actually being indentical. + +The best solution is to @emph{not use IGES and use STEP} instead. If you +really have to use IGES, check that you don't have duplicate curves +(e.g. by displaying their numbers in the GUI with +`Tools->Options->Geometry->Visibility->Line numbers'). If there are +duplicates, try to change the geometrical tolerance and sew the faces +(see options in `Tools->Options->Geometry->General'). + @item The quality of the elements generated by the 3D algorithm is very bad. Use `Optimize quality' in the mesh menu. @@ -5072,7 +5083,7 @@ standard entity number instead. @item Did you remove the elliptic mesh generator in Gmsh 2.0? Yes. You can achieve the same result by using the transfinite -algorithm with smoothing (e.g., with "Mesh.Smoothing = 10"). +algorithm with smoothing (e.g., with @code{Mesh.Smoothing = 10}). @item Does Gmsh support curved elements? @@ -5104,11 +5115,11 @@ description and some examples. See ``How can I display only selected parts of my model?''. -@item How can I "explore" a mesh (for example, to see inside a complex structure)? +@item How can I ``explore'' a mesh (for example, to see inside a complex structure)? You can use `Tools->Clipping Planes' to clip the region of interest. You can define up to 6 clipping planes in Gmsh (i.e., enough -to define a "cube" inside your model) and each plane can clip either +to define a ``cube'' inside your model) and each plane can clip either the geometry, the mesh, the post-processing views, or any combination of the above. The clipping planes are defined using the four coefficients A,B,C,D of the equation A*x+B*y+C*y+D=0, which can be @@ -5261,7 +5272,9 @@ Yes, using scripts. Have a look at @file{tutorial/t8.geo} or @item Is there a way to visualize only certain components of vector/tensor fields? -Yes, using `Tools->Plugins->Extract'. +Yes, by using either the ``Force field'' options in +`Tools->Options->View->Visibility', or by using +`Tools->Plugins->Extract'. @item Can I do arithmetic operations on a view? Can I perform operations involving different views? @@ -5290,12 +5303,12 @@ In any case, you can automatically remove all empty views with `View->Remove->Empty Views' in the GUI, or with @code{Delete Empty Views;} in a script. -@item How can I see "inside" a complicated post-processing view? +@item How can I see ``inside'' a complicated post-processing view? -See ``How can I "explore" a mesh?''. +Use `Tools->Clipping Planes'. When viewing 3D scalar fields, you can also modify the colormap -(`Tools->Options->View->Map') to make the iso-surfaces "transparent": +(`Tools->Options->View->Map') to make the iso-surfaces ``transparent'': either by holding `Ctrl' while dragging the mouse to draw the alpha channel by hand, or by using the `a', `Ctrl+a', `p' and `Ctrl+p' keyboard shortcuts.