Skip to content

Commit 3eafc76

Browse files
committed
fixing sphinx warnings part 1
1 parent 0f9e536 commit 3eafc76

9 files changed

Lines changed: 16 additions & 116 deletions

File tree

docs/.vuepress/template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
orphan: true
3+
---
4+
15
# Form Name
26

37
*A concise description of the purpose of this form goes here.*

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010

1111
## **Detailed descriptions**
1212

13-
#### **Type**
13+
### **Type**
1414

1515
*Setting allowing the user to choose between generating the farfield in the workflow and providing the farfield as a part of uploaded geometry.*
1616

1717
**Possible selections:**
1818
- `Automated farfield` - Farfield generated by Flow360 around the geometry
1919
- `User defined farfield` - Farfield geometry provided by the user, has to be assigned to an appropriate boundary condition in [Boundary conditions](../03.flow-solver/01.boundary-conditions/02.freestream.md)
2020

21-
#### **Method**
21+
### **Method**
2222

2323
*Method of defining the size of an auto-generated farfield.*
2424

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
The Meshing Defaults define the baseline mesh generation parameters that control element size progression, boundary layer characteristics, and surface mesh properties.
66

7-
---
87

98
## **Available Parameters**
109

@@ -19,12 +18,12 @@ The Meshing Defaults define the baseline mesh generation parameters that control
1918
| **Gap treatment strength** | Controls mesh behavior in narrow gaps |
2019
| **Preserve thin geometry** | Specifies whether thin geometry features should be resolved accurately during surface meshing|
2120

22-
---
21+
2322

2423
## **Detailed Descriptions**
2524

2625
### **Surface Mesh Parameters**
27-
---
26+
2827
#### **Surface edge growth rate**
2928

3029
*Controls the size progression of mesh elements grown from edges, affecting the transition between regions of different refinement (anisotropic to isotropic).*
@@ -61,7 +60,7 @@ The Meshing Defaults define the baseline mesh generation parameters that control
6160
> - Lower values capture curvature more accurately but increase mesh density
6261
6362
### **Volume Mesh Parameters**
64-
---
63+
6564
#### **Boundary layer growth rate**
6665

6766
*Defines the growth rate of prismatic layers in the boundary layer region.*
@@ -86,7 +85,6 @@ The Meshing Defaults define the baseline mesh generation parameters that control
8685
> - Should be calculated based on Reynolds number and desired y+ value
8786
8887
### **Advanced Parameters**
89-
---
9088

9189
#### **Refinement factor**
9290

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,4 +155,5 @@ meshing=MeshingParams(
155155
./04.passive-spacing.md
156156
./05.uniform-refinement.md
157157
./06.axisymmetric-refinement.md
158+
./07.geometry-refinement.md
158159
```

docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/05.stopping-criterion.md

Lines changed: 0 additions & 97 deletions
This file was deleted.

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ The Fluid model consists of five primary components, each documented in detail i
1616

1717
4. [**Initial Condition**](./04.initial-condition.md): Defines the starting flow state for the simulation, which can significantly impact convergence rates and stability, especially for complex flows.
1818

19-
5. [**Stopping Criterion**](./05.stopping-criterion.md): Allows for automatic simulation termination based on the convergence of a specified monitored field.
20-
2119
## **Configuration Example**
2220

2321
Below is a representative example of a Fluid model configuration (shown for reference purposes):

docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
*Time-averaging Volume Output in Flow360 allows you to calculate and visualize time-averaged flow variables throughout the entire computational domain. This is essential for statistical analysis of unsteady flows and understanding mean flow characteristics.*
44

5-
---
6-
75
## **Available Options**
86

97
| *Option* | *Description* | *Applicable* |
@@ -16,8 +14,6 @@
1614
| **Frequency offset** | Time step at which to start the output animation | when **Save interval** is `Custom` |
1715

1816

19-
---
20-
2117
## **Detailed Descriptions**
2218

2319
### **Output fields**
@@ -53,7 +49,7 @@
5349
5450
### **Save interval**
5551

56-
*Choos the points in the simulaton where the results are saved.*
52+
*Choose the points in the simulaton where the results are saved.*
5753

5854
- **Default:** `Save at end`
5955
- **Options:**
@@ -185,6 +181,4 @@ simulation_params = fl.SimulationParams(
185181
)
186182
```
187183

188-
</details>
189-
190-
---
184+
</details>

docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Surface probe outputs share the same output fields that are available for [Surfa
6565
- Choose descriptive names for both probes and outputs to easily identify them in post-processing.
6666
- For boundary layers, place points slightly away from the surface and project them to monitor properties at specific locations.
6767

68-
#### Efficient Probe Placement
68+
**Efficient Probe Placement:**
6969

7070
- When monitoring airfoil sections, place point arrays along chord lines at different span positions.
7171
- For symmetric geometries, consider placing probes on only one side to reduce output data volume.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,11 +169,13 @@ User defined expressions with dimensions. By default, the following expressions
169169
./05.slice-output.md
170170
./06.time-averaging-slice-output.md
171171
./07.probe-outputs.md
172-
./08.Time-averaging-probe-outputs.md
172+
./08.time-averaging-probe-outputs.md
173173
./09.surface-probe-outputs.md
174174
./10.surface-slice-output.md
175175
./11.isosurface-output.md
176176
./12.time-averaging-isosurface-output.md
177177
./13.aeroacoustic-output.md
178178
./15.streamline-output.md
179+
./00.output-fields.md
180+
./14.output-formats.md
179181
```

0 commit comments

Comments
 (0)