Skip to content

Commit 2de1fe9

Browse files
committed
added toctrees
1 parent 5f4026c commit 2de1fe9

12 files changed

Lines changed: 131 additions & 9 deletions

File tree

docs/02.simulation-setup/01.flow-conditions/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,11 @@
1818

1919
### **[Farfield](./02.farfield.md)**
2020

21-
*Settings governing the farfield generation or identification.*
21+
*Settings governing the farfield generation or identification.*
22+
23+
```{toctree}
24+
:hidden:
25+
:maxdepth: 3
26+
./01.operating-condition.md
27+
./02.farfield.md
28+
```

docs/02.simulation-setup/02.mesh/03.refinements/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,16 @@ meshing=MeshingParams(
143143
]
144144
)
145145
```
146-
</details>
146+
</details>
147+
148+
149+
```{toctree}
150+
:hidden:
151+
:maxdepth: 3
152+
./01.surface-edge-refinement.md
153+
./02.surface-refinement.md
154+
./03.boundary-layer-refinement.md
155+
./04.passive-spacing.md
156+
./05.uniform-refinement.md
157+
./06.axisymmetric-refinement.md
158+
```

docs/02.simulation-setup/02.mesh/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,12 @@ A section for defining the meshing settings.
3131
- **[Boundary Layer Refinement](./03.refinements/03.boundary-layer-refinement.md)** - Creates prismatic layers near walls
3232
- **[Passive Spacing](./03.refinements/04.passive-spacing.md)** - Controls mesh behavior without direct refinement
3333
- **[Uniform Refinement](./03.refinements/05.uniform-refinement.md)** - Creates uniform mesh spacing in a region
34-
- **[Axisymmetric Refinement](./03.refinements/06.axisymmetric-refinement.md)** - Creates structured-like mesh with cylindrical bias
34+
- **[Axisymmetric Refinement](./03.refinements/06.axisymmetric-refinement.md)** - Creates structured-like mesh with cylindrical bias
35+
36+
```{toctree}
37+
:hidden:
38+
:maxdepth: 3
39+
./01.mesh.md
40+
./02.rotation-regions.md
41+
./03.refinements/README.md
42+
```

docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,17 @@ Boundary conditions specify how the fluid behaves at the boundaries of the simul
1818

1919
Additionally, [Turbulence Quantities](./08.turbulence-quantities.md) are used to specify turbulence parameters at all types of boundaries, such as Turbulence Intensity, Eddy Viscosity Ratio, Length Scale, etc.
2020

21-
Click on each boundary condition type to see detailed documentation including available parameters, descriptions, usage tips, and example configurations.
21+
Click on each boundary condition type to see detailed documentation including available parameters, descriptions, usage tips, and example configurations.
22+
23+
```{toctree}
24+
:hidden:
25+
:maxdepth: 3
26+
./01.wall.md
27+
./02.freestream.md
28+
./03.inflow.md
29+
./04.outflow.md
30+
./05.periodic.md
31+
./06.symmetry.md
32+
./07.slip-wall.md
33+
./08.turbulence-quantities.md
34+
```

docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,14 @@ The Fluid model is used in virtually all Flow360 simulations, including:
5959
- For most aerospace applications, the Spalart-Allmaras turbulence model provides a good balance of accuracy and efficiency
6060
- Consider enabling the transition model for flows at moderate Reynolds numbers where transition location significantly impacts results
6161
- For challenging simulations, start with more robust settings (lower CFL, higher gradient limiters) and then relax these constraints as the solution develops
62-
- Remember that fluid properties (viscosity, etc.) must be specified in the Operating Condition section, not in the Fluid model
62+
- Remember that fluid properties (viscosity, etc.) must be specified in the Operating Condition section, not in the Fluid model
63+
64+
```{toctree}
65+
:hidden:
66+
:maxdepth: 3
67+
./01.navier-stokes-solver.md
68+
./02.turbulence-model.md
69+
./03.transition-model.md
70+
./04.initial-condition.md
71+
```
72+

docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,12 @@ The Solid model is used in conjugate heat transfer simulations, including:
5353
- Ensure all material properties are specified in consistent units.
5454
- When using patterns in entities, verify all matched volumes are intended for heat transfer simulation.
5555
- Consider mesh resolution near areas with high temperature gradients.
56-
- For conjugate heat transfer, ensure proper interface matching with fluid regions.
56+
- For conjugate heat transfer, ensure proper interface matching with fluid regions.
57+
58+
```{toctree}
59+
:hidden:
60+
:maxdepth: 3
61+
./01.heat-equation-solver.md
62+
./02.material.md
63+
./03.initial-condition.md
64+
```

docs/02.simulation-setup/03.flow-solver/03.physics/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
| **[Actuator disk](./05.actuator-disk.md)** | Simplified model for propellers and rotors | Thrust coefficient, Swirl distribution |
1414
| **[Porous medium](./06.porous-medium.md)** | Model for flow through porous regions | Darcy coefficient, Forchheimer coefficient |
1515

16-
Click on each model to see detailed documentation including available parameters, descriptions, usage tips, and example configurations.
16+
Click on each model to see detailed documentation including available parameters, descriptions, usage tips, and example configurations.
1717

1818
---
1919

@@ -72,3 +72,13 @@ Click on each model to see detailed documentation including available parameters
7272

7373
*Advanced modeling of flow through porous regions including filters, heat exchangers, and porous materials. Implements Darcy-Forchheimer theory with comprehensive coefficient specification for accurate pressure drop and flow distribution prediction.*
7474

75+
```{toctree}
76+
:hidden:
77+
:maxdepth: 3
78+
./01.fluid/README.md
79+
./02.solid/README.md
80+
./03.rotation.md
81+
./04.bet-disk.md
82+
./05.actuator-disk.md
83+
./06.porous-medium.md
84+
```

docs/02.simulation-setup/03.flow-solver/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,11 @@ A section for setting the solver numerics and domain boundary conditions.
4949
*Advanced capability for implementing custom time-dependent motion of simulation components. Enables complex trajectories, rotations, and dynamic interactions between aerodynamic forces and component movement. Currently optimized for Python API implementation with enhanced debugging and flexibility for sophisticated dynamic scenarios.*
5050

5151

52+
```{toctree}
53+
:hidden:
54+
:maxdepth: 3
55+
./01.boundary-conditions/README.md
56+
./02.time.md
57+
./03.physics/README.md
58+
./04.user-defined-dynamics.md
59+
```

docs/02.simulation-setup/04.output/02.outputs-list/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,21 @@ User defined expressions with dimensions. By default, the following expressions
159159

160160
---
161161

162+
```{toctree}
163+
:hidden:
164+
:maxdepth: 3
165+
./01.volume-output.md
166+
./02.time-averaging-volume-output.md
167+
./03.surface-output.md
168+
./04.time-averaging-surface-output.md
169+
./05.slice-output.md
170+
./06.time-averaging-slice-output.md
171+
./07.probe-outputs.md
172+
./08.Time-averaging-probe-outputs.md
173+
./09.surface-probe-outputs.md
174+
./10.surface-slice-output.md
175+
./11.isosurface-output.md
176+
./12.time-averaging-isosurface-output.md
177+
./13.aeroacoustic-output.md
178+
./15.streamline-output.md
179+
```

docs/02.simulation-setup/04.output/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,12 @@
3636
- **[Time-averaging Isosurface Output](./02.outputs-list/12.time-averaging-isosurface-output.md)** - Time-averaged flow field data on surfaces of constant variable value
3737
- **[Aeroacoustic Output](./02.outputs-list/13.aeroacoustic-output.md)** - Data for aeroacoustic analysis at observer positions
3838
- **[Output Formats](./02.outputs-list/14.output-formats.md)** - File format specifications for output data
39-
- **[Streamline Output](./02.outputs-list/15.streamline-output.md)** - Visualization of 3D flow structures
39+
- **[Streamline Output](./02.outputs-list/15.streamline-output.md)** - Visualization of 3D flow structures
40+
41+
```{toctree}
42+
:hidden:
43+
:maxdepth: 3
44+
./01.reference-dimensions.md
45+
./02.outputs-list/README.md
46+
```
47+

0 commit comments

Comments
 (0)