Skip to content

Commit 11e9105

Browse files
authored
[FXC-4940] Add surface integral output (#58)
* add surface integral output * added toctree to tools
1 parent 31eea36 commit 11e9105

4 files changed

Lines changed: 93 additions & 1 deletion

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
(surface-integral-output)=
2+
# Surface Integral Output
3+
4+
*Surface Integral Output computes surface integrals of custom user variables on selected surfaces and can optionally report moving statistics over time.*
5+
6+
---
7+
8+
## **Available Options**
9+
10+
| *Option* | *Description* | *Applicable* |
11+
|----------|---------------|--------------|
12+
| **Output fields** | Custom user variables to integrate over the assigned surfaces | always |
13+
| **Statistics function** | Optional moving statistic applied to the integrated values | always |
14+
| **Moving window size** | Window size for moving statistics (in output data points) | when **Statistics function** is not `None` |
15+
| **Start step** | Step at which to start statistics calculation | when **Statistics function** is not `None` |
16+
| **Assigned surfaces** | Surfaces used for the integral | always |
17+
18+
---
19+
20+
## **Detailed Descriptions**
21+
22+
### **Output fields**
23+
24+
*The custom user variables to integrate over the selected surfaces.*
25+
26+
- **Required** (at least one field must be selected)
27+
- **Allowed fields:** Custom user variables only
28+
- **Example:** `PressureForce`, `HingeTorqueZ`
29+
>**Note:** Surface Integral Output only accepts custom user variables. Define them in [Variable Settings](../../../05.tools/02.variable-settings.md) (Custom variables tab).
30+
31+
### **Statistics function**
32+
33+
*Optional moving statistic applied to the integrated values. When set to `None`, raw integral values are reported.*
34+
35+
- **Default:** `None`
36+
- **Options:**
37+
- `None` - No statistics processing
38+
- `Mean` - Moving average
39+
- `Min` - Minimum in the window
40+
- `Max` - Maximum in the window
41+
- `Standard deviation` - Sample standard deviation (Bessel's correction)
42+
- `Deviation` - Range (maximum minus minimum) in the window
43+
44+
### **Moving window size**
45+
46+
*The number of output data points used in the moving statistics window.*
47+
48+
- **Default:** `10`
49+
- **Minimum value:** `2`
50+
>**Note:** For steady simulations, the solver typically outputs a data point every 10 pseudo steps. For unsteady simulations, it outputs every physical step.
51+
52+
### **Start step**
53+
54+
*The number of steps to skip before statistics calculation begins.*
55+
56+
- **Default:** `0`
57+
>**Note:** For steady simulations, this value is rounded up to the nearest multiple of 10 (based on output cadence).
58+
59+
### **Assigned surfaces**
60+
61+
*The surfaces on which the integral is computed.*
62+
63+
- **Required:** Yes (at least one surface must be selected)
64+
- **Supported surface types:**
65+
- Simulation surfaces (mesh boundaries)
66+
- Imported sample surfaces
67+
>**Notes:**
68+
> - Import sample surfaces in the Entities browser before selecting them. See [Sample Surfaces](../../../04.entities-browser/10.sample-surfaces.md).
69+
> - Do not mix simulation surfaces and imported sample surfaces in a single Surface Integral Output. Create separate outputs if you need both.
70+
71+
---
72+
73+
## **Use Cases**
74+
75+
Surface Integral Output is useful for:
76+
77+
- Computing hinge torques, forces, or moments defined as custom variables
78+
- Integrating heat flux or other derived quantities over selected surfaces
79+
- Monitoring integrated quantities with moving statistics during transient simulations

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
@@ -17,6 +17,7 @@
1717
| **[Probe Outputs](./07.probe-outputs.md)** | Flow field data monitoring during simulation | Tracking convergence and flow properties |
1818
| **[Time-averaging Probe Outputs](./08.time-averaging-probe-outputs.md)** | Time-averaged monitoring data | Statistical monitoring data |
1919
| **[Surface Probe Output](./09.surface-probe-outputs.md)** | Flow field data at specific points projected onto surfaces | Point-specific surface data |
20+
| **[Surface Integral Output](./20.surface-integral-output.md)** | Surface integral of custom user variables on selected surfaces | Integrated forces, torques, and custom derived quantities |
2021
| **[Isosurface Output](./11.isosurface-output.md)** | Flow field data on surfaces of constant variable value | Visualization of vortices, shock waves |
2122
| **[Time-averaging Isosurface Output](./12.time-averaging-isosurface-output.md)** | Time-averaged flow field data on surfaces of constant variable value | Statistical analysis of vortices, shock waves |
2223
| **[Aeroacoustic Output](./13.aeroacoustic-output.md)** | Data for aeroacoustic analysis at observer positions | Noise prediction and analysis |
@@ -124,7 +125,7 @@ Each output type has specific configuration options. For detailed documentation
124125

125126
### **Custom Variables**
126127

127-
User defined expressions with dimensions. By default, the following expressions are available:
128+
User defined expressions with dimensions. Create and manage these in [Variable Settings](../../../05.tools/02.variable-settings.md). By default, the following expressions are available:
128129

129130
| Variable Name | Expression |
130131
|--------------------------------------|-------------------------------------------------|
@@ -176,6 +177,7 @@ User defined expressions with dimensions. By default, the following expressions
176177
./08.time-averaging-probe-outputs.md
177178
./09.surface-probe-outputs.md
178179
./10.surface-slice-output.md
180+
./20.surface-integral-output.md
179181
./11.isosurface-output.md
180182
./12.time-averaging-isosurface-output.md
181183
./13.aeroacoustic-output.md

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
- **[Time-averaging Probe Outputs](./02.outputs-list/08.time-averaging-probe-outputs.md)** - Time-averaged monitoring data
3333
- **[Surface Probe Output](./02.outputs-list/09.surface-probe-outputs.md)** - Flow field data at specific points projected onto surfaces
3434
- **[Surface Slice Output](./02.outputs-list/10.surface-slice-output.md)** - Flow field data on slices of surfaces
35+
- **[Surface Integral Output](./02.outputs-list/20.surface-integral-output.md)** - Surface integral of custom user variables on selected surfaces
3536
- **[Isosurface Output](./02.outputs-list/11.isosurface-output.md)** - Flow field data on surfaces of constant variable value
3637
- **[Time-averaging Isosurface Output](./02.outputs-list/12.time-averaging-isosurface-output.md)** - Time-averaged flow field data on surfaces of constant variable value
3738
- **[Aeroacoustic Output](./02.outputs-list/13.aeroacoustic-output.md)** - Data for aeroacoustic analysis at observer positions

docs/05.tools/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,13 @@ This section covers the available tools in the Flow360 webUI:
99
- [Surface Mesh Diagnostics](./03.surface-mesh-diagnostics.md) - Analyze surface mesh quality
1010
- [Volume Mesh Diagnostics](./04.volume-mesh-diagnostics.md) - Inspect volume mesh quality through slices
1111
- [Mesh Statistics Panel](./05.mesh-statistics-panel.md) - View detailed mesh statistics
12+
13+
```{toctree}
14+
:hidden:
15+
:maxdepth: 2
16+
./01.probing.md
17+
./02.variable-settings.md
18+
./03.surface-mesh-diagnostics.md
19+
./04.volume-mesh-diagnostics.md
20+
./05.mesh-statistics-panel.md
21+
```

0 commit comments

Comments
 (0)