From 3f190d2d58da5a23da621497f6daa448e31bcf7a Mon Sep 17 00:00:00 2001
From: Christophe Geuzaine <cgeuzaine@ulg.ac.be>
Date: Wed, 18 Feb 2009 21:54:22 +0000
Subject: [PATCH] docs
---
Common/DefaultOptions.h | 2 +-
benchmarks/step/tank.geo | 3 +++
doc/README.gui | 21 ++++++---------------
doc/texinfo/opt_mesh.texi | 2 +-
doc/texinfo/opt_plugin.texi | 32 ++++++++++++++++++++++++++++++++
5 files changed, 43 insertions(+), 17 deletions(-)
diff --git a/Common/DefaultOptions.h b/Common/DefaultOptions.h
index 9aefa3c818..c8d6785bb7 100644
--- a/Common/DefaultOptions.h
+++ b/Common/DefaultOptions.h
@@ -1075,7 +1075,7 @@ StringXNumber MeshOptions_Number[] = {
{ F|O, "RadiusSup" , opt_mesh_radius_sup , 0.0 ,
"Only display elements whose longest edge is smaller than RadiusSup" },
{ F|O, "RandomFactor" , opt_mesh_rand_factor , 1.e-9 ,
- "Random factor used in 2D and 3D meshing algorithm (test other values when the algorithm fails)" },
+ "Random factor used in the 2D meshing algorithm (use larger values if lc * rand approaches machine accuracy)" },
{ F|O, "RefineSteps" , opt_mesh_refine_steps , 10 ,
"Number of refinement steps in the MeshAdapt-based 2D algorithms" },
{ F|O, "ReverseAllNormals" , opt_mesh_reverse_all_normals , 0. ,
diff --git a/benchmarks/step/tank.geo b/benchmarks/step/tank.geo
index 436d366b53..92a7258f18 100644
--- a/benchmarks/step/tank.geo
+++ b/benchmarks/step/tank.geo
@@ -1,3 +1,6 @@
+Geometry.OCCFixSmallEdges=1;
+Geometry.OCCFixSmallFaces=1;
+
Merge "tank.brep";
n = 2;
diff --git a/doc/README.gui b/doc/README.gui
index 3fa50c816b..fdf8c70ba0 100644
--- a/doc/README.gui
+++ b/doc/README.gui
@@ -1,19 +1,10 @@
Some GUI guidelines:
-1) To make the interface as visually consistent as possible, please:
-- use the IW, BB, BH, BW and WB values
-- examine what's already done before adding something new...
+1) To make the interface as visually consistent as possible use the
+IW, BB, BH and WB values. And examine what's already done before
+adding something new...
-2) Use the following rule for buttons on dialog windows:
-- "OK" is to agree with what is in the dialog *AND* close the dialog
-- "Apply" is to apply the current values selected in the dialog, but
- leave the dialog open
-- "Cancel" is to close (hide) the dialog and *NOT* apply the
- changes that might have been made in the dialog
-The "Cancel" button, if present, should always be the last (-> at
-right)
-
-3) Only 'title-capitalize' titles and menus (Rules: 1. Always
+2) Only 'title-capitalize' titles and menus (Rules: 1. Always
capitalize the first and the last word. 2. Capitalize all nouns,
pronouns, adjectives, verbs, adverbs, and subordinate
conjunctions. 3. Lowercase all articles, coordinate conjunctions,
@@ -21,7 +12,7 @@ and prepositions, when they are other than the first or last
word. 4. Lowercase the "to" in an infinitive.) Capitalize everything
else like normal english sentences
-4) Use an ellipsis character in a menu item for
+3) Use an ellipsis character in a menu item for
- an action that requires further user input to complete or
presents an alert allowing the user to cancel the action
Examples: Find, Go To, Open, Page Setup, and Print.
@@ -37,6 +28,6 @@ Don't use en allipsis for:
window and are frequently left open to assist in accomplishing the
task of the main window. Examples: Info and Show Tools.
-5) The title of a window opened from a meny should be exactly the
+4) The title of a window opened from a menu should be exactly the
same as the label of the menu item (without the ellipsis character if
there is one)
diff --git a/doc/texinfo/opt_mesh.texi b/doc/texinfo/opt_mesh.texi
index e85611c032..343e373338 100644
--- a/doc/texinfo/opt_mesh.texi
+++ b/doc/texinfo/opt_mesh.texi
@@ -395,7 +395,7 @@ Default value: @code{0}@*
Saved in: @code{General.OptionsFileName}
@item Mesh.RandomFactor
-Random factor used in 2D and 3D meshing algorithm (test other values when the algorithm fails)@*
+Random factor used in the 2D meshing algorithm (use larger values if lc * rand approaches machine accuracy)@*
Default value: @code{1e-09}@*
Saved in: @code{General.OptionsFileName}
diff --git a/doc/texinfo/opt_plugin.texi b/doc/texinfo/opt_plugin.texi
index 13b7db5f67..6df6285543 100644
--- a/doc/texinfo/opt_plugin.texi
+++ b/doc/texinfo/opt_plugin.texi
@@ -426,6 +426,38 @@ Default value: @code{-1}
Default value: @code{-1}
@end table
+@item Plugin(FiniteElement)
+Plugin(FiniteElement) solves simple PDEs
+using the finite element method. This is only
+intended as a demonstration tool: it is NOT
+intended for general use.
+Plugin(FiniteElement) creates a new view.
+
+String options:
+@table @code
+@item Equation
+Default value: @code{"Laplace"}
+@item BC1
+Default value: @code{"Dirichlet"}
+@item BC2
+Default value: @code{"Dirichlet"}
+@end table
+Numeric options:
+@table @code
+@item Parameter
+Default value: @code{1}
+@item Volume
+Default value: @code{1}
+@item Surface1
+Default value: @code{2}
+@item Value1
+Default value: @code{0}
+@item Surface2
+Default value: @code{3}
+@item Value2
+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
--
GitLab