tab in webUI.
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/18.time-averaging-force-distribution-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/18.time-averaging-force-distribution-output.md
index 63296ff..4312c65 100644
--- a/docs/02.simulation-setup/04.output/02.outputs-list/18.time-averaging-force-distribution-output.md
+++ b/docs/02.simulation-setup/04.output/02.outputs-list/18.time-averaging-force-distribution-output.md
@@ -4,7 +4,7 @@
---
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -15,7 +15,7 @@
---
-## **Global Time Stepping in Child Cases**
+## Global Time Stepping in Child Cases
When working with **child cases** (cases forked from a parent simulation), it's important to understand that the `Start step` parameter refers to the **global** time step, which is transferred from the parent case.
@@ -23,9 +23,9 @@ When working with **child cases** (cases forked from a parent simulation), it's
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Name**
+### Name
*Unique identifier for the time-averaged force distribution output.*
@@ -34,7 +34,7 @@ When working with **child cases** (cases forked from a parent simulation), it's
- **Example:** `"spanwise_avg"`, `"chordwise_avg"`
>**Note:** Output names must be unique among all force distribution outputs in the same simulation.
-### **Distribution direction**
+### Distribution direction
*The 3D unit vector that specifies the direction along which forces and moments are distributed. The vector is automatically normalized by Flow360.*
@@ -43,7 +43,7 @@ When working with **child cases** (cases forked from a parent simulation), it's
- **Example:** `[0, 1, 0]` for spanwise (y-direction), `[1, 0, 0]` for chordwise (x-direction), `[0.1, 0.9, 0]` for a custom oblique direction
>**Note:** The vector is automatically normalized, so `[0.1, 0.9, 0]` and `[0.1, 0.9, 0.0]` will result in the same normalized direction vector.
-### **Distribution type**
+### Distribution type
*Specifies whether forces and moments are output as incremental (per segment) or cumulative (integrated up to that point).*
@@ -53,7 +53,7 @@ When working with **child cases** (cases forked from a parent simulation), it's
- `"incremental"` - Outputs time-averaged force and moment contributions for each segment along the distribution direction
- `"cumulative"` - Outputs time-averaged cumulative (integrated) force and moment values along the distribution direction
-### **Start step**
+### Start step
*The physical time step at which to start calculating the time average. This parameter refers to the **global** time step, which is important for child cases (cases that inherit time stepping from a parent case).*
@@ -67,7 +67,7 @@ When working with **child cases** (cases forked from a parent simulation), it's
---
-## **Use Cases**
+## Use Cases
Time-averaging Force Distribution Output is useful for:
@@ -79,7 +79,7 @@ Time-averaging Force Distribution Output is useful for:
---
-## **Output Data**
+## Output Data
The output provides time-averaged axis-aligned components of force and moment coefficients along the specified distribution direction. Data is saved in CSV format and can be accessed through:
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/19.output-formats.md b/docs/02.simulation-setup/04.output/02.outputs-list/19.output-formats.md
index 51d92fa..3363dae 100644
--- a/docs/02.simulation-setup/04.output/02.outputs-list/19.output-formats.md
+++ b/docs/02.simulation-setup/04.output/02.outputs-list/19.output-formats.md
@@ -4,7 +4,7 @@
---
-## **Supported Formats**
+## Supported Formats
Flow360 supports the following output formats:
@@ -20,9 +20,9 @@ When creating outputs in the GUI, you can select the desired format using the **
-## **Format Details**
+## Format Details
-### **ParaView Format**
+### ParaView Format
*ParaView is an open-source, multi-platform data analysis and visualization application.*
@@ -31,7 +31,7 @@ When creating outputs in the GUI, you can select the desired format using the **
- **Slice Output**: `.vtp` files (polygonal data)
- **Isosurface Output**: `.vtp` files (polygonal data)
-### **Tecplot Format**
+### Tecplot Format
*Tecplot format is a commercial visualization format with strong CFD-specific features.*
@@ -40,7 +40,7 @@ When creating outputs in the GUI, you can select the desired format using the **
- **Slice Output**: `.szplt` files
- **Isosurface Output**: `.szplt` files
-### **CSV Format**
+### CSV Format
*CSV (Comma-Separated Values) is a simple tabular format that can be opened in Excel or any spreadsheet application.*
@@ -51,16 +51,16 @@ When creating outputs in the GUI, you can select the desired format using the **
-## **Multi-File Management**
+## Multi-File Management
-### **Single Files vs. Multiple Files**
+### Single Files vs. Multiple Files
For surface outputs, Flow360 provides options to manage multiple geometry elements:
- **Write to Single File**: When enabled, all surfaces are written to a single file
- **Write to Multiple Files**: When disabled, each surface gets its own file
-### **Time Series Management**
+### Time Series Management
For time-dependent simulations:
@@ -68,7 +68,7 @@ For time-dependent simulations:
- ParaView can automatically detect and load these as time series
- The frequency of output is controlled by the **Frequency** setting
-### **File Naming Convention**
+### File Naming Convention
Output files follow this naming convention:
@@ -77,9 +77,9 @@ Output files follow this naming convention:
Example: `Aircraft_SurfaceOutput_WingPressure_00100.vtp`
-## **Format-Specific Features**
+## Format-Specific Features
-### **ParaView-Specific Features**
+### ParaView-Specific Features
- Multi-block datasets for complex geometries
- Easy visualization of vector fields
@@ -88,7 +88,7 @@ Example: `Aircraft_SurfaceOutput_WingPressure_00100.vtp`
- Volume rendering for 3D scalar fields
- Python scripting for automation
-### **Tecplot-Specific Features**
+### Tecplot-Specific Features
- Specialized aerodynamic analysis tools
- Advanced XY plotting
@@ -98,7 +98,7 @@ Example: `Aircraft_SurfaceOutput_WingPressure_00100.vtp`
- Multi-frame layouts
-## **File Size Considerations**
+## File Size Considerations
Output file sizes can vary significantly depending on:
@@ -114,7 +114,7 @@ To manage file sizes:
- Consider using slices or isosurfaces instead of full volume outputs
- Use probes for tracking key variables over time
-## **Post-Processing Workflow**
+## Post-Processing Workflow
1. **Generate Outputs**: Configure desired outputs in Flow360
2. **Load Files**: Open the generated files in ParaView, Tecplot, or other compatible tools
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/20.surface-integral-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/20.surface-integral-output.md
index 6f146bf..98e7f47 100644
--- a/docs/02.simulation-setup/04.output/02.outputs-list/20.surface-integral-output.md
+++ b/docs/02.simulation-setup/04.output/02.outputs-list/20.surface-integral-output.md
@@ -5,7 +5,7 @@
---
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -17,9 +17,9 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Output fields**
+### Output fields
*The custom user variables to integrate over the selected surfaces.*
@@ -28,7 +28,7 @@
- **Example:** `PressureForce`, `HingeTorqueZ`
>**Note:** Surface Integral Output only accepts custom user variables. Define them in [Variable Settings](../../../05.tools/02.variable-settings.md) (Custom variables tab).
-### **Statistics function**
+### Statistics function
*Optional moving statistic applied to the integrated values. When set to `None`, raw integral values are reported.*
@@ -41,7 +41,7 @@
- `Standard deviation` - Sample standard deviation (Bessel's correction)
- `Deviation` - Range (maximum minus minimum) in the window
-### **Moving window size**
+### Moving window size
*The number of output data points used in the moving statistics window.*
@@ -49,14 +49,14 @@
- **Minimum value:** `2`
>**Note:** For steady simulations, the solver typically outputs a data point every 10 pseudo steps. For unsteady simulations, it outputs every physical step.
-### **Start step**
+### Start step
*The number of steps to skip before statistics calculation begins.*
- **Default:** `0`
>**Note:** For steady simulations, this value is rounded up to the nearest multiple of 10 (based on output cadence).
-### **Assigned surfaces**
+### Assigned surfaces
*The surfaces on which the integral is computed.*
@@ -70,7 +70,7 @@
---
-## **Use Cases**
+## Use Cases
Surface Integral Output is useful for:
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/README.md b/docs/02.simulation-setup/04.output/02.outputs-list/README.md
index d883252..49475f1 100644
--- a/docs/02.simulation-setup/04.output/02.outputs-list/README.md
+++ b/docs/02.simulation-setup/04.output/02.outputs-list/README.md
@@ -4,7 +4,7 @@
---
-## **Available Output Types**
+## Available Output Types
| *Output Type* | *Description* | *Use Case* |
|---------------|---------------|------------|
@@ -29,7 +29,7 @@
---
-## **Additional Outputs Available Through Python API**
+## Additional Outputs Available Through Python API
| *Output Type* | *Description* | *Use Case* |
|---------------|---------------|------------|
@@ -37,102 +37,13 @@
---
-## **Common Settings**
+## Reference Documentation
-### **Output Fields**
+- **[Available Output Fields](00.output-fields.md)** - Complete list of flow variables by output type
+- **[Scaling Values and Nondimensionalization](00.scaling-values.md)** - Reference values for converting to physical units
+- **[Output Formats](19.output-formats.md)** - Supported file formats (ParaView, Tecplot, CSV)
-*The flow variables to include in the output.*
-
-- **Default:** Varies by output type
-- **Example:** `["Cp", "Cf", "Mach"]`
->**Note:** See [Output Fields and Nondimensional Values](00.output-fields.md) for details on available fields.
-
-### **Frequency**
-
-*How often to write output files (in number of time steps).*
-
-- **Default:** `-1` (output only at the end of simulation)
-- **Example:** `100` (output every 100 time steps)
->**Note:** Increase for animations, decrease for storage efficiency.
-
-### **Frequency Offset**
-
-*The time step at which to start writing output.*
-
-- **Default:** `0` (start at beginning of simulation)
-- **Example:** `1000` (start after 1000 time steps)
->**Note:** Controls when output generation begins.
-
-### **Output Format**
-
-*The file format for output data.*
-
-- **Default:** `paraview`
-- **Options:**
- - `paraview`
- - `tecplot`
- - `both`
->**Note:** Choose the format that best suits your post-processing workflow.
-
-## 📁 **Output File Formats**
-
-Flow360 supports multiple output file formats:
-
-- **Paraview** (.vtu, .vtp) - For visualization in ParaView
-- **Tecplot** (.szplt) - For visualization in Tecplot
-- **CSV** - For tabular data
-
-For more information about output file formats, see the [Output Formats](19.output-formats.md) page.
-
-## **Detailed Settings**
-
-Each output type has specific configuration options. For detailed documentation on configuring each type of output, refer to the links in the table above.
-
----
-
-## Available Output Fields
-
-### **Universal Variables** (non-dimensional)
-
-- `Cp` - Coefficient of pressure
-- `Cpt` - Coefficient of total pressure
-- `gradW` - Gradient of primitive solution
-- `kOmega` - k and omega
-- `Mach` - Mach number
-- `mut` - Turbulent viscosity
-- `mutRatio` - Turbulent viscosity and freestream dynamic viscosity ratio
-- `nuHat` - Spalart-Almaras variable
-- `primitiveVars` - Density, velocities (u,v,w), and pressure
-- `qcriterion` - Q criterion for vortex identification
-- `residualNavierStokes` - N-S residual
-- `residualTransition` - Transition residual
-- `residualTurbulence` - Turbulence residual
-- `s` - Entropy
-- `solutionNavierStokes` - N-S solution
-- `solutionTransition` - Transition solution
-- `solutionTurbulence` - Turbulence solution
-- `T` - Temperature
-- `velocity` - Velocity vector
-- `velocity_magnitude` - Magnitude of velocity vector
-- `pressure` - Pressure
-- `vorticity` - Vorticity
-- `vorticityMagnitude` - Vorticity Magnitude
-- `wallDistance` - Wall distance
-- `numericalDissipationFactor` - NumericalDissipationFactor sensor
-- `residualHeatSolver` - Heat equation residual
-- `VelocityRelative` - Velocity with respect to non-inertial frame
-- `lowMachPreconditionerSensor` - Low-Mach preconditioner factor
-
-### **Custom Variables**
-
-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:
-
-| Variable Name | Expression |
-|--------------------------------------|-------------------------------------------------|
-| `velocity_with_units` | `solution.velocity` |
-| `velocity_magnitude_with_units` | `math.magnitude(solution.velocity)` |
-| `pressure_with_units` | `solution.pressure` |
-| `wall_shear_stress_magnitude_with_units` | `solution.wall_shear_stress_magnitude` |
+For configuration details specific to each output type, see the individual output pages linked in the table above.
---
@@ -167,6 +78,8 @@ User defined expressions with dimensions. Create and manage these in [Variable S
```{toctree}
:hidden:
:maxdepth: 3
+./00.output-fields.md
+./00.scaling-values.md
./01.volume-output.md
./02.time-averaging-volume-output.md
./03.surface-output.md
@@ -186,6 +99,5 @@ User defined expressions with dimensions. Create and manage these in [Variable S
./16.force-output.md
./17.force-distribution-output.md
./18.time-averaging-force-distribution-output.md
-./00.output-fields.md
./19.output-formats.md
```
\ No newline at end of file
diff --git a/docs/02.simulation-setup/04.output/README.md b/docs/02.simulation-setup/04.output/README.md
index 8038d31..a96ce07 100644
--- a/docs/02.simulation-setup/04.output/README.md
+++ b/docs/02.simulation-setup/04.output/README.md
@@ -1,52 +1,23 @@
# Output
-*A section responsible for the definitions of simulation outputs.*
+*Configure simulation outputs including which flow variables to save, where to save them, output formats, and reference dimensions for coefficient calculations.*
-## **Contents**
+## Contents
| *Settings group* | *Description* |
|--------------------|-----------------------|
-| [**Reference dimensions**](./01.reference-dimensions.md) | Form for filling in dimensions that are used for force coefficients calculation. |
-| [**Outputs list**](./02.outputs-list/README.md) | A list containing all outputs to generate from the simulation |
+| [**Reference dimensions**](./01.reference-dimensions.md) | Reference dimensions used for force and moment coefficient calculations |
+| [**Outputs list**](./02.outputs-list/README.md) | Configure all outputs to generate from the simulation, including available output fields |
+| [**Available Output Fields**](./02.outputs-list/00.output-fields.md) | Complete reference of all flow variables organized by output type |
+| [**Scaling Values and Nondimensionalization**](./02.outputs-list/00.scaling-values.md) | Reference values for nondimensionalization and converting to physical units |
---
-## **Detailed Descriptions**
-
-### **[Reference dimensions](./01.reference-dimensions.md)**
-
-*Form for defining dimensions used in force coefficient calculations. Specifies reference area, length, and other geometric parameters essential for computing aerodynamic coefficients and non-dimensionalizing results.*
-
-### **[Outputs list](./02.outputs-list/README.md)**
-
-*Comprehensive list of all outputs to generate from the simulation. Controls what data is generated during and after simulation runs, including flow variables, output locations, frequencies, and file formats.*
-
-**Subsections:**
-- **[Volume Output](./02.outputs-list/01.volume-output.md)** - Flow field data throughout the computational volume
-- **[Time-averaging Volume Output](./02.outputs-list/02.time-averaging-volume-output.md)** - Time-averaged flow field data throughout the volume
-- **[Surface Output](./02.outputs-list/03.surface-output.md)** - Flow field data on geometry or volume mesh boundaries
-- **[Time-averaging Surface Output](./02.outputs-list/04.time-averaging-surface-output.md)** - Time-averaged flow field data on surfaces
-- **[Slice Output](./02.outputs-list/05.slice-output.md)** - Flow field data on user-defined slice planes
-- **[Time-averaging Slice Output](./02.outputs-list/06.time-averaging-slice-output.md)** - Time-averaged flow field data on slice planes
-- **[Probe Outputs](./02.outputs-list/07.probe-outputs.md)** - Flow field data monitoring during simulation
-- **[Time-averaging Probe Outputs](./02.outputs-list/08.time-averaging-probe-outputs.md)** - Time-averaged monitoring data
-- **[Surface Probe Output](./02.outputs-list/09.surface-probe-outputs.md)** - Flow field data at specific points projected onto surfaces
-- **[Surface Slice Output](./02.outputs-list/10.surface-slice-output.md)** - Flow field data on slices of surfaces
-- **[Surface Integral Output](./02.outputs-list/20.surface-integral-output.md)** - Surface integral of custom user variables on selected surfaces
-- **[Isosurface Output](./02.outputs-list/11.isosurface-output.md)** - Flow field data on surfaces of constant variable value
-- **[Time-averaging Isosurface Output](./02.outputs-list/12.time-averaging-isosurface-output.md)** - Time-averaged flow field data on surfaces of constant variable value
-- **[Aeroacoustic Output](./02.outputs-list/13.aeroacoustic-output.md)** - Data for aeroacoustic analysis at observer positions
-- **[Streamline Output](./02.outputs-list/14.streamline-output.md)** - Visualization of 3D flow structures
-- **[Time-averaging Streamline Output](./02.outputs-list/15.time-averaging-streamline-output.md)** - Time-averaged visualization of 3D flow structures
-- **[Force Output](./02.outputs-list/16.force-output.md)** - Force and moment coefficient outputs with optional statistics
-- **[Force Distribution Output](./02.outputs-list/17.force-distribution-output.md)** - Custom force and moment distribution along a specified direction
-- **[Time-averaging Force Distribution Output](./02.outputs-list/18.time-averaging-force-distribution-output.md)** - Time-averaged custom force and moment distribution
-- **[Output Formats](./02.outputs-list/19.output-formats.md)** - File format specifications for output data
-
```{toctree}
:hidden:
:maxdepth: 3
./01.reference-dimensions.md
./02.outputs-list/README.md
+./02.outputs-list/00.output-fields.md
+./02.outputs-list/00.scaling-values.md
```
-
diff --git a/docs/02.simulation-setup/README.md b/docs/02.simulation-setup/README.md
index 533a85b..541cffa 100644
--- a/docs/02.simulation-setup/README.md
+++ b/docs/02.simulation-setup/README.md
@@ -2,7 +2,7 @@
*This section covers all aspects of setting up a simulation in Flow360, including flow conditions, meshing, solver configuration, and output settings.*
-## **Contents**
+## Contents
| *Section* | *Description* |
|-------------|-----------------|
@@ -13,7 +13,7 @@
---
-## **Detailed Subsections**
+## Detailed Subsections
- **Flow Conditions:**
- [Operating condition](./01.flow-conditions/README.md): Define physical values of fluid properties
@@ -35,6 +35,8 @@
- **Output:**
- [Reference dimensions](./04.output/01.reference-dimensions.md): Dimensions for force coefficient calculations
- [Output list](./04.output/02.outputs-list/README.md): All outputs to generate from the simulation
+ - [Available Output Fields](./04.output/02.outputs-list/00.output-fields.md): Complete reference of flow variables by output type
+ - [Scaling Values](./04.output/02.outputs-list/00.scaling-values.md): Reference values for nondimensionalization
```{toctree}
diff --git a/docs/03.analysis/01.dashboard.md b/docs/03.analysis/01.dashboard.md
index 6f78ef5..a7eb505 100644
--- a/docs/03.analysis/01.dashboard.md
+++ b/docs/03.analysis/01.dashboard.md
@@ -4,7 +4,7 @@
---
-## **Nonlinear Residuals Monitor**
+## Nonlinear Residuals Monitor
The nonlinear residuals monitor displays the convergence history of the simulation, presenting both absolute and relative residuals for key flow variables:
@@ -22,13 +22,13 @@ The residuals are plotted on a logarithmic scale against physical time steps, al
- Assess solution stability
- Determine when steady-state has been achieved
-### **Interpretation Guide**
+### Interpretation Guide
- Decreasing residuals indicate proper convergence
- Oscillatory behavior may suggest physical unsteadiness or numerical issues
- Plateauing residuals might indicate reaching machine precision or solution stagnation
-### **Interactive Features**
+### Interactive Features
- Toggle between absolute and relative non-linear residual views
- Select and deselect individual residuals
@@ -37,23 +37,23 @@ The residuals are plotted on a logarithmic scale against physical time steps, al
---
-## **Forces and Moments**
+## Forces and Moments
-### **Lift and Drag Coefficients**
+### Lift and Drag Coefficients
- `CL`: Lift coefficient
- `CD`: Drag coefficient
-### **Force Coefficients in Component Directions**
+### Force Coefficients in Component Directions
- `CFx`: X-direction force coefficient
- `CFy`: Y-direction force coefficient
- `CFz`: Z-direction force coefficient
-### **Moment Coefficients**
+### Moment Coefficients
- `CMx`: Rolling moment coefficient
- `CMy`: Pitching moment coefficient
- `CMz`: Yawing moment coefficient
-### **Statistics**
+### Statistics
The dashboard provides statistical data for force coefficients, averaged over the last 10% of steps. This feature helps in:
- Determining final converged values
@@ -61,7 +61,7 @@ The dashboard provides statistical data for force coefficients, averaged over th
- Quantifying solution uncertainty
- Making informed decisions about simulation completion
-### **Time history**
+### Time history
Each coefficient is plotted against physical time steps, enabling:
- Real-time monitoring of aerodynamic performance
@@ -69,7 +69,7 @@ Each coefficient is plotted against physical time steps, enabling:
- Identification of periodic behaviors or instabilities
- Verification of expected aerodynamic characteristics
-### **Interactive Features**
+### Interactive Features
- Click on a plot to enlarge it
diff --git a/docs/03.analysis/02.convergence.md b/docs/03.analysis/02.convergence.md
index b1ecdc4..474323d 100644
--- a/docs/03.analysis/02.convergence.md
+++ b/docs/03.analysis/02.convergence.md
@@ -4,7 +4,7 @@
---
-## **Available Plots**
+## Available Plots
| *Plot Type* | *Description* | *Purpose* |
|---------------|-----------------|-------------|
@@ -15,11 +15,11 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
Each convergence plot provides specific insights into the simulation:
-### **Nonlinear**
+### Nonlinear
- View Options: Absolute or Relative scaling
- Variables tracked:
- `cont`: Continuity equation
@@ -30,7 +30,7 @@ Each convergence plot provides specific insights into the simulation:
- `omega`: Turbulence model - specific dissipation rate (SST)
- Logarithmic scale display
-### **Linear**
+### Linear
- Variables tracked:
- `cont`: Continuity equation
- `momx/y/z`: Momentum equations
@@ -40,13 +40,13 @@ Each convergence plot provides specific insights into the simulation:
- `omega`: Turbulence model - specific dissipation rate (SST)
- Logarithmic scale display
-### **CFL**
+### CFL
- Variables tracked:
- `NavierStokes_cfl`: Main flow equations
- `SpallartAllmaras_cfl`: Turbulence (when applicable)
- Linear scale display
-### **Minmax**
+### Minmax
- Variables tracked:
- min density
@@ -58,7 +58,7 @@ Each convergence plot provides specific insights into the simulation:
- Logarithmic scale display
- Obtain more information in a tabular form by clicking on a point in the plot
-## **Interactive Features**
+## Interactive Features
- Toggle visibility of individual variables
- Select time range using the bottom timeline
diff --git a/docs/03.analysis/03.monitor.md b/docs/03.analysis/03.monitor.md
index 6e7fd86..2b1b11d 100644
--- a/docs/03.analysis/03.monitor.md
+++ b/docs/03.analysis/03.monitor.md
@@ -2,7 +2,7 @@
*This document describes how to set up and use monitors in Flow360 simulations. Monitors allow you to track flow field variables at specific locations during the simulation, providing real-time feedback on how your solution is developing.*
-## **Available Options**
+## Available Options
| *Option* | *Description* |
|------------|-----------------|
@@ -15,9 +15,9 @@
| **Force distribution (X)** | Force distribution along the x-axis |
| **Actuator Disk** | Forces and moments for actuator disk models |
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Total Forces**
+### Total Forces
*Total Forces monitor calculates the integrated forces and moments over all surfaces in the computational domain.*
@@ -33,7 +33,7 @@
- Calculates lift, drag, and moment coefficients
- Available for both steady and unsteady simulations
-### **Forces by surface**
+### Forces by surface
*Forces by Surface monitor provides detailed force and moment distribution over individual surfaces.*
@@ -50,7 +50,7 @@
- Provides local force and moment coefficients
- Supports both steady and unsteady simulations
-### **Heat transfer by surface**
+### Heat transfer by surface
*Heat Transfer by Surface monitor calculates heat transfer distribution over surfaces.*
@@ -67,7 +67,7 @@
- Useful for thermal analysis
- Available for both steady and unsteady simulations
-### **BET (Blade Element Theory) Analysis**
+### BET (Blade Element Theory) Analysis
BET analysis provides two types of monitors for rotor analysis:
@@ -96,7 +96,7 @@ BET analysis provides two types of monitors for rotor analysis:
| **Y-axis** | `ThrustCoeff`
`TorqueCoeff` |
| **Series** | Blades available for selected Disk |
-### **Force distribution**
+### Force distribution
Force distribution monitors provide spanwise and chordwise force distributions:
@@ -124,7 +124,7 @@ Force distribution monitors provide spanwise and chordwise force distributions:
| **Y-axis** | `CD_per_length`
`Cumulative_CD_Curve` |
| **Series** | Available wall-type surfaces |
-### **Actuator Disk**
+### Actuator Disk
*Actuator Disk monitor calculates forces and moments for actuator disk models.*
@@ -140,7 +140,7 @@ Force distribution monitors provide spanwise and chordwise force distributions:
- Useful for simplified rotor modeling
- Available for both steady and unsteady simulations
-## **Available Output Fields**
+## Available Output Fields
The following table lists all available output fields that can be monitored in Flow360, along with their descriptions and units:
diff --git a/docs/03.analysis/04.visualization.md b/docs/03.analysis/04.visualization.md
index c988b0f..ffafabb 100644
--- a/docs/03.analysis/04.visualization.md
+++ b/docs/03.analysis/04.visualization.md
@@ -4,7 +4,7 @@
---
-## **Interface Overview**
+## Interface Overview
| *Component* | *Description* |
|--------------|-----------------|
@@ -15,9 +15,9 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Surface Visualization**
+### Surface Visualization
*Display flow field variables on geometric surfaces of the model.*
@@ -27,7 +27,7 @@ Selectable fields depend on the surface output configuration in simulation setti
---
-### **Slice Visualization**
+### Slice Visualization
*Create 2D cross-sectional views of the flow field for detailed examination of flow features.*
@@ -37,7 +37,7 @@ Selectable fields depend on the slice output configuration. For a complete list,
---
-### **Isosurface Visualization**
+### Isosurface Visualization
*Generate 3D surfaces of constant value for selected flow variables.*
@@ -45,7 +45,7 @@ Selectable fields depend on the slice output configuration. For a complete list,
Selectable fields depend on the isosurface output configuration. For a complete list, refer to [isosurface output](../02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md).
-### **Streamline Visualisation**
+### Streamline Visualisation
*Show streamlines through given points.*
@@ -60,15 +60,15 @@ Visualisation of the streamlines can be controlled through the following options
---
-## **Colormap control**
+## Colormap control
*Colormaps are color schemes used to represent different values of a flow variable.*
-### **Controls**
+### Controls
- Range and scale customization: the scale can be chosen to be logarithmic and value ranges can be set using the slider.
- Clipping (advanced): allows for visualising only a specific range of values of the field variable.
-### **Color schemes**
+### Color schemes
*By clicking on the colormap button, you will enter the colormap customization menu.*
diff --git a/docs/03.analysis/05.aeroacoustic.md b/docs/03.analysis/05.aeroacoustic.md
index 9255654..02c8358 100644
--- a/docs/03.analysis/05.aeroacoustic.md
+++ b/docs/03.analysis/05.aeroacoustic.md
@@ -1,10 +1,10 @@
-# **Aeroacoustic Interface**
+# Aeroacoustic Interface
*The Aeroacustic analysis interface provides comprehensive tools for analyzing acoustic data through various representations and processing methods.*
---
-## **Available Plots**
+## Available Plots
| *View Type* | *Description* |
|---------------|-----------------|
@@ -16,30 +16,30 @@
---
-## **Processing Options**
+## Processing Options
-### **Observers**
+### Observers
List of selectable observers based on their group for which the analysis will be performed.
-### **Boundaries**
+### Boundaries
List of selectable boundaries for which the analysis will be performed. Total is selected by default and refers to the aggregate of all boundaries.
-### **Frequency Range**
+### Frequency Range
| *Parameter* | *Description* | *Default Range* |
|---------------|----------------|------------------|
| **Frequency range** | Range of frequencies to perform the analysis | `10 - 10000` |
-### **Averaging Settings**
+### Averaging Settings
| *Option* | *Description* |
|------------|----------------|
| **Number of segments** | Number of segments used for averaging |
| **Segmentation method** | Method for dividing the signal into multiple segments for averaging: RPM-based or Time interval-based |
-### **Signal Processing Options**
+### Signal Processing Options
| *Option* | *Description* |
|------------|----------------|
@@ -47,7 +47,7 @@ List of selectable boundaries for which the analysis will be performed. Total is
| **Use A-weighting** | Apply A-weighting curve to better represent human hearing perception |
| **Welch method** | Apply Welch method for calculating spectra |
-### **Welch Method Parameters**
+### Welch Method Parameters
| *Parameter* | *Description* | *Options* |
|---------------|----------------|-------------|
@@ -57,9 +57,9 @@ List of selectable boundaries for which the analysis will be performed. Total is
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Frequency Range Configuration**
+### Frequency Range Configuration
The frequency range setting determines the span of frequencies included in the acoustic analysis:
@@ -67,7 +67,7 @@ The frequency range setting determines the span of frequencies included in the a
>**Note:** This range is used for the analysis, not just the display.
-#### **Averaging Configuration**
+#### Averaging Configuration
The averaging system allows for detailed control over how the acoustic data is processed:
@@ -76,7 +76,7 @@ The averaging system allows for detailed control over how the acoustic data is p
- **RPM-based:** Suitable for rotating machinery analysis
- **Time interval-based:** General purpose, with configurable time step
-#### **Welch Method Settings**
+#### Welch Method Settings
It can be used for calculating spectra.
diff --git a/docs/03.analysis/README.md b/docs/03.analysis/README.md
index 04af9cb..67f7217 100644
--- a/docs/03.analysis/README.md
+++ b/docs/03.analysis/README.md
@@ -4,7 +4,7 @@
---
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Purpose* |
|------------|-----------------|-------------|
@@ -16,9 +16,9 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Dashboard**
+### Dashboard
*The Dashboard provides an interactive overview of your simulation's progress and key performance metrics.*
@@ -28,7 +28,7 @@
- Simulation status overview
- Resource utilization metrics
-### **Convergence**
+### Convergence
*Convergence analysis tools help assess the quality and stability of your simulation results.*
@@ -39,7 +39,7 @@
- State variable bounds
- Maximum residual location tracking
-### **Monitor**
+### Monitor
*Monitors enable detailed tracking of flow field variables at specific locations during simulation.*
@@ -52,7 +52,7 @@
- Actuator Disk metrics
-### **Visualization**
+### Visualization
*Advanced visualization tools for analyzing flow field data and patterns.*
@@ -64,7 +64,7 @@
- Isosurface generation
- Streamline visualization
-### **Aeroacoustic**
+### Aeroacoustic
*Specialized tools for acoustic analysis and noise prediction.*
diff --git a/docs/04.entities-browser/01.geometry/01.edges.md b/docs/04.entities-browser/01.geometry/01.edges.md
index 97c812e..fb9639a 100644
--- a/docs/04.entities-browser/01.geometry/01.edges.md
+++ b/docs/04.entities-browser/01.geometry/01.edges.md
@@ -8,9 +8,9 @@ In Flow360, edges can be used to:
- Control the growth of anisotropic layers
- Mark important geometric features like leading and trailing edges
-## **Edge Selection**
+## Edge Selection
You can select edges in the geometry editor using selection by clicking on the edge. You can adjust your selection options on the central toolbar.
-## **Edge Grouping**
+## Edge Grouping
Edge grouping allows you to organize and manage edges in your geometry. You can group edges based on their attributes such as `edgeId`, `edgeName`. The attributes must be assigned in your CAD system.
diff --git a/docs/04.entities-browser/01.geometry/02.faces.md b/docs/04.entities-browser/01.geometry/02.faces.md
index ae7efa9..33553ec 100644
--- a/docs/04.entities-browser/01.geometry/02.faces.md
+++ b/docs/04.entities-browser/01.geometry/02.faces.md
@@ -8,14 +8,14 @@ Faces in Flow360 can be used for the following things:
- Specify boundary conditions
- Group important geometric features like wings of an airplane or underbody of a car.
-## **Face Selection**
+## Face Selection
You can select faces in the geometry editor using selection by clicking on the face. You can adjust your selection options on the central toolbar.
-## **Grouping Faces**
+## Grouping Faces
Face grouping allows you to organize and manage faces in your geometry. Face grouping is based on metadata associated with each face in your CAD geometry file.
-### **CAD Face Metadata**
+### CAD Face Metadata
CAD geometry files contain metadata associated with each face that Flow360 processes and uses for grouping:
@@ -31,7 +31,7 @@ CAD geometry files contain metadata associated with each face that Flow360 proce
> **Note:** CAD face metadata (name, color, material, attributes) is only available for B-rep files (e.g., STEP, IGES, SolidWorks, CATIA). This metadata will not be available when starting from STL or UGrid files.
-### **Flow360-Specific Concepts**
+### Flow360-Specific Concepts
Flow360 provides additional grouping concepts that are not part of the CAD metadata:
@@ -40,7 +40,7 @@ Flow360 provides additional grouping concepts that are not part of the CAD metad
- **For discrete files** (e.g., STL, UGrid): The actual face name from the file. For example, in an STL file, this would be the name of a solid or face as defined in the file.
- **groupByBodyId**: A Flow360 concept used for grouping faces by their body identifier within the CAD model structure.
-### **Using Face Attributes for Grouping**
+### Using Face Attributes for Grouping
In the **Faces grouping** dropdown in the Grouping view, you can select how to group faces based on these attributes. The available grouping options depend on what metadata is present in your CAD file. Common grouping methods include:
diff --git a/docs/04.entities-browser/01.geometry/README.md b/docs/04.entities-browser/01.geometry/README.md
index b72c3e4..4d1778c 100644
--- a/docs/04.entities-browser/01.geometry/README.md
+++ b/docs/04.entities-browser/01.geometry/README.md
@@ -7,10 +7,10 @@
In Flow360 you can do the following with geometry:
-### **Views**
+### Views
Flow360 provides three different ways to view and organize geometric entities using the view buttons at the top of the Geometry group:
-#### **Grouping View**
+#### Grouping View
In this view, entities are organized by their functional groups:
- **Edges grouping** - Controls how edges are grouped based on tags/names from the imported geometry.
@@ -43,7 +43,7 @@ In this view, entities are organized by their functional groups:
- **Color** - Set a solid color using the color picker or hex code.
- **Material** - Apply a material appearance for realistic visualization.
-#### **Tree View**
+#### Tree View
In this view, entities are organized in a hierarchical structure:
- **Bodies** - Shows all bodies available in the geometry.
@@ -52,7 +52,7 @@ In this view, entities are organized in a hierarchical structure:
-### **Selection**
+### Selection
*Allows for interactive selection of geometric entities.*
There are 4 entity selection modes that define whether a given entity can be selected or not:
@@ -61,7 +61,7 @@ There are 4 entity selection modes that define whether a given entity can be sel
- Select face
- Select volume
-### **Grouping**
+### Grouping
*Grouping is based on geometric attributes and allows for organizing multiple elements into a single group for easier handling and assignment.*
As described in the Views section, you can control how edges and faces are grouped using the "Edges grouping" and "Faces grouping" options in the Grouping view. Proper grouping of geometric entities facilitates:
@@ -70,17 +70,17 @@ As described in the Views section, you can control how edges and faces are group
- Organized visualization of complex geometries
- Simplified selection of related entities
-### **Visualization**
+### Visualization
*Geometric entities are visualized in real-time. You can toggle on/off the visibility of grouped edges and faces.*
-### **Statistics**
+### Statistics
To view detailed statistics about your geometry, click the **Geometry Stats** button located to the right of the "Geometry" group heading. This opens a dialog displaying comprehensive statistics for the geometry in your project, including:
- Number of faces and edges
- Surface area calculations
- Other relevant geometric metrics
-## **Geometric Entities**
+## Geometric Entities
Flow360 recognizes two primary types of geometric entities:
@@ -97,7 +97,7 @@ Faces are surfaces that constitute the boundaries of the computational domain. T
- Organizing geometric features into logical groups
-## **Geometric Considerations**
+## Geometric Considerations
When preparing a simulation, keep in mind:
diff --git a/docs/04.entities-browser/02.surface-mesh.md b/docs/04.entities-browser/02.surface-mesh.md
index 05bacb8..9695944 100644
--- a/docs/04.entities-browser/02.surface-mesh.md
+++ b/docs/04.entities-browser/02.surface-mesh.md
@@ -8,6 +8,6 @@ A surface mesh in Flow360 consists of surface elements in three-dimensional spac
- [Boundaries](./03.volume-mesh/02.boundaries.md): Surfaces that define the edges of computational domains and interfaces between zones
-## **Mesh Requirements**
+## Mesh Requirements
Flynn360 volume mesher supports surface meshes with triangular surface elements.
\ No newline at end of file
diff --git a/docs/04.entities-browser/03.volume-mesh/01.zones.md b/docs/04.entities-browser/03.volume-mesh/01.zones.md
index 9a009ca..852b0d2 100644
--- a/docs/04.entities-browser/03.volume-mesh/01.zones.md
+++ b/docs/04.entities-browser/03.volume-mesh/01.zones.md
@@ -6,7 +6,7 @@ In Flow360 zone names are inferred directly from the volume mesh file and cannot
These zones contain within them [boundaries](./02.boundaries.md), which are used to set up the simulation.
-## **Types of volume mesh zones**
+## Types of volume mesh zones
Zones can be assigned one of three types of 3D models:
diff --git a/docs/04.entities-browser/03.volume-mesh/02.boundaries.md b/docs/04.entities-browser/03.volume-mesh/02.boundaries.md
index 4bf7dd2..90dba98 100644
--- a/docs/04.entities-browser/03.volume-mesh/02.boundaries.md
+++ b/docs/04.entities-browser/03.volume-mesh/02.boundaries.md
@@ -6,7 +6,7 @@ Flow360 imports boundary names directly from the mesh input file and they cannot
Boundaries for a volume mesh exist within their parent [zones](./01.zones.md).
-## **Types of boundary conditions**
+## Types of boundary conditions
Boundaries can be assigned one of the following [Boundary conditions](../../02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md):
@@ -19,6 +19,6 @@ Boundaries can be assigned one of the following [Boundary conditions](../../02.s
- [Slip wall](../../02.simulation-setup/03.flow-solver/01.boundary-conditions/07.slip-wall.md)
- Interface (assigned automatically)
-## **Boundaries in outputs**
+## Boundaries in outputs
When assigning [Surface output](../../02.simulation-setup/04.output/02.outputs-list/03.surface-output.md) or [Surface probe output](../../02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md), boundaries for which the output fields will be computed, have to be specified.
diff --git a/docs/04.entities-browser/03.volume-mesh/README.md b/docs/04.entities-browser/03.volume-mesh/README.md
index bf9faa7..0ef52e7 100644
--- a/docs/04.entities-browser/03.volume-mesh/README.md
+++ b/docs/04.entities-browser/03.volume-mesh/README.md
@@ -7,7 +7,7 @@ A volume mesh in Flow360 consists of three-dimensional elements that discretize
- [Zones](./01.zones.md): Distinct regions within the volume mesh, each potentially governed by different physical models
- [Boundaries](./02.boundaries.md): Surfaces that define the edges of computational domains and interfaces between zones
-## **Mesh Requirements**
+## Mesh Requirements
Flow360 supports unstructured volume meshes with the following element types:
diff --git a/docs/04.entities-browser/04.volumes/00.box.md b/docs/04.entities-browser/04.volumes/00.box.md
index c5a6553..215ecbd 100644
--- a/docs/04.entities-browser/04.volumes/00.box.md
+++ b/docs/04.entities-browser/04.volumes/00.box.md
@@ -2,7 +2,7 @@
*A box is a rectangular prism defined by its center point and size (dimensions). Boxes can be oriented in three-dimensional space using one of two transformation methods.*
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -15,23 +15,23 @@
| [**Angle of rotation**](#angle-of-rotation) | Rotation angle around the axis | **Transform methods** is `Axis & Angle` |
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Name**
+### Name
*Identifier for the box volume entity.*
- **Required**
>**Note:** Names are not required to be unique, but using descriptive unique names is recommended for clarity.
-### **Center**
+### Center
*Three-dimensional coordinates (X, Y, Z) defining the center point of the box.*
- **Required**
- **Units:** Length
-### **Size**
+### Size
*Three-dimensional dimensions (length, width, height) of the box along its principal axes.*
@@ -41,11 +41,11 @@
---
-### **Transform methods**
+### Transform methods
Boxes can be oriented in three-dimensional space using one of two methods:
-#### **Axes**
+#### Axes
*Defines the box orientation using two orthogonal vectors.*
@@ -56,18 +56,18 @@ Boxes can be oriented in three-dimensional space using one of two methods:
> - Second axis (row 2) defines the secondary direction (aligns with size Y)
> - Third axis is automatically computed to complete the right-handed coordinate system
-#### **Axis & Angle**
+#### Axis & Angle
*Defines the box orientation using a rotation axis and angle from the default orientation.*
-##### **Axis of rotation**
+##### Axis of rotation
*The axis vector (X, Y, Z) around which the box is rotated.*
- **Default:** `(0, 0, 1)`
>**Note:** The axis is normalized internally.
-##### **Angle of rotation**
+##### Angle of rotation
*The angle of rotation around the specified axis.*
diff --git a/docs/04.entities-browser/04.volumes/01.cylinder.md b/docs/04.entities-browser/04.volumes/01.cylinder.md
index 1ff9b1f..1337223 100644
--- a/docs/04.entities-browser/04.volumes/01.cylinder.md
+++ b/docs/04.entities-browser/04.volumes/01.cylinder.md
@@ -2,7 +2,7 @@
*A cylinder is a three-dimensional geometric shape with a circular cross-section, defined by its center, axis direction, height, and radius.*
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -14,16 +14,16 @@
| [**Height**](#height) | Length along the central axis | always |
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Name**
+### Name
*Identifier for the cylinder volume entity.*
- **Required**
>**Note:** Names are not required to be unique, but using descriptive unique names is recommended.
-### **Center**
+### Center
*Three-dimensional coordinates (X, Y, Z) defining the center point of the cylinder.*
@@ -31,7 +31,7 @@
- **Units:** Length
>**Note:** The center is located at the midpoint of the cylinder's height.
-### **Axis**
+### Axis
*Direction vector (X, Y, Z) defining the orientation of the cylinder's central axis.*
@@ -40,14 +40,14 @@
> - The vector is normalized internally
> - The height extends equally in both directions from the center along this axis
-### **Radius**
+### Radius
*The distance from the central axis to the outer cylindrical surface.*
- **Required**
- **Units:** Length
-### **Inner radius**
+### Inner radius
*The distance from the central axis to the inner cylindrical surface, creating a hollow cylinder (annulus).*
@@ -58,7 +58,7 @@
> - Must be less than the radius
> - Use non-zero values to create donut-shaped (annular) volumes
-### **Height**
+### Height
*The total length of the cylinder along its central axis.*
diff --git a/docs/04.entities-browser/04.volumes/02.axisymmetric-volume.md b/docs/04.entities-browser/04.volumes/02.axisymmetric-volume.md
index 458d098..28fe838 100644
--- a/docs/04.entities-browser/04.volumes/02.axisymmetric-volume.md
+++ b/docs/04.entities-browser/04.volumes/02.axisymmetric-volume.md
@@ -2,7 +2,7 @@
*An axisymmetric volume (body of revolution) is a three-dimensional volume entity defined by rotating a 2D profile curve around a central axis. This allows creation of complex axisymmetric shapes like cone frustums, nacelles, or spinners that cannot be represented by simple cylinders.*
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -12,16 +12,16 @@
| [**Profile Curve**](#profile-curve) | Table of (Axial position, Radial position) points | always |
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Name**
+### Name
*Identifier for the axisymmetric volume entity.*
- **Required**
>**Note:** Names are not required to be unique, but using descriptive unique names is recommended.
-### **Center**
+### Center
*Three-dimensional coordinates (X, Y, Z) defining the reference point for the axisymmetric body.*
*The coordinates defined in the curve are relative to this point and the body axis passes through it.*
@@ -30,7 +30,7 @@
- **Units:** Length
>**Note:** The profile curve's axial positions are measured relative to this center point along the axis direction.
-### **Axis**
+### Axis
*Direction vector defining the axis of revolution.*
@@ -42,7 +42,7 @@
> - Axial positions in the profile curve are measured along this direction
> - The axis passes through the center point
-### **Profile Curve**
+### Profile Curve
*A table of (Axial position, Radial position) coordinate pairs that define the 2D profile to be revolved.*
diff --git a/docs/04.entities-browser/04.volumes/03.custom-volume.md b/docs/04.entities-browser/04.volumes/03.custom-volume.md
index b27d8aa..7eade38 100644
--- a/docs/04.entities-browser/04.volumes/03.custom-volume.md
+++ b/docs/04.entities-browser/04.volumes/03.custom-volume.md
@@ -2,7 +2,7 @@
*A custom volume is a volume zone defined by its enclosing boundary surfaces rather than by geometric primitives. This allows creation of arbitrarily shaped volume zones that conform to existing geometry surfaces, commonly used for porous media regions or user-defined volume zones.*
-## **Available Options**
+## Available Options
| *Option* | *Description* | *Applicable* |
|----------|---------------|--------------|
@@ -11,16 +11,16 @@
| [**Axes**](#axes) | Two orthogonal vectors defining principal directions | always |
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Name**
+### Name
*Identifier for the custom volume entity.*
- **Required**
>**Note:** Names must be unique across all custom volumes
-### **Enclosed surfaces**
+### Enclosed surfaces
*The boundary surfaces that fully enclose and define the custom volume region.*
@@ -31,7 +31,7 @@
> - All boundary surface names within a custom volume must be unique
> - Can include geometry surfaces or wind tunnel ghost surfaces
-### **Axes**
+### Axes
*Two orthogonal vectors defining the principal directions for the custom volume.*
diff --git a/docs/04.entities-browser/04.volumes/README.md b/docs/04.entities-browser/04.volumes/README.md
index 6d05666..b87a151 100644
--- a/docs/04.entities-browser/04.volumes/README.md
+++ b/docs/04.entities-browser/04.volumes/README.md
@@ -2,7 +2,7 @@
*Volume entities in Flow360 are used to define regions for volume zones, local refinements, and 3D physics models. Flow360 provides four volume primitives that can be used individually or combined to create complex geometric configurations.*
-## **Contents**
+## Contents
| *Volume Type* | *Description* |
|---------------|---------------|
diff --git a/docs/04.entities-browser/05.points.md b/docs/04.entities-browser/05.points.md
index 7f1ee16..6c6bc92 100644
--- a/docs/04.entities-browser/05.points.md
+++ b/docs/04.entities-browser/05.points.md
@@ -4,7 +4,7 @@
---
-## **Available Creation Methods**
+## Available Creation Methods
| *Type* | *Description* |
|--------|---------------|
@@ -13,16 +13,16 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Point**
+### Point
*Defines a single monitoring location in three-dimensional space for tracking flow properties.*
Point Parameters:
- **Position:** Three-dimensional coordinates (x, y, z)
-### **Point array**
+### Point array
*Creates an array of equally spaced points between start and end locations.*
@@ -32,7 +32,7 @@ Point array Parameters:
- **End Position:** Three-dimensional coordinates (x, y, z)
- **Number of Points:** Integer > 2
-## **Output Data**
+## Output Data
*Points and Point arrays provide access to flow field variables at their specified locations, allowing for detailed monitoring and analysis of local flow properties throughout the simulation.*
diff --git a/docs/04.entities-browser/06.slices.md b/docs/04.entities-browser/06.slices.md
index 4b7dfcd..726a55a 100644
--- a/docs/04.entities-browser/06.slices.md
+++ b/docs/04.entities-browser/06.slices.md
@@ -4,7 +4,7 @@
---
-## **Available Options**
+## Available Options
| *Option* | *Description* |
|----------|---------------|
@@ -13,9 +13,9 @@
---
-## **Detailed Descriptions**
+## Detailed Descriptions
-### **Normal**
+### Normal
*A three-dimensional vector (X, Y, Z) that defines the direction perpendicular to the slice surface.*
@@ -23,7 +23,7 @@
- **Example:** `(1, 0, 0)` for a YZ plane
>**Note:** The vector must be non-zero and will be normalized internally.
-### **Origin**
+### Origin
*A point in 3D space (X, Y, Z) that defines where the slice plane is positioned.*
diff --git a/docs/04.entities-browser/07.derived.md b/docs/04.entities-browser/07.derived.md
index ab9ba31..ee03597 100644
--- a/docs/04.entities-browser/07.derived.md
+++ b/docs/04.entities-browser/07.derived.md
@@ -2,11 +2,11 @@
*Derived entities in Flow360 are entities that are created based on input geometry. These entities serve specific purposes in simulation setup, such as assigning symmetry in the model.*
-## **Farfield**
+## Farfield
*Farfield entities define the outer boundaries of your computational domain. They are automatically generated based on your geometry and control the extent of the flow field simulation.*
-## **Symmetry**
+## Symmetry
*Symmetry entities are used to reduce computational domain size by utilizing geometric and flow symmetries. They allow you to simulate only a portion of the full domain when the flow physics and geometry exhibit symmetrical properties.*
diff --git a/docs/04.entities-browser/08.viewpoints.md b/docs/04.entities-browser/08.viewpoints.md
index 964e9ab..87e371a 100644
--- a/docs/04.entities-browser/08.viewpoints.md
+++ b/docs/04.entities-browser/08.viewpoints.md
@@ -2,24 +2,24 @@
*The Viewpoints group contains the list of Viewpoints defined in the Project. Unlike most other items in the Project, Viewpoints can be created and edited even in "View only" mode.*
-## **Managing Viewpoints**
+## Managing Viewpoints
You can interact with Viewpoints in the following ways:
-### **Creating Viewpoints**
+### Creating Viewpoints
Click the **"+"** button to create a new viewpoint based on the current camera position and orientation in the viewer.
-### **Using Viewpoints**
+### Using Viewpoints
Click on any viewpoint in the list to apply it in the viewer, which will immediately change the camera to that stored position and orientation.
-### **Modifying Viewpoints**
+### Modifying Viewpoints
Use the menu next to each viewpoint for additional operations:
- **Update** - Replace the stored camera position and orientation with the current view shown in the viewer.
- **Rename** - Change the name of the viewpoint to something more descriptive.
- **Delete** - Remove the viewpoint from the project.
-## **Viewpoints and Project Sharing**
+## Viewpoints and Project Sharing
Viewpoints are saved with the project, making them a useful tool for:
diff --git a/docs/04.entities-browser/09.environment.md b/docs/04.entities-browser/09.environment.md
index 9d10405..777f71e 100644
--- a/docs/04.entities-browser/09.environment.md
+++ b/docs/04.entities-browser/09.environment.md
@@ -2,19 +2,19 @@
*The Environment tab allows customizing the scene on which the model is displayed in the viewer region.*
-## **Background selection**
+## Background selection
The background selection menu lets the user choose the background of the viewer region. There are three methods of specifying it:
-### **Uniform color**
+### Uniform color
The background will have a uniform color chosen in the color selection menu or by entering the color's hex code.
-### **Color gradient**
+### Color gradient
The background will be colored by a gradient of two user defined colors.
-### **Image upload**
+### Image upload
The user can upload an image that will be displayed in the background.
diff --git a/docs/04.entities-browser/10.sample-surfaces.md b/docs/04.entities-browser/10.sample-surfaces.md
index d608804..a278a96 100644
--- a/docs/04.entities-browser/10.sample-surfaces.md
+++ b/docs/04.entities-browser/10.sample-surfaces.md
@@ -2,14 +2,14 @@
*Sample surfaces are imported surface geometries used for extracting and analyzing flow field data at specific locations within the simulation domain.*
-## **Overview**
+## Overview
Sample surfaces allow you to use arbitrary surface geometries in the flow field to capture detailed flow properties. Unlike slices (which are planar and created in the GUI), sample surfaces can conform to complex shapes imported from external files, providing flexibility for flow analysis in regions of interest.
Sample surfaces are accessed through the **Resource** panel (see [Top Bar](../01.introduction/03.workbench-layout/04.top-bar.md#resource)), alongside geometry resources.
-## **Importing Sample Surfaces**
+## Importing Sample Surfaces
To import a sample surface:
@@ -19,6 +19,6 @@ To import a sample surface:
4. Select a surface geometry file to import
5. The imported sample surface will appear in the **Sample surfaces** section of the Entities browser
-### **Supported Formats**
+### Supported Formats
Sample surfaces can be imported from standard surface mesh formats (e.g., STL, CGNS, UGRID).
diff --git a/docs/04.entities-browser/11.coordinate-systems.md b/docs/04.entities-browser/11.coordinate-systems.md
index 234bbef..b090b9c 100644
--- a/docs/04.entities-browser/11.coordinate-systems.md
+++ b/docs/04.entities-browser/11.coordinate-systems.md
@@ -3,7 +3,7 @@
*Coordinate systems allow you to define local reference frames for geometric transformations of entities.*
-## **Overview**
+## Overview
By default, Flow360 uses a global Cartesian coordinate system. However, for complex geometries or specific analysis requirements, you may need to define custom coordinate systems. These local coordinate systems enable:
@@ -12,7 +12,7 @@ By default, Flow360 uses a global Cartesian coordinate system. However, for comp
- Scaling
-## **Creating Coordinate Systems**
+## Creating Coordinate Systems
To create a coordinate system:
@@ -21,7 +21,7 @@ To create a coordinate system:
3. Define the parameters for the coordinate system
4. Confirm to add the coordinate system to your project
-### **Coordinate System Parameters**
+### Coordinate System Parameters
| *Parameter* | *Description* |
|-------------|---------------|
diff --git a/docs/04.entities-browser/12.entity-tags.md b/docs/04.entities-browser/12.entity-tags.md
index 5922f26..c8f5d8c 100644
--- a/docs/04.entities-browser/12.entity-tags.md
+++ b/docs/04.entities-browser/12.entity-tags.md
@@ -2,7 +2,7 @@
*Entity tags provide a flexible way to organize and group entities across your simulation project for easier management and selection.*
-## **Overview**
+## Overview
Entity tags allow you to apply custom labels to entities in your project, enabling:
@@ -11,16 +11,16 @@ Entity tags allow you to apply custom labels to entities in your project, enabli
- Organization of complex simulations with many entities
- Filtering and searching for specific entity groups
-## **Creating and Managing Tags**
+## Creating and Managing Tags
-### **Creating a New Tag**
+### Creating a New Tag
1. Navigate to the **Entity tags** section in the Entities browser
2. Click the **"+"** button to create a new tag
3. Configure the tag parameters
4. The tag is now available and entities matching the expression are automatically tagged
-### **Tag Parameters**
+### Tag Parameters
| *Parameter* | *Description* |
|-------------|---------------|
@@ -28,11 +28,11 @@ Entity tags allow you to apply custom labels to entities in your project, enabli
| **Description** | Optional description explaining the purpose of the tag |
| **Type** | The entity type to tag (e.g., Surface, Volume, Point, etc.) |
-### **Tagging Entities via Expression**
+### Tagging Entities via Expression
Tags can automatically include entities based on expressions. This allows you to dynamically tag entities that match specified criteria.
-#### **Expression Builder**
+#### Expression Builder
Each expression condition consists of:
@@ -42,7 +42,7 @@ Each expression condition consists of:
| **Operator** | The matching operator: **matches** or **not matches** |
| **Value** | The pattern to match against (supports wildcards, e.g., `*wing*`) |
-#### **Combining Conditions**
+#### Combining Conditions
- Use the **And** / **Or** toggle to control how multiple conditions are combined:
- **And** - Entity must match ALL conditions
@@ -50,23 +50,23 @@ Each expression condition consists of:
- Click **+ Add** to add additional filter conditions
- Click the trash icon to remove a condition
-### **Applying Tags Manually**
+### Applying Tags Manually
Tags can also be applied to individual entities through:
- The entity's properties panel (via the **Tag** field)
- Selecting an entity and assigning it to an existing tag
-## **Use Cases**
+## Use Cases
-### **Boundary Condition Groups**
+### Boundary Condition Groups
Tag all surfaces that share the same boundary condition type for easy identification and modification.
-### **Output Selection**
+### Output Selection
Tag entities that should be included in specific output configurations (e.g., all surfaces for force calculation).
-### **Refinement Regions**
+### Refinement Regions
Tag volumes and surfaces that require similar mesh refinement settings.
-### **Component Organization**
+### Component Organization
In multi-component assemblies, tag entities belonging to each component (e.g., "fuselage", "wing", "tail").
diff --git a/docs/04.entities-browser/README.md b/docs/04.entities-browser/README.md
index 63ba82a..7a47363 100644
--- a/docs/04.entities-browser/README.md
+++ b/docs/04.entities-browser/README.md
@@ -13,7 +13,7 @@
> **Draft Configuration**: Modifications made in the Entities browser are saved as a **Draft** configuration. This draft can be retrieved and continued from the Project Tree view, allowing you to resume your work at any time.
-## **Primary Assets**
+## Primary Assets
The primary asset defines the starting point of your simulation workflow. Only one primary asset type is available per project, depending on how the project was created.
@@ -27,7 +27,7 @@ The root entity for surface-mesh-based projects. Contains boundary definitions f
The root entity for volume-mesh-based projects. Contains zones and boundaries ready for simulation setup. Volume mesh projects can proceed directly to solver configuration.
-## **Geometric Entities**
+## Geometric Entities
These entities define spatial regions and monitoring locations within your simulation domain. Their availability depends on the primary asset type.
@@ -42,7 +42,7 @@ These entities define spatial regions and monitoring locations within your simul
| [**Derived**](./07.derived.md) | Auto-generated entities (farfield, symmetry planes) | ✓ | ✓ | — |
-## **Configuration Tools**
+## Configuration Tools
These entities are available in all project types and provide tools for visualization, organization, and scene management.
@@ -59,7 +59,7 @@ Scene and background customization settings for the viewer, including background
Custom labels for organizing and grouping entities. Tags support expression-based filtering for automatic entity selection.
-## **Related pages**
+## Related pages
- [Geometry](./01.geometry/README.md)
- [Surface Mesh](./02.surface-mesh.md)
diff --git a/docs/05.tools/01.probing.md b/docs/05.tools/01.probing.md
index 63064f0..0f384e4 100644
--- a/docs/05.tools/01.probing.md
+++ b/docs/05.tools/01.probing.md
@@ -4,13 +4,13 @@
---
-## **Overview**
+## Overview
Probing provides a way to interactively select and inspect point locations on geometry loaded in the viewer. When you click on a point, its location is temporarily stored until a new point is clicked, allowing you to quickly check coordinates at different locations.
---
-## **Accessing Probing**
+## Accessing Probing
The Probing tool is available when:
@@ -26,11 +26,11 @@ The Probing tool is available when:
---
-## **Operating Modes**
+## Operating Modes
Probing offers two modes of operation:
-### **Selection in Viewer**
+### Selection in Viewer
In this mode, you can directly click on any point in the 3D viewer to probe its location.
@@ -39,7 +39,7 @@ In this mode, you can directly click on any point in the 3D viewer to probe its
- The probed location is highlighted or marked in the viewer
- Clicking a new point replaces the previous probed location
-### **Location Specification**
+### Location Specification
In this mode, you can manually specify the coordinates of the point you want to probe.
@@ -49,7 +49,7 @@ In this mode, you can manually specify the coordinates of the point you want to
---
-## **Interface Elements**
+## Interface Elements
The Probing interface appears as a pop-up panel with the following elements:
diff --git a/docs/05.tools/02.variable-settings.md b/docs/05.tools/02.variable-settings.md
index 7f5fe24..369ac13 100644
--- a/docs/05.tools/02.variable-settings.md
+++ b/docs/05.tools/02.variable-settings.md
@@ -4,7 +4,7 @@
---
-## **Accessing Variable Settings**
+## Accessing Variable Settings
@@ -14,11 +14,11 @@
---
-## **Variable Types**
+## Variable Types
The Variable Settings tool organizes variables into different categories through a tabbed interface:
-### **Custom Variables**
+### Custom Variables
The "Custom variables" tab displays user-defined variables in a table format with columns:
@@ -26,27 +26,27 @@ The "Custom variables" tab displays user-defined variables in a table format wit
- **Expression**: The mathematical expression defining the variable (e.g., `100*u.m/u.s`, `1.225*u.kg/u.m**3`, `0.5*rho*velocity_ref**2`)
- **Description**: Optional description field for documenting the variable
-#### **Simulation Parameter**
+#### Simulation Parameter
Variables that can be used as inputs to the simulation, such as boundary condition values.
-#### **Post-processing**
+#### Post-processing
Variables defined for output and visualization purposes.
-### **Solution Variables**
+### Solution Variables
Contains pre-computed quantities from the solver organized into volume mesh and surface mesh variables. Volume mesh variables include flow field quantities (density, velocity, pressure, temperature), derived quantities (Mach number, vorticity, Q-criterion, entropy), turbulence quantities, gradient fields, and geometric quantities. Surface mesh variables include skin friction, heat flux, heat transfer coefficients, surface forces, wall shear stress, and surface geometry.
---
-## **Library**
+## Library
The library allows you to pre-define variables which can be later imported to the custom variable panel.
---
-## **Creating Variables**
+## Creating Variables
To create a new variable:
@@ -61,7 +61,7 @@ To create a new variable:
- Solution variables
6. Optionally add a description in the "Description" box
-### **Importing a Variables from Library**
+### Importing a Variables from Library
To import solution variables into custom variables you can either:
@@ -71,7 +71,7 @@ To import solution variables into custom variables you can either:
---
-## **Variable Expression Syntax**
+## Variable Expression Syntax
Variables support a rich expression syntax:
@@ -82,7 +82,7 @@ Variables support a rich expression syntax:
---
-## **Example Variables**
+## Example Variables
Compute a dimensional time step for a rotor simulation with the following variables:
diff --git a/docs/05.tools/03.surface-mesh-diagnostics.md b/docs/05.tools/03.surface-mesh-diagnostics.md
index 5e96234..c2287db 100644
--- a/docs/05.tools/03.surface-mesh-diagnostics.md
+++ b/docs/05.tools/03.surface-mesh-diagnostics.md
@@ -4,7 +4,7 @@
---
-## **Overview**
+## Overview
The Surface Mesh Diagnostics tool opens a dedicated panel that allows you to inspect surface mesh quality based on pre-computed metrics. This tool is essential for:
@@ -15,7 +15,7 @@ The Surface Mesh Diagnostics tool opens a dedicated panel that allows you to ins
---
-## **Accessing Surface Mesh Diagnostics**
+## Accessing Surface Mesh Diagnostics
The Surface Mesh Diagnostics tool is available when:
@@ -32,9 +32,9 @@ The Surface Mesh Diagnostics tool is available when:
---
-## **Diagnostic Features**
+## Diagnostic Features
-### **Quality Metrics**
+### Quality Metrics
The "Surface mesh metrics" section provides access to various pre-computed mesh quality metrics through a searchable dropdown:
@@ -49,14 +49,14 @@ The "Surface mesh metrics" section provides access to various pre-computed mesh
> The dropdown includes a search bar that allows you to quickly find metrics by typing (e.g., typing "Area" highlights the Area option).
-### **Surfaces List**
+### Surfaces List
The diagnosis settings panel includes a "Surfaces list" section that allows you to select which surfaces to analyze:
- **Search bar**: Search bar with magnifying glass icon to filter surfaces by name
- **Surface selection**: List of available surfaces (e.g., "body00001")
-### **Quality Filtering**
+### Quality Filtering
The "Poor quality elements" tab allows you to filter and identify problematic mesh elements:
diff --git a/docs/05.tools/04.volume-mesh-diagnostics.md b/docs/05.tools/04.volume-mesh-diagnostics.md
index 5d75406..e3fee7e 100644
--- a/docs/05.tools/04.volume-mesh-diagnostics.md
+++ b/docs/05.tools/04.volume-mesh-diagnostics.md
@@ -4,7 +4,7 @@
---
-## **Overview**
+## Overview
The Volume Mesh Diagnostics tool opens a dedicated panel that allows you to inspect volume mesh quality by analyzing cross-sectional slices through the mesh. When a volume mesh is loaded, this tool becomes available to help:
@@ -15,7 +15,7 @@ The Volume Mesh Diagnostics tool opens a dedicated panel that allows you to insp
---
-## **Accessing Volume Mesh Diagnostics**
+## Accessing Volume Mesh Diagnostics
The Volume Mesh Diagnostics tool is available when:
@@ -32,9 +32,9 @@ The Volume Mesh Diagnostics tool is available when:
---
-## **Diagnostic Features**
+## Diagnostic Features
-### **Quality Metrics**
+### Quality Metrics
The automatically generated slices allow you to inspect the quality of the volume mesh cells visualized in each slice. You can analyze the following mesh quality metrics for the cells displayed:
@@ -46,7 +46,7 @@ The automatically generated slices allow you to inspect the quality of the volum
These metrics help you identify cells with poor quality, such as highly stretched elements (high aspect ratio), cells with very small edges (minimum edge length), or cells with unusual volumes that may affect simulation accuracy.
-### **Automatic Slice Generation**
+### Automatic Slice Generation
The tool automatically creates slices for analysis:
@@ -54,7 +54,7 @@ The tool automatically creates slices for analysis:
- **Default slices**: Several default slices are automatically created close to bodies in the domain
- **Slice orientation**: Slices are created along x-normal, y-normal, and z-normal directions
-### **Slice Management**
+### Slice Management
The diagnosis settings panel provides comprehensive slice management:
diff --git a/docs/05.tools/05.mesh-statistics-panel.md b/docs/05.tools/05.mesh-statistics-panel.md
index 5853a84..25d989f 100644
--- a/docs/05.tools/05.mesh-statistics-panel.md
+++ b/docs/05.tools/05.mesh-statistics-panel.md
@@ -4,7 +4,7 @@
---
-## **Accessing the Mesh Statistics Panel**
+## Accessing the Mesh Statistics Panel
The Mesh Statistics Panel is accessed by:
@@ -21,11 +21,11 @@ The Mesh Statistics Panel is accessed by:
---
-## **Metrics Section**
+## Metrics Section
The panel displays comprehensive mesh information organized under the "Metrics" heading:
-### **Mesh Statistics**
+### Mesh Statistics
Overall mesh information displayed in a structured list format:
@@ -39,7 +39,7 @@ Overall mesh information displayed in a structured list format:
Each statistic is displayed with its numerical value, providing a quick overview of mesh composition.
-### **Boundary Section**
+### Boundary Section
For surface meshes, the "Boundary" section shows:
@@ -49,7 +49,7 @@ For surface meshes, the "Boundary" section shows:
- `(NUMBER)` indicates the element count for that face.
- **Expandable entries**: Each boundary face entry has a right-pointing triangle indicating it can be expanded to show detailed statistics tables
-#### **Boundary Statistics Table**
+#### Boundary Statistics Table
When you expand a boundary face entry, a detailed statistics table is displayed with the following columns:
@@ -62,14 +62,14 @@ When you expand a boundary face entry, a detailed statistics table is displayed
- **Min Element Types**: The type(s) of mesh elements associated with the minimum value
- **Min Location**: The 3D coordinates (X, Y, Z) where the minimum value occurs, with a copy icon to copy coordinates
-### **Volumetric Section**
+### Volumetric Section
For volume meshes, the "Volumetric" section shows:
- **Zone list**: Zones are listed in the format `zone_name (ELEMENT_COUNT)` (e.g., `fluid (25,092,608)`)
- **Expandable zones**: Each volume zone entry has a right-pointing triangle indicating it can be expanded to show detailed statistics tables
-#### **Volumetric Statistics Table**
+#### Volumetric Statistics Table
When you expand a volume zone entry, a detailed statistics table is displayed with the following columns:
@@ -82,6 +82,6 @@ When you expand a volume zone entry, a detailed statistics table is displayed wi
- **Min Element Types**: The type(s) of mesh elements associated with the minimum value
- **Min Location**: The 3D coordinates (X, Y, Z) where the minimum value occurs, with a copy icon to copy coordinates
-### **Visualization Section**
+### Visualization Section
The panel also includes a "Visualization" section that shows mesh screenshots.
diff --git a/docs/README.md b/docs/README.md
index 3e4e519..52ed629 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,6 +7,7 @@ Content:
- [Workbench Layout](./01.introduction/03.workbench-layout/README.md)
- [General Workflow](./01.introduction/04.general-workflow.md)
- [Project Tree](./01.introduction/05.project-tree.md)
+ - [Keyboard Shortcuts](./01.introduction/06.shortcuts.md)
- [Project Settings](./01.introduction/07.project-settings.md)
- [Simulation Setup](./02.simulation-setup/README.md)
- [Flow conditions](./02.simulation-setup/01.flow-conditions/README.md)