Skip to content

Commit c173e38

Browse files
juney-leegitbook-bot
authored andcommitted
GITBOOK-46: No subject
1 parent 6e8d665 commit c173e38

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

gitbook/manual/settings.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,28 @@ Under `Settings`, global parameters (`RhinoVAULT`, `ThrustNetworkAnalysis`) and
1616

1717
These are the global parameters for RhinoVAULT.
1818

19-
* **`autosave`** - If set to `True`, session files are saved every time a change has been made in the scene. Set to `True` by default.
20-
* **`autoupdate`** - If set to `True`, any modifications made in the scene will automatically update the `ThrustDiagram`. Set to `False` by default.
19+
* **autosave** - If set to `True`, session files are saved every time a change has been made in the scene. Set to `True` by default.
20+
* **autoupdate** - If set to `True`, any modifications made in the scene will automatically update the `ThrustDiagram`. Set to `False` by default.
2121

2222
### ThrustNetworkAnalysis
2323

2424
These are the parameters related to [Horizontal equilibrium](horizontal-equilibrium.md) and [Vertical equilibrium](fitting.md) solvers.
2525

26-
* **`horizontal_kmax`** - Number of iterations to be executed by `RV_tna_horizontal` (horizontal equilibrium solver). This number can be reset before the solver is run. This number is set to 100 by default.
27-
* **`horizontal_alpha`** - Percentage value (0.0 to 100.0) that determines how much influence `FormDiagram` has during `RV_tna_horizontal`. For example, an `Alpha` value of 100.0 means that the `FormDiagram` remains fixed and only the `ForceDiagram` will be reconfigures, while an Alpha value of 50 will reconfigure both the `FormDiagram` and `ForceDiagram` with equal weight. This value is set to 100.0 by default.
28-
* **`horizontal_max_angle`** - Tolerance value for displaying angle deviations. If the maximum angle deviation between a pair of corresponding edges in the `FormDiagram` and the `ForceDiagram` is greater than this value, angle deviation will be displayed in the scene with a Rhino dot. This value is set to 5.0 by default.
29-
* **`horizontal_refreshrate`** - Number of iterations to skip during dynamic visualization of `RV_tna_horizontal`. For example, a value of 1 will visualize every iteration step, and therefore take much longer for the final result to be displayed. This value is set to 5 by default.
30-
* **`vertical_kmax`** - Number of iterations to be executed by `RV_tna_vertical` (vertical equilibrium solver). This number is set to 300 by default.
31-
* **`vertical_zmax`** - Default target height for the `ThrustDiagram`. This value is automatically computed and set by the dimensions of the bounding box of the `FormDiagram` in the scene.
26+
* **horizontal\_kmax** - Number of iterations to be executed by `RV_tna_horizontal` (horizontal equilibrium solver). This number can be reset before the solver is run. This number is set to 100 by default.
27+
* **horizontal\_alpha** - Percentage value (0.0 to 100.0) that determines how much influence `FormDiagram` has during `RV_tna_horizontal`. For example, an `Alpha` value of 100.0 means that the `FormDiagram` remains fixed and only the `ForceDiagram` will be reconfigures, while an Alpha value of 50 will reconfigure both the `FormDiagram` and `ForceDiagram` with equal weight. This value is set to 100.0 by default.
28+
* **horizontal\_max\_angle** - Tolerance value for displaying angle deviations. If the maximum angle deviation between a pair of corresponding edges in the `FormDiagram` and the `ForceDiagram` is greater than this value, angle deviation will be displayed in the scene with a Rhino dot. This value is set to 5.0 by default.
29+
* **horizontal\_refreshrate** - Number of iterations to skip during dynamic visualization of `RV_tna_horizontal`. For example, a value of 1 will visualize every iteration step, and therefore take much longer for the final result to be displayed. This value is set to 5 by default.
30+
* **vertical\_kmax** - Number of iterations to be executed by `RV_tna_vertical` (vertical equilibrium solver). This number is set to 300 by default.
31+
* **vertical\_zmax** - Default target height for the `ThrustDiagram`. This value is automatically computed and set by the dimensions of the bounding box of the `FormDiagram` in the scene.
3232

3333
### Drawing
3434

3535
These are the visualization parameters for various RhinoVAULT elements.
3636

37-
* **show\_angles** - This is set to `True` by default.
38-
* **show\_forces** - This is set to `False` by default.
39-
* **show\_reactions** - This is set to `True` by default.
40-
* **show\_residuals** - This is set to `False` by default.
37+
* **show\_angles** - If set to `True`, angle deviations between the corresponding edges of the `FormDiagram` and `ForceDiagram` are displayed. This is set to `True` by default.
38+
* **show\_forces** - If set to `True`, the corresponding edges of the `FormDiagram` and `ForceDiagram` are displayed in matching colors. The color gradient is determined based on the relative magnitudes of the internal horizontal forces (Red is higher, blue is lower; the color is independent of whether or not the force is in compression or tension). This is set to `False` by default.
39+
* **show\_reactions** - If set to `True`, reaction forces at the supports will be displayed as vectors. This is set to `True` by default.
40+
* **show\_residuals** - If set to `True`, residual forces present at every vertex will be displayed as vectors. This is set to `False` by default.
4141
* **show\_pipes** - This is set to `False` by default.
4242
* **show\_loads** - This is set to `False` by default.
4343
* **show\_selfweight** - This is set to `False` by default.

0 commit comments

Comments
 (0)