diff --git a/doc/texinfo/opt_fields.texi b/doc/texinfo/opt_fields.texi index 6bfea3c35636beee6fb86d4d0e1767ad408c54f6..26c776259a5cbc73c0649f4d4375f21b3d317e7b 100644 --- a/doc/texinfo/opt_fields.texi +++ b/doc/texinfo/opt_fields.texi @@ -5,10 +5,7 @@ @ftable @code @item Attractor -Compute the distance from the nearest node in a list. It can also@* -be used to compute the distance from curves, in which case each curve@* -is replaced by NNodesByEdge equidistant nodes and the distance from those@* -nodes is computed.@* +Compute the distance from the nearest node in a list. It can also be used to compute the distance from curves, in which case each curve is replaced by NNodesByEdge equidistant nodes and the distance from those nodes is computed.@* Options:@* @table @code @item EdgesList @@ -16,8 +13,7 @@ Indices of curves in the geometric model@* type: list@* default value: @code{@{@}} @item FacesList -Indices of surfaces in the geometric model (Warning: might -give strange results for complex surfaces)@* +Indices of surfaces in the geometric model (Warning: might give strange results for complex surfaces)@* type: list@* default value: @code{@{@}} @item NNodesByEdge @@ -57,20 +53,17 @@ Element size inside DistMin@* type: float@* default value: @code{0.1} @item Sigmoid -True to interpolate between LcMin and LcMax using a sigmoid, -false to interpolate linearly@* +True to interpolate between LcMin and LcMax using a sigmoid, false to interpolate linearly@* type: boolean@* default value: @code{0} @item StopAtDistMax -True to not impose element size outside DistMax (i.e., -F = a very big value if Field[IField] > DistMax)@* +True to not impose element size outside DistMax (i.e., F = a very big value if Field[IField] > DistMax)@* type: boolean@* default value: @code{0} @end table @item Box -The value of this field is VIn inside the box, VOut outside the box.@* -The box is given by@* +The value of this field is VIn inside the box, VOut outside the box. The box is given by@* @* Xmin <= x <= XMax &&@* YMin <= y <= YMax &&@* @@ -128,8 +121,7 @@ default value: @code{1} @end table @item Cylinder -The value of this field is VIn inside a frustrated cylinder, VOut outside.@* -The cylinder is given by@* +The value of this field is VIn inside a frustrated cylinder, VOut outside. The cylinder is given by@* @* ||dX||^2 < R^2 &&@* (X-X0).A < ||A||^2@* @@ -177,8 +169,7 @@ default value: @code{0} @item Gradient Compute the finite difference gradient of Field[IField]:@* @* - F = (Field[IField](X + Delta/2) -@* - Field[IField](X - Delta/2)) / Delta@* + F = (Field[IField](X + Delta/2) - Field[IField](X - Delta/2)) / Delta@* Options:@* @table @code @item Delta @@ -190,8 +181,7 @@ Field index@* type: integer@* default value: @code{1} @item Kind -Component of the gradient to evaluate: 0 for X, 1 for Y, 2 for Z, -3 for the norm@* +Component of the gradient to evaluate: 0 for X, 1 for Y, 2 for Z, 3 for the norm@* type: integer@* default value: @code{0} @end table @@ -229,9 +219,7 @@ default value: @code{1} @end table @item MathEval -Evaluate a mathematical expression. The expression can contain@* -x, y, z for spatial coordinates, F0, F1, ... for field values, and@* -and mathematical functions.@* +Evaluate a mathematical expression. The expression can contain x, y, z for spatial coordinates, F0, F1, ... for field values, and and mathematical functions.@* Options:@* @table @code @item F @@ -251,8 +239,7 @@ default value: @code{@{@}} @end table @item MaxEigenHessian -Compute the maximum eigenvalue of the Hessian matrix of@* -Field[IField], with the gradients evaluated by finite differences:@* +Compute the maximum eigenvalue of the Hessian matrix of Field[IField], with the gradients evaluated by finite differences:@* @* F = max(eig(grad(grad(Field[IField]))))@* Options:@* @@ -303,8 +290,7 @@ Evaluate Field IField in parametric coordinates:@* @* F = Field[IField](FX,FY,FZ)@* @* -See the MathEval Field help to get a description of valid FX, FY@* -and FZ expressions.@* +See the MathEval Field help to get a description of valid FX, FY and FZ expressions.@* Options:@* @table @code @item FX @@ -330,8 +316,7 @@ Evaluate the post processing view IView.@* Options:@* @table @code @item CropNegativeValues -return LC_MAX instead of a negative value (this -option is needed for backward compatibility with the BackgroundMesh option@* +return LC_MAX instead of a negative value (this option is needed for backward compatibility with the BackgroundMesh option@* type: boolean@* default value: @code{1} @item IView @@ -341,8 +326,7 @@ default value: @code{0} @end table @item Restrict -Restrict the application of a field to a given list of geometrical@* -curves, surfaces or volumes.@* +Restrict the application of a field to a given list of geometrical curves, surfaces or volumes.@* Options:@* @table @code @item EdgesList @@ -364,8 +348,7 @@ default value: @code{@{@}} @end table @item Structured -Linearly interpolate between data provided on a 3D rectangular@* -structured grid.@* +Linearly interpolate between data provided on a 3D rectangular structured grid.@* @* The format of the input file is:@* @* @@ -378,9 +361,7 @@ The format of the input file is:@* ... ... ... @* v(1,0,0) ... ... @* @* -where O are the coordinates of the first node, D are the distances@* -between nodes in each direction, n are the numbers of nodes in each@* -direction, and v are the values on each node.@* +where O are the coordinates of the first node, D are the distances between nodes in each direction, n are the numbers of nodes in each direction, and v are the values on each node.@* Options:@* @table @code @item FileName @@ -388,8 +369,7 @@ Name of the input file@* type: path@* default value: @code{""} @item TextFormat -True for ASCII input files, false for binary files (4 bite -signed integers for n, double precision floating points for v, D and O)@* +True for ASCII input files, false for binary files (4 bite signed integers for n, double precision floating points for v, D and O)@* type: boolean@* default value: @code{0} @end table @@ -421,19 +401,18 @@ Element size inside DistMin@* type: float@* default value: @code{0.1} @item Sigmoid -True to interpolate between LcMin and LcMax using a sigmoid, -false to interpolate linearly@* +True to interpolate between LcMin and LcMax using a sigmoid, false to interpolate linearly@* type: boolean@* default value: @code{0} @item StopAtDistMax -True to not impose element size outside DistMax (i.e., -F = a very big value if Field[IField] > DistMax)@* +True to not impose element size outside DistMax (i.e., F = a very big value if Field[IField] > DistMax)@* type: boolean@* default value: @code{0} @end table @item UTM Evaluate Field[IField] in Universal Transverse Mercator coordinates.@* +@* The formulas for the coordinates transformation are taken from:@* @* http://www.uwgb.edu/dutchs/UsefulData/UTMFormulas.HTM@* diff --git a/doc/texinfo/opt_solver.texi b/doc/texinfo/opt_solver.texi index cb3df791f20b04e3e0d2d4813f00855c1cb4606b..4f5da4a2d7790b452965cc07972b2d886145abf0 100644 --- a/doc/texinfo/opt_solver.texi +++ b/doc/texinfo/opt_solver.texi @@ -16,10 +16,8 @@ Saved in: @code{General.OptionsFileName} @item Solver.Help0 Help string for solver 0@* -Default value: @code{"A General environment for the treatment of -Discrete Problems. -Copyright (C) 1997-2009 -Patrick Dular and Christophe Geuzaine. +Default value: @code{"A General environment for the treatment of Discrete Problems. +Copyright (C) 1997-2009 Patrick Dular and Christophe Geuzaine. Visit http://www.geuz.org/getdp/ for more info"}@* Saved in: @code{General.OptionsFileName}