From 0946d7f60ef2c1c7999010a753834d970ff103a8 Mon Sep 17 00:00:00 2001 From: marcvivesmassana Date: Mon, 19 Jan 2026 18:23:11 +0100 Subject: [PATCH 1/3] update --- .../01.fluid/04.initial-condition.md | 8 +- .../02.outputs-list/00.output-fields.md | 202 +++++++++--------- .../02.outputs-list/00.scaling-values.md | 140 ++++++++++++ .../02.outputs-list/01.volume-output.md | 53 +---- .../02.time-averaging-volume-output.md | 4 +- .../02.outputs-list/03.surface-output.md | 22 +- .../04.time-averaging-surface-output.md | 4 +- .../02.outputs-list/05.slice-output.md | 23 +- .../06.time-averaging-slice-output.md | 4 +- .../02.outputs-list/07.probe-outputs.md | 23 +- .../08.time-averaging-probe-outputs.md | 2 +- .../09.surface-probe-outputs.md | 10 +- .../10.surface-slice-output.md | 22 +- .../02.outputs-list/11.isosurface-output.md | 6 +- .../12.time-averaging-isosurface-output.md | 2 +- .../02.outputs-list/14.streamline-output.md | 14 +- .../15.time-averaging-streamline-output.md | 4 +- .../04.output/02.outputs-list/README.md | 102 +-------- docs/02.simulation-setup/04.output/README.md | 41 +--- docs/02.simulation-setup/README.md | 2 + docs/README.md | 1 + 21 files changed, 294 insertions(+), 395 deletions(-) create mode 100644 docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md index 573f000..80a7cb0 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md @@ -50,7 +50,7 @@ - **Default:** `"u"` (freestream value from operating condition) - **Example:** `"0.0"` (flow starts from rest) >**Notes:** ->- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.output-fields.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) +>- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.scaling-values.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) >- Relative to the grid coordinates, not necessarily the flow direction >- Commonly set to freestream values for external flows @@ -61,7 +61,7 @@ - **Default:** `"v"` (freestream value from operating condition) - **Example:** `"0.1*sin(10*x)"` (sinusoidal disturbance) >**Notes:** ->- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.output-fields.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) +>- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.scaling-values.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) >- Relative to the grid coordinates >- Can specify flow angularity or disturbances @@ -72,7 +72,7 @@ - **Default:** `"w"` (freestream value from operating condition) - **Example:** `"0.0"` (no initial z velocity) >**Notes:** ->- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.output-fields.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) +>- Non-dimensional values (normalized by reference velocity scaling [$U_{scale}$](../../../04.output/02.outputs-list/00.scaling-values.md#reference-velocity-scaling): speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or reference velocity/velocity magnitude for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md)) >- Relative to the grid coordinates >- Can specify swirl or sideslip conditions @@ -123,7 +123,7 @@

❓ Frequently Asked Questions

 - **How are initial conditions normalized in Flow360?** - > Initial condition values are specified in non-dimensional form. Density is normalized by freestream density, velocities by the reference velocity scaling ([$U_{scale}$](../../../04.output/02.outputs-list/00.output-fields.md#reference-velocity-scaling)) which is the speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or the reference velocity (if set) or velocity magnitude (if not) for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md). Pressure is normalized by freestream dynamic pressure. The actual dimensional values depend on the operating condition settings. Note that fluid properties such as viscosity and thermal conductivity are taken from the operating condition settings rather than the initial condition. + > Initial condition values are specified in non-dimensional form. Density is normalized by freestream density, velocities by the reference velocity scaling ([$U_{scale}$](../../../04.output/02.outputs-list/00.scaling-values.md#reference-velocity-scaling)) which is the speed of sound for [`AerospaceCondition`](../../../01.flow-conditions/README.md), or the reference velocity (if set) or velocity magnitude (if not) for [`LiquidOperatingCondition`](../../../01.flow-conditions/README.md). Pressure is normalized by freestream dynamic pressure. The actual dimensional values depend on the operating condition settings. Note that fluid properties such as viscosity and thermal conductivity are taken from the operating condition settings rather than the initial condition. - **Can I specify different initial conditions in different regions?** > Yes, using conditional expressions based on coordinates. For example: `"(x < 0) ? (1.0) : (0.5)"` sets density to 1.0 where x < 0 and 0.5 elsewhere. You can use complex conditions with logical operators like && (AND) and || (OR). diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md b/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md index d33d0b3..c64fe62 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md @@ -1,141 +1,149 @@ -# Output Fields and Nondimensional Values +# Available Output Fields -*This section explains the various output fields available in Flow360 simulations and how they are nondimensionalized.* +*This section provides a comprehensive overview of all output fields (flow variables) available in Flow360 simulations, organized by their availability across different output types.* -> **Note:** Flow360 uses nondimensional values internally for numerical stability and consistency. When interpreting output data, it's important to understand how these values are nondimensionalized. +> **Note:** All output fields are non-dimensional by default unless otherwise specified. See [Scaling Values and Nondimensionalization](./00.scaling-values.md) for information on converting to dimensional values. -## **Reference Values for Nondimensionalization** +--- -| *Property* | *Reference Value for Nondimensionalization* | *Examples in Flow360* | -|-------------|---------------------------------------------|----------------------------------------------| -| Length | Grid Unit Length | wallDistance in volume and surface outputs | -| Density | Freestream Density ($ρ_∞$) | primitiveVars in all outputs | -| Velocity | Reference velocity scaling ($U_{scale}$) | primitiveVars in all outputs | -| Pressure | $ρ_∞ × U_{scale}^2$ | primitiveVars, nodeForcesPerUnitArea | -| Temperature | Freestream Temperature ($T_∞$) | T in volume outputs | -| Heat Flux | $ρ_∞ × U_{scale}^3$ | heatFlux in surface outputs | -| Force (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^2$ | Forces in BET/AD/Porous Media outputs | -| Moment (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^3$ | Moments in BET/AD/Porous Media outputs | +## **Universal Fields** -### **Reference Velocity Scaling** +*These fields are available for all output types.* -The reference velocity scaling ($U_{scale}$) is the reference velocity used for nondimensionalizing velocity-related variables (velocity fields, heat flux, angular speeds, etc.): +| *Field Name* | *Description* | *Units* | +|-------------|---------------|---------| +| `Cp` | Coefficient of pressure | Non-dimensional | +| `Cpt` | Coefficient of total pressure | Non-dimensional | +| `gradW` | Gradient of primitive solution | Non-dimensional | +| `kOmega` | k and omega (turbulence variables) | Non-dimensional | +| `Mach` | Mach number | Non-dimensional | +| `mut` | Turbulent viscosity | Non-dimensional | +| `mutRatio` | Turbulent viscosity and freestream dynamic viscosity ratio | Non-dimensional | +| `nuHat` | Spalart-Almaras variable | Non-dimensional | +| `primitiveVars` | Density, velocities (u,v,w), and pressure | Non-dimensional | +| `qcriterion` | Q criterion for vortex identification | Non-dimensional | +| `residualNavierStokes` | Navier-Stokes residual | Non-dimensional | +| `residualTransition` | Transition residual | Non-dimensional | +| `residualTurbulence` | Turbulence residual | Non-dimensional | +| `s` | Entropy | Non-dimensional | +| `solutionNavierStokes` | Navier-Stokes solution | Non-dimensional | +| `solutionTransition` | Transition solution | Non-dimensional | +| `solutionTurbulence` | Turbulence solution | Non-dimensional | +| `T` | Temperature | Non-dimensional | +| `velocity` | Velocity vector | Non-dimensional | +| `velocity_magnitude` | Magnitude of velocity vector | Non-dimensional | +| `pressure` | Pressure | Non-dimensional | +| `vorticity` | Vorticity | Non-dimensional | +| `vorticityMagnitude` | Vorticity magnitude | Non-dimensional | +| `wallDistance` | Wall distance | Grid unit length | +| `numericalDissipationFactor` | Numerical dissipation factor sensor | Non-dimensional | +| `residualHeatSolver` | Heat equation residual | Non-dimensional | +| `VelocityRelative` | Velocity with respect to non-inertial frame | Non-dimensional | +| `lowMachPreconditionerSensor` | Low-Mach preconditioner factor | Non-dimensional | -- For `AerospaceCondition`: $U_{scale} = C_∞$ (speed of sound) -- For `LiquidOperatingCondition`: $U_{scale}$ is the reference velocity (if set) or velocity magnitude (if reference velocity is not set) +--- -> **Note**: It is important to distinguish $U_{scale}$ from $U_{ref}$ (reference velocity used for force and moment coefficients). While both may have the same value in some cases, they serve different purposes: -> - $U_{scale}$ is used for nondimensionalizing velocity-related variables (velocity fields, heat flux, volumetric heat sources, angular speeds, etc.) -> - $U_{ref}$ is the user-specified reference velocity used specifically for force and moment coefficients (CL, CD, etc.), skin friction coefficient (Cf), pressure coefficient (Cp), and total pressure coefficient (Cpt) +## **Volume and Slice Specific Fields** -## **Important Output Fields** +*These fields are available only for Volume Output and Slice Output types.* -### **Skin Friction Coefficient (Cf, CfVec)** +| *Field Name* | *Description* | *Units* | +|-------------|---------------|---------| +| `betMetrics` | BET Metrics | Non-dimensional | +| `betMetricsPerDisk` | BET Metrics per Disk | Non-dimensional | +| `linearResidualNavierStokes` | Linear residual of Navier-Stokes solver | Non-dimensional | +| `linearResidualTurbulence` | Linear residual of turbulence solver | Non-dimensional | +| `linearResidualTransition` | Linear residual of transition solver | Non-dimensional | +| `SpalartAllmaras_hybridModel` | Hybrid RANS-LES output for Spalart-Allmaras solver (supports both DDES and ZDES) | Non-dimensional | +| `kOmegaSST_hybridModel` | Hybrid RANS-LES output for kOmegaSST solver (supports both DDES and ZDES) | Non-dimensional | +| `localCFL` | Local CFL number | Non-dimensional | -The skin friction coefficient represents the wall shear stress nondimensionalized by the dynamic pressure: +### **Hybrid RANS-LES Output Variables** -* `CfVec` is the skin friction coefficient vector, showing both magnitude and direction -* `Cf` is the magnitude of that vector +The `SpalartAllmaras_hybridModel` and `kOmegaSST_hybridModel` output fields provide diagnostic variables for hybrid RANS-LES simulations. The specific variables included depend on whether you're using **DDES** (Delayed Detached Eddy Simulation) or **ZDES** (Zonal Detached Eddy Simulation) as the shielding function. -To calculate the dimensional viscous stress on the wall: +#### **DDES Variables** (when `shielding_function="DDES"`) -$\tau_{wall} [\frac{N}{m^2}] = C_f × \frac{1}{2}ρ_∞ × U_{ref}^2$ +When using DDES, the hybrid model output includes five key variables: -where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition). +1. **`f_d`** – The shielding function that delineates the RANS and LES regions. When `f_d` = 0, the RANS model is fully applied; when `f_d` = 1, the LES model is used. Intermediate values represent a smooth transition between the two regimes. +2. **`r_d`** – A modified ratio of the modeled length scale to the wall distance, from which `f_d` is derived. -**Recommended Method**: For convenience, Flow360 provides the wall shear stress directly in physical units through the `wall_shear_stress_magnitude_pa` field (in Pascals or N/m²). This is the recommended method to access wall shear stress in dimensional form without manual conversion. **Available since Flow360 version 25.2.** +3. **`DDES_lengthRANS`** – The wall distance from the computational cell to the nearest solid boundary. -`CfVec` is particularly useful for identifying boundary layer separation: -* Fully attached flow follows the surface along the streamwise direction -* Separated flow induces local recirculation -* Negative values of the streamwise component (e.g., `CfVecX` for flow in the x-direction) indicate boundary layer separation +4. **`DDES_lengthScale`** – The characteristic DES length scale: $\tilde{d} \equiv d - f_d \max(0, d - C_{DES}*\Delta)$ -### **Pressure Coefficient (Cp)** +5. **`DDES_lengthLES`** – The characteristic LES length scale: $C_{DES}*\Delta$ -The pressure coefficient represents the difference between local and freestream static pressure, normalized by dynamic pressure: +Among these variables, `f_d` is the most significant, as it enables users to identify and visualize the regions dominated by RANS and DES behavior within the computational domain. -To calculate the dimensional pressure: +#### **ZDES Variables** (when `shielding_function="ZDES"`) -$p [\frac{N}{m^2}] = C_p × \frac{1}{2}ρ_∞ × U_{ref}^2 + p_∞$ +When using ZDES, the hybrid model output includes four key variables: -where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition), and $p_∞$ is the ambient pressure (pressure at the farfield). +1. **`ZDES_fp`** – The enhanced shielding function that determines whether RANS or LES is used. When `ZDES_fp` = 0, RANS is active; when `ZDES_fp` = 1, LES is active. This function is computed from `ZDES_fd`, `ZDES_fR`, and `ZDES_fp2`. -**Recommended Method**: For convenience, Flow360 provides the pressure directly in physical units through the `pressure_pa` field (in Pascals or N/m²). This is the recommended method to access pressure in dimensional form without manual conversion. **Available since Flow360 version 25.2.** +2. **`ZDES_fd`** – Original DDES shielding function used in computing `ZDES_fp`. -### **Total Pressure Coefficient (Cpt)** +3. **`ZDES_fR`** – Component used in computing `ZDES_fp`. This is included to disable or inhibit the second shielding function in regions where vorticity magnitude is increasing away from walls - this is designed to disable the secondary shielding function where a shear layer is detected above a wall. -The total pressure coefficient is useful for identifying losses in the flow field: +4. **`ZDES_fp2`** – Causes the model to revert to RANS mode in the outer portion of boundary layers, used in computing `ZDES_fp`. -Total pressure (or stagnation pressure) is the sum of static pressure, dynamic pressure, and gravitational head (often negligible). At stagnation points where velocity is zero, dynamic pressure becomes zero and total pressure equals static pressure. +--- -To calculate the dimensional total pressure: +## **Surface Specific Fields** -$p_t [\frac{N}{m^2}] = {C_p}_t × \frac{1}{2}ρ_∞ × U_{ref}^2 + {p_\infty}_t$ +*These fields are available only for Surface Output and Surface Probe Output types.* -Total pressure coefficient is excellent for visualizing: -* Boundary layer development -* Regions of separation in the flow volume -* Wakes behind objects +| *Field Name* | *Description* | *Units* | +|-------------|---------------|---------| +| `CfVec` | Skin friction coefficient vector | Non-dimensional | +| `Cf` | Magnitude of skin friction coefficient | Non-dimensional | +| `heatFlux` | Non-dimensional heat flux | Non-dimensional | +| `nodeNormals` | Wall normals | Non-dimensional | +| `nodeForcesPerUnitArea` | Forces per unit area | Non-dimensional | +| `yPlus` | Non-dimensional wall distance | Non-dimensional | +| `wallFunctionMetric` | Wall function metrics | Non-dimensional | +| `heatTransferCoefficientStaticTemperature` | Surface heat transfer coefficient (static temperature as reference) | Non-dimensional | +| `heatTransferCoefficientTotalTemperature` | Surface heat transfer coefficient (total temperature as reference) | Non-dimensional | +| `wall_shear_stress_magnitude` | Wall shear stress magnitude | Non-dimensional | +| `wall_shear_stress_magnitude_pa` | Wall shear stress magnitude | **Pascals (Pa)** - Available since version 25.2 | -### **Q-Criterion** +--- -Q-criterion is used to identify vortical structures in the flow field. It represents the balance between rotation rate and strain rate in the flow. +## **Isosurface Specific Fields** -* Positive values indicate areas where rotation dominates over strain (vortex cores) -* Higher values indicate stronger vortices -* The default isosurface value in Flow360 is calculated as: - ``` - Q_default = RefMach² / (all wall's bounding box length)² - ``` +*These fields are available only for Isosurface Output types.* -## **Visualization Tips** +Isosurface outputs support all universal fields listed above. The most commonly used fields for isosurface visualization are: -### Boundary Layer Separation -* Use the streamwise component of `CfVec` to identify separated regions -* Set a visualization scale with 3 levels (e.g., -1e-6, 0, 1e-6) to easily distinguish between attached (positive values) and separated (negative values) flow regions +- `qcriterion` - For vortex identification +- `Mach` - For shock wave visualization +- `pressure` - For pressure-based isosurfaces +- `Cpt` - For total pressure loss visualization -### Surface Flow Patterns -* Use surface streamlines with `CfVec` components instead of velocity -* This shows recirculation patterns on the surface +--- -### Vortex Visualization -* Use `qcriterion` isosurfaces to identify vortices -* For airplane simulations: recommended isosurface value is approximately Mach²/WingSpan² -* For rotor-dominated flows: recommended isosurface value is approximately TipMach²/RotorDiameter² -* Larger isosurface values show only stronger vortices -* Smaller values show more flow features but may clutter visualization +## **Custom Variables** -### Boundary Layer Visualization -* Use `Cpt` (total pressure coefficient) to visualize boundary layer development -* Lower values (typically shown in blue) highlight boundary layer regions +*User-defined expressions with dimensions. These can be created using the Variable Settings tool or Python API.* -## **BET Visualization** -When using Blade Element Theory (BET) models, the volumeOutput can include additional `betMetrics` that provide visualization of: +By default, the following expressions are available: -* Blade loading distributions -* Inducted velocities -* Local angle of attack -* Other BET-specific quantities +| *Variable Name* | *Expression* | *Description* | +|----------------|--------------|---------------| +| `velocity_with_units` | `solution.velocity` | Velocity in physical units | +| `velocity_magnitude_with_units` | `math.magnitude(solution.velocity)` | Velocity magnitude in physical units | +| `pressure_with_units` | `solution.pressure` | Pressure in physical units | +| `wall_shear_stress_magnitude_with_units` | `solution.wall_shear_stress_magnitude` | Wall shear stress magnitude in physical units | -These metrics are useful for analyzing rotor and propeller performance. +> **Note:** You can create additional custom variables using the [Variable Settings](../../../05.tools/02.variable-settings.md) tool or through the Python API. Custom variables can access multiple solver variables and undergo mathematical operations. -## **History Files** +--- -Flow360 generates various history files that record time-series data during simulations: +## **Related Documentation** -### **Actuator Disk Output** -* Records thrust, torque, and power for actuator disk models -* Useful for tracking propulsion system performance - -### **BET Loading Output** -* Records sectional forces and moments for blade elements -* Can be used to analyze blade loading distributions - -### **Aeroacoustic Output** -* Records acoustic data at observer locations -* Used for noise prediction and analysis - -### **Heat Transfer** -* Records heat flux and temperature information -* Important for thermal analysis applications \ No newline at end of file +- [Scaling Values and Nondimensionalization](./00.scaling-values.md) - Learn how to convert non-dimensional values to physical units +- [Variable Settings](../../05.tools/02.variable-settings.md) - Create custom output variables +- [Reference Dimensions](../01.reference-dimensions.md) - Configure reference dimensions for coefficient calculations diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md b/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md new file mode 100644 index 0000000..b34755e --- /dev/null +++ b/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md @@ -0,0 +1,140 @@ +# Scaling Values and Nondimensionalization + +*This section explains how Flow360 nondimensionalizes output values and the reference scaling values used for converting between dimensional and non-dimensional quantities.* + +> **Note:** Flow360 uses nondimensional values internally for numerical stability and consistency. When interpreting output data, it's important to understand how these values are nondimensionalized. + +## **Reference Values for Nondimensionalization** + +| *Property* | *Reference Value for Nondimensionalization* | *Examples in Flow360* | +|-------------|---------------------------------------------|----------------------------------------------| +| Length | Grid Unit Length | wallDistance in volume and surface outputs | +| Density | Freestream Density ($ρ_∞$) | primitiveVars in all outputs | +| Velocity | Reference velocity scaling ($U_{scale}$) | primitiveVars in all outputs | +| Pressure | $ρ_∞ × U_{scale}^2$ | primitiveVars, nodeForcesPerUnitArea | +| Temperature | Freestream Temperature ($T_∞$) | T in volume outputs | +| Heat Flux | $ρ_∞ × U_{scale}^3$ | heatFlux in surface outputs | +| Force (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^2$ | Forces in BET/AD/Porous Media outputs | +| Moment (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^3$ | Moments in BET/AD/Porous Media outputs | + +### **Reference Velocity Scaling** + +The reference velocity scaling ($U_{scale}$) is the reference velocity used for nondimensionalizing velocity-related variables (velocity fields, heat flux, angular speeds, etc.): + +- For `AerospaceCondition`: $U_{scale} = C_∞$ (speed of sound) +- For `LiquidOperatingCondition`: $U_{scale}$ is the reference velocity (if set) or velocity magnitude (if reference velocity is not set) + +> **Note**: It is important to distinguish $U_{scale}$ from $U_{ref}$ (reference velocity used for force and moment coefficients). While both may have the same value in some cases, they serve different purposes: +> - $U_{scale}$ is used for nondimensionalizing velocity-related variables (velocity fields, heat flux, volumetric heat sources, angular speeds, etc.) +> - $U_{ref}$ is the user-specified reference velocity used specifically for force and moment coefficients (CL, CD, etc.), skin friction coefficient (Cf), pressure coefficient (Cp), and total pressure coefficient (Cpt) + +## **Important Coefficients and Their Scaling** + +### **Skin Friction Coefficient (Cf, CfVec)** + +The skin friction coefficient represents the wall shear stress nondimensionalized by the dynamic pressure: + +* `CfVec` is the skin friction coefficient vector, showing both magnitude and direction +* `Cf` is the magnitude of that vector + +To calculate the dimensional viscous stress on the wall: + +$\tau_{wall} [\frac{N}{m^2}] = C_f × \frac{1}{2}ρ_∞ × U_{ref}^2$ + +where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition). + +**Recommended Method**: For convenience, Flow360 provides the wall shear stress directly in physical units through the `wall_shear_stress_magnitude_pa` field (in Pascals or N/m²). This is the recommended method to access wall shear stress in dimensional form without manual conversion. **Available since Flow360 version 25.2.** + +`CfVec` is particularly useful for identifying boundary layer separation: +* Fully attached flow follows the surface along the streamwise direction +* Separated flow induces local recirculation +* Negative values of the streamwise component (e.g., `CfVecX` for flow in the x-direction) indicate boundary layer separation + +### **Pressure Coefficient (Cp)** + +The pressure coefficient represents the difference between local and freestream static pressure, normalized by dynamic pressure: + +To calculate the dimensional pressure: + +$p [\frac{N}{m^2}] = C_p × \frac{1}{2}ρ_∞ × U_{ref}^2 + p_∞$ + +where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition), and $p_∞$ is the ambient pressure (pressure at the farfield). + +**Recommended Method**: For convenience, Flow360 provides the pressure directly in physical units through the `pressure_pa` field (in Pascals or N/m²). This is the recommended method to access pressure in dimensional form without manual conversion. **Available since Flow360 version 25.2.** + +### **Total Pressure Coefficient (Cpt)** + +The total pressure coefficient is useful for identifying losses in the flow field: + +Total pressure (or stagnation pressure) is the sum of static pressure, dynamic pressure, and gravitational head (often negligible). At stagnation points where velocity is zero, dynamic pressure becomes zero and total pressure equals static pressure. + +To calculate the dimensional total pressure: + +$p_t [\frac{N}{m^2}] = {C_p}_t × \frac{1}{2}ρ_∞ × U_{ref}^2 + {p_\infty}_t$ + +Total pressure coefficient is excellent for visualizing: +* Boundary layer development +* Regions of separation in the flow volume +* Wakes behind objects + +### **Q-Criterion** + +Q-criterion is used to identify vortical structures in the flow field. It represents the balance between rotation rate and strain rate in the flow. + +* Positive values indicate areas where rotation dominates over strain (vortex cores) +* Higher values indicate stronger vortices +* The default isosurface value in Flow360 is calculated as: + ``` + Q_default = RefMach² / (all wall's bounding box length)² + ``` + +## **Visualization Tips** + +### Boundary Layer Separation +* Use the streamwise component of `CfVec` to identify separated regions +* Set a visualization scale with 3 levels (e.g., -1e-6, 0, 1e-6) to easily distinguish between attached (positive values) and separated (negative values) flow regions + +### Surface Flow Patterns +* Use surface streamlines with `CfVec` components instead of velocity +* This shows recirculation patterns on the surface + +### Vortex Visualization +* Use `qcriterion` isosurfaces to identify vortices +* For airplane simulations: recommended isosurface value is approximately Mach²/WingSpan² +* For rotor-dominated flows: recommended isosurface value is approximately TipMach²/RotorDiameter² +* Larger isosurface values show only stronger vortices +* Smaller values show more flow features but may clutter visualization + +### Boundary Layer Visualization +* Use `Cpt` (total pressure coefficient) to visualize boundary layer development +* Lower values (typically shown in blue) highlight boundary layer regions + +## **BET Visualization** +When using Blade Element Theory (BET) models, the volumeOutput can include additional `betMetrics` that provide visualization of: + +* Blade loading distributions +* Inducted velocities +* Local angle of attack +* Other BET-specific quantities + +These metrics are useful for analyzing rotor and propeller performance. + +## **History Files** + +Flow360 generates various history files that record time-series data during simulations: + +### **Actuator Disk Output** +* Records thrust, torque, and power for actuator disk models +* Useful for tracking propulsion system performance + +### **BET Loading Output** +* Records sectional forces and moments for blade elements +* Can be used to analyze blade loading distributions + +### **Aeroacoustic Output** +* Records acoustic data at observer locations +* Used for noise prediction and analysis + +### **Heat Transfer** +* Records heat flux and temperature information +* Important for thermal analysis applications diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md index 6806491..1666430 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md @@ -32,9 +32,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None selected - **Example:** `Mach, pressure, qcriterion` ->**Notes:** -> - See detailed field descriptions below. -> - Only select fields you need to analyze to keep file sizes manageable. +>**Notes:** volume outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Volume and Slice Specific Fields](./00.output-fields.md#volume-and-slice-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference, including details on hybrid RANS-LES output variables. ### **Output format** @@ -90,55 +88,6 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Available Output Fields** - -Variables from [Available Output Fields](README.md#available-output-fields) and the following specific variables - -### **Volume-Specific Variables** (non-dimensional) - -- `betMetrics` - BET Metrics -- `betMetricsPerDisk` - BET Metrics per Disk -- `linearResidualNavierStokes` - Linear residual of Navier-Stokes solver -- `linearResidualTurbulence` - Linear residual of turbulence solver -- `linearResidualTransition` - Linear residual of transition solver -- `SpalartAllmaras_hybridModel` - Hybrid RANS-LES output for Spalart-Allmaras solver (supports both DDES and ZDES) -- `kOmegaSST_hybridModel` - Hybrid RANS-LES output for kOmegaSST solver (supports both DDES and ZDES) -- `localCFL` - Local CFL number - -### **Hybrid RANS-LES Output Variables** - -The `SpalartAllmaras_hybridModel` and `kOmegaSST_hybridModel` output fields provide diagnostic variables for hybrid RANS-LES simulations. The specific variables included depend on whether you're using **DDES** (Delayed Detached Eddy Simulation) or **ZDES** (Zonal Detached Eddy Simulation) as the shielding function. - -#### **DDES Variables** (when `shielding_function="DDES"`) - -When using DDES, the hybrid model output includes five key variables: - -1. **`f_d`** – The shielding function that delineates the RANS and LES regions. When `f_d` = 0, the RANS model is fully applied; when `f_d` = 1, the LES model is used. Intermediate values represent a smooth transition between the two regimes. - -2. **`r_d`** – A modified ratio of the modeled length scale to the wall distance, from which `f_d` is derived. - -3. **`DDES_lengthRANS`** – The wall distance from the computational cell to the nearest solid boundary. - -4. **`DDES_lengthScale`** – The characteristic DES length scale: $\tilde{d} \equiv d - f_d \max(0, d - C_{DES}*\Delta)$ - -5. **`DDES_lengthLES`** – The characteristic LES length scale: $C_{DES}*\Delta$ - -Among these variables, `f_d` is the most significant, as it enables users to identify and visualize the regions dominated by RANS and DES behavior within the computational domain. - -#### **ZDES Variables** (when `shielding_function="ZDES"`) - -When using ZDES, the hybrid model output includes four key variables: - -1. **`ZDES_fp`** – The enhanced shielding function that determines whether RANS or LES is used. When `ZDES_fp` = 0, RANS is active; when `ZDES_fp` = 1, LES is active. This function is computed from `ZDES_fd`, `ZDES_fR`, and `ZDES_fp2`. - -2. **`ZDES_fd`** – Original DDES shielding function used in computing `ZDES_fp`. - -3. **`ZDES_fR`** – is included to disable or inhibit this second shielding function in regions where vorticity magnitude is increasing away from walls - this is designed to disable the secondary shielding function where a shear layer is detected above a wall. Component used in computing `ZDES_fp`. - -4. **`ZDES_fp2`** – Causes the model to revert to RANS mode in the outer portion of boundary layers, used in computing `ZDES_fp`. - ---- -

💡 Tips

diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md index 40d4363..ed2707d 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md @@ -31,9 +31,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None - **Example:** `Mach, pressure, velocity` ->**Notes:** -> - See detailed field descriptions in the [Volume Output](01.volume-output.md#available-output-fields) page. -> - Only select fields you need to analyze to keep file sizes manageable. +>**Notes:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for volume outputs. ### **Output format** diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md index c525904..661d568 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md @@ -34,8 +34,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None (user must select at least one field) - **Example:** `Cp`, `Cf`, `Mach` ->**Note:** Select only the fields you need to keep file sizes manageable. - +>**Notes:** surface outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. ### **Output format** *The file format in which surface data will be saved.* @@ -105,25 +104,6 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `wing`, `fuselage`, `nacelles` >**Note:** Select all appropriate surfaces needed for your analysis. ---- - -## **Available Output Fields** - -Variables from [Available Output Fields](./README.md#available-output-fields) and the following specific variables - -### **Surface-Specific Variables** - -- `CfVec` - Skin friction coefficient vector (non-dimensional) -- `Cf` - Magnitude of skin friction coefficient (non-dimensional) -- `heatFlux` - Non-dimensional heat flux (non-dimensional) -- `nodeNormals` - Wall normals (non-dimensional) -- `nodeForcesPerUnitArea` - Forces per unit area (non-dimensional) -- `yPlus` - Non-dimensional wall distance (non-dimensional) -- `wallFunctionMetric` - Wall function metrics (non-dimensional) -- `heatTransferCoefficientStaticTemperature` - Surface heat transfer coefficient (static temperature as reference) (non-dimensional) -- `heatTransferCoefficientTotalTemperature` - Surface heat transfer coefficient (total temperature as reference) (non-dimensional) -- `wall_shear_stress_magnitude` - Wall shear stress magnitude (non-dimensional) -- `wall_shear_stress_magnitude_pa` - Wall shear stress magnitude (in Pa) **[Recommended method, available since version 25.2]** --- diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md index 4138b67..be0aaf4 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md @@ -36,9 +36,7 @@ When working with **child cases** (cases forked from a parent simulation), it's *The flow variables that will be time-averaged in the output files.* - **Example:** `Cp`, `velocity`, `pressure` ->**Note:** -> - See detailed field descriptions in the [Surface Output](03.surface-output.md#available-output-fields) page. -> - Time-averaging is applied to each selected field independently. +>**Note:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for surface outputs. ### **Output format** diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md index 00396da..bacbfa7 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md @@ -33,7 +33,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None (must select at least one) - **Example:** `Cp, Mach, velocity` ->**Note:** See complete list of available fields below. +>**Notes:** slice outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Volume and Slice Specific Fields](./00.output-fields.md#volume-and-slice-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. ### **Output format** @@ -105,27 +105,6 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Available Output Fields** - -Variables from [Available Output Fields](./README.md#available-output-fields) and the following specific variables - -### **Volume-Specific Variables** - -- `betMetrics` - BET Metrics -- `betMetricsPerDisk` - BET Metrics per Disk -- `linearResidualNavierStokes` - Linear residual of Navier-Stokes solver -- `linearResidualTurbulence` - Linear residual of turbulence solver -- `linearResidualTransition` - Linear residual of transition solver -- `SpalartAllmaras_hybridModel` - Hybrid RANS-LES output for Spalart-Allmaras solver (supports both DDES and ZDES) -- `kOmegaSST_hybridModel` - Hybrid RANS-LES output for kOmegaSST solver (supports both DDES and ZDES) -- `localCFL` - Local CFL number - -### **Hybrid RANS-LES Output Variables** - -For detailed information about the `SpalartAllmaras_hybridModel` and `kOmegaSST_hybridModel` output fields and their DDES and ZDES variables, see the [Hybrid RANS-LES Output Variables section in Volume Output](01.volume-output.md#hybrid-rans-les-output-variables). - ---- -

💡 Tips

 diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md index f926a96..d22e79f 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md @@ -36,9 +36,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None - **Example:** `Mach, pressure, velocity` ->**Notes:** -> - See detailed field descriptions in the [Slice Output](05.slice-output.md#available-output-fields) page. -> - Only select fields you need to analyze to keep file sizes manageable. +>**Notes:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for slice outputs. ### **Output format** diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md index fa046fd..70eac04 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md @@ -22,7 +22,7 @@ - **Default:** None (user must select at least one field) - **Example:** `primitiveVars`, `Cp`, `Mach` ->**Note:** Select only the fields you need for your analysis. +>**Notes:** probe outputs support all [Universal Fields](./00.output-fields.md#universal-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. ### **Probes** @@ -39,27 +39,6 @@ - **Point Definition:** The creation of points is described in detail [here](../../../04.entities-browser/05.points.md) ---- - -## **Available Output Fields** - -Variables from [Available Output Fields](./README.md#available-output-fields) and the following specific variables - -### **Additional Variables for Surface Probe Output** - -- `CfVec` - Skin friction coefficient vector (non-dimensional) -- `Cf` - Magnitude of skin friction coefficient (non-dimensional) -- `heatFlux` - Non-dimensional heat flux (non-dimensional) -- `nodeNormals` - Wall normals (non-dimensional) -- `nodeForcesPerUnitArea` - Forces per unit area (non-dimensional) -- `yPlus` - Non-dimensional wall distance (non-dimensional) -- `wallFunctionMetric` - Wall function metrics (non-dimensional) -- `heatTransferCoefficientStaticTemperature` - Surface heat transfer coefficient (static temperature as reference) (non-dimensional) -- `heatTransferCoefficientTotalTemperature` - Surface heat transfer coefficient (total temperature as reference) (non-dimensional) -- `wall_shear_stress_magnitude` - Wall shear stress magnitude (non-dimensional) -- `wall_shear_stress_magnitude_pa` - Wall shear stress magnitude (in Pa) - - ---
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md index 013da92..47aa91d 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md @@ -36,7 +36,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None (user must select at least one field) - **Example:** `primitiveVars`, `Cp`, `Mach` ->**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./07.probe-outputs.md#available-output-fields) for a complete list of supported variables. +>**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./00.output-fields.md#universal-fields) for a complete list of supported variables. ### **Start step** diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md index 02ee682..368b4cb 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md @@ -22,9 +22,7 @@ - **Default:** None (user must select at least one field) - **Example:** `Cp`, `Cf`, `yPlus` ->**Notes:** -> - Select only the fields you need for your analysis. -> - Surface-specific variables are available. +>**Notes:** surface probe outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields), the same as Surface Outputs. See the [Available Output Fields](./00.output-fields.md) page for a complete reference. ### **Assigned probes** @@ -51,12 +49,6 @@ --- -## **Available Output Fields** - -Surface probe outputs share the same output fields that are available for [Surface Outputs](./03.surface-output.md#available-output-fields), including both universal variables and surface-specific variables. - ---- -

💡 Tips

 diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md index e7dd250..5c76606 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md @@ -59,7 +59,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** `["Cp", "Mach"]` - **Example:** `["Cp", "velocity_m_per_s", "pressure_pa"]` ->**Note:** See the Available Output Fields section below for a complete list. +>**Notes:** surface slice outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields), the same as Surface Outputs. See the [Available Output Fields](./00.output-fields.md) page for a complete reference. ### **Output format** @@ -94,26 +94,6 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Available Output Fields** - -Variables from [Available Output Fields](./README.md#available-output-fields) and the following specific variables - -### **Surface-Specific Variables** - -- `CfVec` - Skin friction coefficient vector (non-dimensional) -- `Cf` - Magnitude of skin friction coefficient (non-dimensional) -- `heatFlux` - Non-dimensional heat flux (non-dimensional) -- `nodeNormals` - Wall normals (non-dimensional) -- `nodeForcesPerUnitArea` - Forces per unit area (non-dimensional) -- `yPlus` - Non-dimensional wall distance (non-dimensional) -- `wallFunctionMetric` - Wall function metrics (non-dimensional) -- `heatTransferCoefficientStaticTemperature` - Surface heat transfer coefficient (static temperature as reference) (non-dimensional) -- `heatTransferCoefficientTotalTemperature` - Surface heat transfer coefficient (total temperature as reference) (non-dimensional) -- `wall_shear_stress_magnitude` - Wall shear stress magnitude (non-dimensional) -- `wall_shear_stress_magnitude_pa` - Wall shear stress magnitude (in Pa) - ---- -

💡 Tips

 diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md index 4eae4f4..2cb7f8e 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md @@ -33,7 +33,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None - **Example:** `Mach, pressure, velocity` ->**Note:** See detailed field descriptions below. Only select fields you need to analyze. +>**Notes:** isosurface outputs support all [Universal Fields](./00.output-fields.md#universal-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference, including commonly used fields for isosurface visualization. ### **Output format** @@ -116,10 +116,6 @@ When working with **child cases** (cases forked from a parent simulation), it's - `nuHat` - Spalart-Almaras variable (non-dimensional) - `vorticityMagnitude` - Vorticity Magnitude (non-dimensional) -## **Available Output Fields** - -Variables from [Available Output Fields](./README.md#available-output-fields) and the following specific variables - ---
diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md index 0bbda49..ad994e0 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md @@ -36,7 +36,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Default:** None (user must select at least one field) - **Example:** `Mach`, `pressure`, `velocity` ->**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./11.isosurface-output.md#available-output-fields) for a complete list of supported variables. +>**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./00.output-fields.md#universal-fields) for a complete list of supported variables. ### **Output format** diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md index 0ade3dd..dfbb684 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md @@ -8,12 +8,23 @@ | *Option* | *Description* | |----------|---------------| +| **Output fields** | Flow variables to include along streamlines | | **Assigned points** | Points indicating the locations of streamlines | --- ## **Detailed Descriptions** +### **Output fields** + +*The flow variables that will be included along the streamlines.* + +- **Default:** None +- **Example:** `pressure`, `velocity`, `Mach` +>**Notes:** +> - Streamline outputs only support **custom variables** (UserVariable), not predefined output fields. Create custom variables using the [Variable Settings](../../../05.tools/02.variable-settings.md) tool or Python API. +> - Vector-valued fields will be colored by their magnitude. + ### **Assigned points** *Points that define the placement of streamlines. The Streamline is a path of a particle that passes through a given point.* @@ -82,7 +93,8 @@ streamline_output = StreamlineOutput( u_number_of_points=11, v_number_of_points=20 ) - ] + ], + output_fields=[fl.solution.pressure, fl.solution.velocity], ) ``` diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md index 5ef2317..954f150 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md @@ -24,7 +24,9 @@ - **Default:** None - **Example:** `pressure`, `velocity`, `Mach` ->**Note:** Vector-valued fields will be colored by their magnitude. See [Available Output Fields](./00.output-fields.md) for a complete list of supported variables. +>**Notes:** +> - Time-averaging streamline outputs only support **custom variables** (UserVariable), not predefined output fields. Create custom variables using the [Variable Settings](../../../05.tools/02.variable-settings.md) tool or Python API. +> - Vector-valued fields will be colored by their magnitude. ### **Start step** 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 3539400..055843e 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 @@ -36,102 +36,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. 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. --- @@ -166,6 +77,8 @@ User defined expressions with dimensions. By default, the following expressions ```{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 @@ -184,6 +97,5 @@ User defined expressions with dimensions. By default, the following expressions ./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 fdb13de..21484a4 100644 --- a/docs/02.simulation-setup/04.output/README.md +++ b/docs/02.simulation-setup/04.output/README.md @@ -1,51 +1,24 @@ # 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** | *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 -- **[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..35d67fb 100644 --- a/docs/02.simulation-setup/README.md +++ b/docs/02.simulation-setup/README.md @@ -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/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) From 230d0c1e514836dd8ef8802ed421869b59ad08af Mon Sep 17 00:00:00 2001 From: marcvivesmassana Date: Tue, 20 Jan 2026 10:27:10 +0100 Subject: [PATCH 2/3] comments --- .../02.outputs-list/00.scaling-values.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md b/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md index b34755e..de93d08 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/00.scaling-values.md @@ -4,20 +4,20 @@ > **Note:** Flow360 uses nondimensional values internally for numerical stability and consistency. When interpreting output data, it's important to understand how these values are nondimensionalized. -## **Reference Values for Nondimensionalization** +## Reference Values for Nondimensionalization | *Property* | *Reference Value for Nondimensionalization* | *Examples in Flow360* | |-------------|---------------------------------------------|----------------------------------------------| | Length | Grid Unit Length | wallDistance in volume and surface outputs | | Density | Freestream Density ($ρ_∞$) | primitiveVars in all outputs | | Velocity | Reference velocity scaling ($U_{scale}$) | primitiveVars in all outputs | -| Pressure | $ρ_∞ × U_{scale}^2$ | primitiveVars, nodeForcesPerUnitArea | +| Pressure | $ρ_∞ \cdot U_{scale}^2$ | primitiveVars, nodeForcesPerUnitArea | | Temperature | Freestream Temperature ($T_∞$) | T in volume outputs | -| Heat Flux | $ρ_∞ × U_{scale}^3$ | heatFlux in surface outputs | -| Force (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^2$ | Forces in BET/AD/Porous Media outputs | -| Moment (BET/AD/Porous Media) | $ρ_∞ × U_{scale}^2× (Grid Unit Length)^3$ | Moments in BET/AD/Porous Media outputs | +| Heat Flux | $ρ_∞ \cdot U_{scale}^3$ | heatFlux in surface outputs | +| Force (BET/AD/Porous Media) | $ρ_∞ \cdot U_{scale}^2 \cdot (Grid Unit Length)^2$ | Forces in BET/AD/Porous Media outputs | +| Moment (BET/AD/Porous Media) | $ρ_∞ \cdot U_{scale}^2 \cdot (Grid Unit Length)^3$ | Moments in BET/AD/Porous Media outputs | -### **Reference Velocity Scaling** +### Reference Velocity Scaling The reference velocity scaling ($U_{scale}$) is the reference velocity used for nondimensionalizing velocity-related variables (velocity fields, heat flux, angular speeds, etc.): @@ -28,9 +28,9 @@ The reference velocity scaling ($U_{scale}$) is the reference velocity used for > - $U_{scale}$ is used for nondimensionalizing velocity-related variables (velocity fields, heat flux, volumetric heat sources, angular speeds, etc.) > - $U_{ref}$ is the user-specified reference velocity used specifically for force and moment coefficients (CL, CD, etc.), skin friction coefficient (Cf), pressure coefficient (Cp), and total pressure coefficient (Cpt) -## **Important Coefficients and Their Scaling** +## Important Coefficients and Their Scaling -### **Skin Friction Coefficient (Cf, CfVec)** +### Skin Friction Coefficient (Cf, CfVec) The skin friction coefficient represents the wall shear stress nondimensionalized by the dynamic pressure: @@ -39,30 +39,30 @@ The skin friction coefficient represents the wall shear stress nondimensionalize To calculate the dimensional viscous stress on the wall: -$\tau_{wall} [\frac{N}{m^2}] = C_f × \frac{1}{2}ρ_∞ × U_{ref}^2$ +$\tau_{wall} [\frac{N}{m^2}] = C_f \cdot \frac{1}{2}ρ_∞ \cdot U_{ref}^2$ where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition). -**Recommended Method**: For convenience, Flow360 provides the wall shear stress directly in physical units through the `wall_shear_stress_magnitude_pa` field (in Pascals or N/m²). This is the recommended method to access wall shear stress in dimensional form without manual conversion. **Available since Flow360 version 25.2.** +**Recommended Method**: For convenience, Flow360 provides the wall shear stress directly in physical units through the `wall_shear_stress_magnitude_with_units` field using the specified units in webUI. This is the recommended method to access wall shear stress in dimensional form without manual conversion. `CfVec` is particularly useful for identifying boundary layer separation: * Fully attached flow follows the surface along the streamwise direction * Separated flow induces local recirculation * Negative values of the streamwise component (e.g., `CfVecX` for flow in the x-direction) indicate boundary layer separation -### **Pressure Coefficient (Cp)** +### Pressure Coefficient (Cp) The pressure coefficient represents the difference between local and freestream static pressure, normalized by dynamic pressure: To calculate the dimensional pressure: -$p [\frac{N}{m^2}] = C_p × \frac{1}{2}ρ_∞ × U_{ref}^2 + p_∞$ +$p [\frac{N}{m^2}] = C_p \cdot \frac{1}{2}ρ_∞ \cdot U_{ref}^2 + p_∞$ where $U_{ref}$ is the reference velocity used for force and moment coefficients (set via `Mach` or `MachRef` parameters in the operating condition), and $p_∞$ is the ambient pressure (pressure at the farfield). -**Recommended Method**: For convenience, Flow360 provides the pressure directly in physical units through the `pressure_pa` field (in Pascals or N/m²). This is the recommended method to access pressure in dimensional form without manual conversion. **Available since Flow360 version 25.2.** +**Recommended Method**: For convenience, Flow360 provides the pressure directly in physical units through the `pressure_with_units` field using the specified units in webUI. This is the recommended method to access pressure in dimensional form without manual conversion. -### **Total Pressure Coefficient (Cpt)** +### Total Pressure Coefficient (Cpt) The total pressure coefficient is useful for identifying losses in the flow field: @@ -70,14 +70,14 @@ Total pressure (or stagnation pressure) is the sum of static pressure, dynamic p To calculate the dimensional total pressure: -$p_t [\frac{N}{m^2}] = {C_p}_t × \frac{1}{2}ρ_∞ × U_{ref}^2 + {p_\infty}_t$ +$p_t [\frac{N}{m^2}] = {C_p}_t \cdot \frac{1}{2}ρ_∞ \cdot U_{ref}^2 + {p_\infty}_t$ Total pressure coefficient is excellent for visualizing: * Boundary layer development * Regions of separation in the flow volume * Wakes behind objects -### **Q-Criterion** +### Q-Criterion Q-criterion is used to identify vortical structures in the flow field. It represents the balance between rotation rate and strain rate in the flow. @@ -88,7 +88,7 @@ Q-criterion is used to identify vortical structures in the flow field. It repres Q_default = RefMach² / (all wall's bounding box length)² ``` -## **Visualization Tips** +## Visualization Tips ### Boundary Layer Separation * Use the streamwise component of `CfVec` to identify separated regions @@ -109,7 +109,7 @@ Q-criterion is used to identify vortical structures in the flow field. It repres * Use `Cpt` (total pressure coefficient) to visualize boundary layer development * Lower values (typically shown in blue) highlight boundary layer regions -## **BET Visualization** +## BET Visualization When using Blade Element Theory (BET) models, the volumeOutput can include additional `betMetrics` that provide visualization of: * Blade loading distributions @@ -119,22 +119,22 @@ When using Blade Element Theory (BET) models, the volumeOutput can include addit These metrics are useful for analyzing rotor and propeller performance. -## **History Files** +## History Files Flow360 generates various history files that record time-series data during simulations: -### **Actuator Disk Output** +### Actuator Disk Output * Records thrust, torque, and power for actuator disk models * Useful for tracking propulsion system performance -### **BET Loading Output** +### BET Loading Output * Records sectional forces and moments for blade elements * Can be used to analyze blade loading distributions -### **Aeroacoustic Output** +### Aeroacoustic Output * Records acoustic data at observer locations * Used for noise prediction and analysis -### **Heat Transfer** +### Heat Transfer * Records heat flux and temperature information * Important for thermal analysis applications From ed2690c9497f5cba5d86edf73bf1eb8ba79909db Mon Sep 17 00:00:00 2001 From: marcvivesmassana Date: Tue, 20 Jan 2026 10:39:56 +0100 Subject: [PATCH 3/3] remove bold headers --- docs/.vuepress/template.md | 6 +-- docs/01.introduction/01.dashboard.md | 12 ++--- docs/01.introduction/02.starting-project.md | 16 +++---- .../03.workbench-layout/04.top-bar.md | 24 +++++----- .../03.workbench-layout/05.viewer-region.md | 28 +++++------ .../03.workbench-layout/07.status-bar.md | 8 ++-- .../03.workbench-layout/README.md | 4 +- docs/01.introduction/04.general-workflow.md | 16 +++---- docs/01.introduction/05.project-tree.md | 16 +++---- docs/01.introduction/06.shortcuts.md | 10 ++-- docs/01.introduction/07.project-settings.md | 28 +++++------ docs/01.introduction/README.md | 16 +++---- .../01.flow-conditions/README.md | 34 ++++++------- .../02.mesh/01.farfield.md | 48 +++++++++---------- .../02.mesh/02.mesh-parameters.md | 42 ++++++++-------- .../02.mesh/03.rotation-zones.md | 16 +++---- .../02.mesh/04.custom-zones.md | 10 ++-- .../02.mesh/05.volume-mesh-slices.md | 12 ++--- .../01.surface-edge-refinement.md | 8 ++-- .../06.refinements/02.surface-refinement.md | 8 ++-- .../03.boundary-layer-refinement.md | 8 ++-- .../06.refinements/04.passive-spacing.md | 8 ++-- .../06.refinements/05.uniform-refinement.md | 8 ++-- .../06.axisymmetric-refinement.md | 12 ++--- .../06.refinements/07.geometry-refinement.md | 10 ++-- .../02.mesh/06.refinements/README.md | 10 ++-- docs/02.simulation-setup/02.mesh/README.md | 16 +++---- .../01.boundary-conditions/01.wall.md | 30 ++++++------ .../01.boundary-conditions/02.freestream.md | 14 +++--- .../01.boundary-conditions/03.inflow.md | 28 +++++------ .../01.boundary-conditions/04.outflow.md | 24 +++++----- .../01.boundary-conditions/05.periodic.md | 16 +++---- .../01.boundary-conditions/06.symmetry.md | 12 ++--- .../01.boundary-conditions/07.slip-wall.md | 14 +++--- .../08.turbulence-quantities.md | 20 ++++---- .../01.boundary-conditions/README.md | 2 +- .../03.flow-solver/02.time.md | 32 ++++++------- .../01.fluid/01.navier-stokes-solver.md | 32 ++++++------- .../01.fluid/02.turbulence-model.md | 32 ++++++------- .../01.fluid/03.transition-model.md | 30 ++++++------ .../01.fluid/04.initial-condition.md | 16 +++---- .../01.fluid/05.stopping-criteria.md | 18 +++---- .../03.physics/01.fluid/README.md | 8 ++-- .../02.solid/01.heat-equation-solver.md | 16 +++---- .../03.physics/02.solid/02.material.md | 10 ++-- .../02.solid/03.initial-condition.md | 8 ++-- .../03.physics/02.solid/README.md | 8 ++-- .../03.flow-solver/03.physics/03.rotation.md | 18 +++---- .../03.flow-solver/03.physics/04.bet-disk.md | 26 +++++----- .../03.physics/05.actuator-disk.md | 10 ++-- .../03.physics/06.porous-medium.md | 18 +++---- .../03.flow-solver/03.physics/README.md | 16 +++---- .../04.user-defined-dynamics.md | 16 +++---- .../03.flow-solver/README.md | 12 ++--- .../04.output/01.reference-dimensions.md | 10 ++-- .../02.outputs-list/00.output-fields.md | 18 +++---- .../02.outputs-list/01.volume-output.md | 16 +++---- .../02.time-averaging-volume-output.md | 18 +++---- .../02.outputs-list/03.surface-output.md | 20 ++++---- .../04.time-averaging-surface-output.md | 22 ++++----- .../02.outputs-list/05.slice-output.md | 18 +++---- .../06.time-averaging-slice-output.md | 20 ++++---- .../02.outputs-list/07.probe-outputs.md | 8 ++-- .../08.time-averaging-probe-outputs.md | 18 +++---- .../09.surface-probe-outputs.md | 10 ++-- .../10.surface-slice-output.md | 18 +++---- .../02.outputs-list/11.isosurface-output.md | 20 ++++---- .../12.time-averaging-isosurface-output.md | 20 ++++---- .../02.outputs-list/13.aeroacoustic-output.md | 8 ++-- .../02.outputs-list/14.streamline-output.md | 8 ++-- .../15.time-averaging-streamline-output.md | 10 ++-- .../02.outputs-list/16.force-output.md | 16 +++---- .../17.force-distribution-output.md | 14 +++--- ...ime-averaging-force-distribution-output.md | 18 +++---- .../02.outputs-list/19.output-formats.md | 28 +++++------ .../20.surface-integral-output.md | 16 +++---- .../04.output/02.outputs-list/README.md | 6 +-- docs/02.simulation-setup/04.output/README.md | 2 +- docs/02.simulation-setup/README.md | 4 +- docs/03.analysis/01.dashboard.md | 20 ++++---- docs/03.analysis/02.convergence.md | 14 +++--- docs/03.analysis/03.monitor.md | 18 +++---- docs/03.analysis/04.visualization.md | 18 +++---- docs/03.analysis/05.aeroacoustic.md | 26 +++++----- docs/03.analysis/README.md | 14 +++--- .../01.geometry/01.edges.md | 4 +- .../01.geometry/02.faces.md | 10 ++-- .../04.entities-browser/01.geometry/README.md | 18 +++---- docs/04.entities-browser/02.surface-mesh.md | 2 +- .../03.volume-mesh/01.zones.md | 2 +- .../03.volume-mesh/02.boundaries.md | 4 +- .../03.volume-mesh/README.md | 2 +- docs/04.entities-browser/04.volumes/00.box.md | 20 ++++---- .../04.volumes/01.cylinder.md | 16 +++---- .../04.volumes/02.axisymmetric-volume.md | 12 ++--- .../04.volumes/03.custom-volume.md | 10 ++-- docs/04.entities-browser/04.volumes/README.md | 2 +- docs/04.entities-browser/05.points.md | 10 ++-- docs/04.entities-browser/06.slices.md | 8 ++-- docs/04.entities-browser/07.derived.md | 4 +- docs/04.entities-browser/08.viewpoints.md | 10 ++-- docs/04.entities-browser/09.environment.md | 8 ++-- .../04.entities-browser/10.sample-surfaces.md | 6 +-- .../11.coordinate-systems.md | 6 +-- docs/04.entities-browser/12.entity-tags.md | 26 +++++----- docs/04.entities-browser/README.md | 8 ++-- docs/05.tools/01.probing.md | 12 ++--- docs/05.tools/02.variable-settings.md | 22 ++++----- docs/05.tools/03.surface-mesh-diagnostics.md | 12 ++--- docs/05.tools/04.volume-mesh-diagnostics.md | 12 ++--- docs/05.tools/05.mesh-statistics-panel.md | 16 +++---- 111 files changed, 829 insertions(+), 829 deletions(-) diff --git a/docs/.vuepress/template.md b/docs/.vuepress/template.md index 73f2137..2d8d03d 100644 --- a/docs/.vuepress/template.md +++ b/docs/.vuepress/template.md @@ -20,7 +20,7 @@ orphan: true ## 🔍 **Detailed Descriptions** -### **Option_1** +### Option_1 *More detailed explanation or additional context of Option_1.* @@ -28,7 +28,7 @@ orphan: true - **Example:** `sample input` - **Notes:** Additional notes or caveats. -### **Option_2** +### Option_2 *Detailed explanation for Option_2, clarifying possible values or scenarios.* @@ -36,7 +36,7 @@ orphan: true - **Example:** `sample input` - **Notes:** Additional notes or caveats. -### **Option_n** +### Option_n *Explanation of the last option.* diff --git a/docs/01.introduction/01.dashboard.md b/docs/01.introduction/01.dashboard.md index 1d3c9d8..a65043e 100644 --- a/docs/01.introduction/01.dashboard.md +++ b/docs/01.introduction/01.dashboard.md @@ -4,7 +4,7 @@ --- -## **Dashboard Components** +## Dashboard Components | *Component* | *Description* | |--------------|-----------------| @@ -15,9 +15,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Recent** +### Recent *The main area displays a grid of recent project cards, showing your latest CFD simulations in chronological order.* @@ -32,14 +32,14 @@ - Manually refresh all project resource statuses - Located next to New project button -### **FlexCredits** +### FlexCredits *Shows your current balance of computation credits.* - **Balance:** Numerical value of your current FlexCredit balance. - **Updates:** Credits are consumed based on computational resources used. -### **Pending resources** +### Pending resources *Displays pending computational resources and their current status.* @@ -50,7 +50,7 @@ >**Note:** Below **Pending resources** there is a visual representation of all project's statuses called **Projects**. -### **Start with the example** +### Start with the example *A quick-start option for new users to begin with Flow360.* diff --git a/docs/01.introduction/02.starting-project.md b/docs/01.introduction/02.starting-project.md index dce5eb8..3db5b83 100644 --- a/docs/01.introduction/02.starting-project.md +++ b/docs/01.introduction/02.starting-project.md @@ -2,7 +2,7 @@ *This document describes how to start a project in Flow360 GUI.* -## **New Project** +## New Project *The New Project window is the entry point for creating CFD simulations in Flow360. It allows users to choose between geometry-based or mesh-based workflows.* @@ -10,7 +10,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Default* | |--------------------|------------------------------------------------------------|--------------------------| @@ -22,9 +22,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Project name** +### Project name *Unique name that identifies your simulation project in the Flow360 system.* @@ -32,7 +32,7 @@ - **Example:** `Wing_Analysis_M08` >**Note:** Choose a descriptive name that helps identify the project purpose. -### **Solver version** +### Solver version *Specifies the Flow360 solver version to be used for the simulation.* @@ -40,7 +40,7 @@ - **Example:** `release-24.11` >**Note:** It's recommended to use the latest stable release unless specific version compatibility is required. -### **Unit** +### Unit *Defines the physical unit for interpreting mesh/geometry dimensions.* @@ -48,7 +48,7 @@ - **Example:** `inch` >**Note:** Ensure this matches the units used in your CAD or mesh file to avoid scaling issues. -### **Description** +### Description *Optional field for adding project notes, objectives, or other relevant information.* @@ -56,7 +56,7 @@ - **Example:** `High-lift configuration analysis at takeoff conditions` >**Note:** Below the description field you can add tags to your project by clicking the `+ Add` icon. -### **Creation methods** +### Creation methods *Choose how to initialize your project.* diff --git a/docs/01.introduction/03.workbench-layout/04.top-bar.md b/docs/01.introduction/03.workbench-layout/04.top-bar.md index 68089ab..85b0e38 100644 --- a/docs/01.introduction/03.workbench-layout/04.top-bar.md +++ b/docs/01.introduction/03.workbench-layout/04.top-bar.md @@ -6,7 +6,7 @@ --- -## **Available Components** (from left to right) +## Available Components (from left to right) | *Component* | *Icon* | *Description* | |---------------------|-------------|-------------------------------------------------------------------------------| @@ -23,13 +23,13 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Flow360 logo** +### Flow360 logo *Quick access to return to the Flow360 Dashboard, maintaining efficient workflow navigation.* -### **Project tree** +### Project tree *Hierarchical organization of project components, providing structured access to simulation elements.* @@ -38,28 +38,28 @@ - Direct component access - See [Project tree](../05.project-tree.md) for more details -### **More** +### More *Additional project management options accessible via a three-dot menu.* - Import/Export simulation settings - Import/Export viewpoints -### **View only** +### View only *Notification that the project is currently being viewed in view-only mode.* - Simulation parameters cannot be changed in this mode - To exit, click on New run or select a component from the project tree -### **Assets** +### Assets ![assets](./Figures/assets.svg) *Central repository for project-related resources and files.* - Information about each asset - Downloadable files list for each asset -### **Resource** +### Resource ![resource](./Figures/resource_icon.svg) *Import geometry resources and sample surfaces.* @@ -67,22 +67,22 @@ - **Sample surface**: Import sample surface data -### **Probe** +### Probe ![probe](./Figures/probe-icon.svg) *Show location of entered coordinates or show coordinates of a clicked location.* - Enter coordinates to highlight a location in the viewer - Click on geometry to display coordinates of that point -### **Help** +### Help ![help](./Figures/help.svg) *Access to documentation, support resources, and guidance materials.* -### **Project settings** +### Project settings ![settings](./Figures/project_settings.svg) *Configuration interface for project-specific parameters. Includes run settings and project details.* -### **Fork/New run** +### Fork/New run *Create an extension of a case based on current configuration.* diff --git a/docs/01.introduction/03.workbench-layout/05.viewer-region.md b/docs/01.introduction/03.workbench-layout/05.viewer-region.md index 9b4f210..4813420 100644 --- a/docs/01.introduction/03.workbench-layout/05.viewer-region.md +++ b/docs/01.introduction/03.workbench-layout/05.viewer-region.md @@ -2,7 +2,7 @@ *The viewer region is the primary visualization interface in Flow360 GUI, providing interactive 3D visualization capabilities for geometry inspection, mesh analysis, and results visualization.* -## **Example Views** +## Example Views ### Geometry View Mode ![viewer_geometry](./Figures/viewer_geometry.png) @@ -12,7 +12,7 @@ ![viewer_mesh](./Figures/viewer_mesh.png) *Example of the mesh view mode displaying a mesh visualization.* -## **Core Features** +## Core Features | *Feature* | *Icon* | *Description* | |----------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| @@ -29,9 +29,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **View modes** +### View modes *Toggle between Geometry/Mesh/Visualization views using top toolbar tabs.* @@ -41,21 +41,21 @@ >**Note:** Each mode provides context-specific tools and options. -### **Boundary conditions** +### Boundary conditions *Toggle coloring of boundaries based on their assigned boundary condition.* >**Note:** Helps verify boundary condition assignments before mesh generation. -### **Diagnostic tools** +### Diagnostic tools *Tools for geometry quality inspection and validation that color areas of geometry depending on their level of confidence.* -### **Mesh display** +### Mesh display *Control the visualization of mesh elements and their properties. Can be set as either solid or solid with edges.* -### **Entity selection mode** +### Entity selection mode *Tools for selecting and managing geometry entities.* @@ -68,15 +68,15 @@ >**Note:** You can use any combination of selection modes. -### **Entities visibility** +### Entities visibility *Toggle the visibility of entities by clicking the eye icon when hovering over them.* -### **Mesh metrics** +### Mesh metrics *Quantitative mesh quality assessment tools for analyzing both surface and volume mesh characteristics.* -### **Element types overview** +### Element types overview The mesh quality visualization provides statistics for different element types commonly found in CFD meshes: @@ -112,7 +112,7 @@ Nodes are present in every mesh and represent the intersection points of mesh el | **Aspect Ratio** | Element shape quality indicator | Identifies highly stretched or compressed elements | | **Volume** | Element volume measurement | Helps detect very small or large elements that might affect solution stability | -### **Viewpoints** +### Viewpoints *Controls for saving and loading specific camera positions.* @@ -120,7 +120,7 @@ Nodes are present in every mesh and represent the intersection points of mesh el - Click the + icon to add a new viewpoint that will be the current camera position - Name the viewpoint to be representative of the camera position -### **Length scale indicator** +### Length scale indicator *Visual reference showing model dimensions to help maintain perspective.* @@ -129,7 +129,7 @@ Nodes are present in every mesh and represent the intersection points of mesh el - Unit system consistency - Reference dimension display -### **Rotation cube** +### Rotation cube *Interactive orientation widget for quick view rotation to standard angles.* diff --git a/docs/01.introduction/03.workbench-layout/07.status-bar.md b/docs/01.introduction/03.workbench-layout/07.status-bar.md index 74ebe85..9dcb245 100644 --- a/docs/01.introduction/03.workbench-layout/07.status-bar.md +++ b/docs/01.introduction/03.workbench-layout/07.status-bar.md @@ -4,7 +4,7 @@ --- -## **Available Components** +## Available Components | *Component* | *Icon* | *Description* | |--------------|-------------------|----------------------------------------------------------------| @@ -12,9 +12,9 @@ | **Run Status** | ![run_status](./Figures/run_status.png) | Shows simulation progress, job status, and execution information | --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Inspector** +### Inspector *The Inspector panel validates and displays essential simulation parameters that must be defined or corrected before running the simulation.* @@ -32,7 +32,7 @@ The Inspector provides comprehensive validation feedback: - Context information ("relevant for: Case") - Detailed error messages when applicable -### **Run Status** +### Run Status *The Run Status panel provides a hierarchical view of simulation execution stages and progress.* diff --git a/docs/01.introduction/03.workbench-layout/README.md b/docs/01.introduction/03.workbench-layout/README.md index 58baede..905b943 100644 --- a/docs/01.introduction/03.workbench-layout/README.md +++ b/docs/01.introduction/03.workbench-layout/README.md @@ -6,7 +6,7 @@ --- -## **Main Interface Sections** +## Main Interface Sections | *Section* | *Description* | |-------------|-----------------| @@ -20,7 +20,7 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions ### 1️⃣ **Viewer region** diff --git a/docs/01.introduction/04.general-workflow.md b/docs/01.introduction/04.general-workflow.md index 9721332..3a87608 100644 --- a/docs/01.introduction/04.general-workflow.md +++ b/docs/01.introduction/04.general-workflow.md @@ -3,7 +3,7 @@ *This document outlines the systematic approach to setting up and running CFD simulations using the Flow360 graphical user interface.* --- -## **Workbench view** +## Workbench view ![workbench](./Figures/workbench.png) @@ -11,7 +11,7 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). --- -## **Primary Workflow Steps** +## Primary Workflow Steps | *Step* | *Description* | *Location* | |--------|---------------|------------| @@ -23,9 +23,9 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Setup** +### Setup *Configure simulation parameters in a top-to-bottom sequence through the left sidebar.* @@ -38,7 +38,7 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). - Output settings >**Note:** Parameters are organized in collapsible sections for clarity -### **Verify** +### Verify *Verify simulation setup completeness using the inspector tool.* @@ -46,7 +46,7 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). - **Success Indicator:** Inspector showing 0 errors >**Note:** Address any warnings or errors before proceeding -### **Run** +### Run *Initiate the simulation process including surface and volume meshing.* @@ -54,7 +54,7 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). - **Scope:** Complete workflow from geometry to solution >**Note:** Automated meshing is included when starting from geometry -### **Monitor** +### Monitor *Track simulation progress and analyze numerical results.* @@ -62,7 +62,7 @@ For workbench layout, refer to this [page](./03.workbench-layout/README.md). - **Features:** Real-time convergence monitoring >**Note:** Multiple visualization options available -### **Visualize** +### Visualize *Inspect mesh and results using the central viewer.* diff --git a/docs/01.introduction/05.project-tree.md b/docs/01.introduction/05.project-tree.md index 86da59e..8569737 100644 --- a/docs/01.introduction/05.project-tree.md +++ b/docs/01.introduction/05.project-tree.md @@ -11,7 +11,7 @@ --- -## **Icon Explanation** +## Icon Explanation | *Icon* | *Name* | *Description* | |----------|----------|-----------------| @@ -24,11 +24,11 @@ --- -## **Project Structure** +## Project Structure *The Flow360 project structure follows a flexible hierarchical organization that accommodates different starting points and multiple analysis paths. Each node in the tree represents a distinct stage in the simulation process, with the ability to branch and create parallel analysis streams.* -### **Entry Points** +### Entry Points The project can be initiated from two different entry points: 1. **Geometry-First Approach**: @@ -39,7 +39,7 @@ The project can be initiated from two different entry points: - Starts directly with a surface or volume mesh - Meshing settings are available only when starting from a surface mesh -### **Workflow Hierarchy** +### Workflow Hierarchy The workflow structure depends on the chosen entry point. Below are the two possible progression paths: @@ -83,7 +83,7 @@ Volume Mesh > └── Fork B1.1.1 >``` -### **Branching Capabilities** +### Branching Capabilities The project tree supports multiple branches at each level: @@ -107,14 +107,14 @@ The project tree supports multiple branches at each level: - Forks inherit all case results and settings - Allows parameter modifications while preserving history -### **Forking** +### Forking - Forks are direct extensions of their parent cases - All results and settings are preserved in forks - Simulation continues from the last state of the parent case - Multiple forks can branch from the same parent case -### **Interpolation** +### Interpolation - Interpolation transfers solution from a case onto a new mesh - New mesh can exist either within the same project, or in a different one @@ -125,7 +125,7 @@ The project tree supports multiple branches at each level: -### **Component Actions** +### Component Actions When clicking on a component in the project tree, a menu of available actions appears. Below are the available actions: diff --git a/docs/01.introduction/06.shortcuts.md b/docs/01.introduction/06.shortcuts.md index 826caff..3da2fac 100644 --- a/docs/01.introduction/06.shortcuts.md +++ b/docs/01.introduction/06.shortcuts.md @@ -6,7 +6,7 @@ --- -## **Selection** +## Selection *Shortcuts for selecting items in the Flow360 Workbench.* @@ -20,7 +20,7 @@ --- -## **View** +## View *Shortcuts for navigating and controlling the 3D viewer.* @@ -36,11 +36,11 @@ --- -## **Project Tree** +## Project Tree *Shortcuts for interacting with the project tree hierarchy.* -### **Context Menu Shortcuts** +### Context Menu Shortcuts *Shortcuts for performing actions from the project tree context menu. Only applies to the first four actions in the menu illustrated below.* @@ -52,7 +52,7 @@ ![Tree Menu](Figures/tree_menu.png) *Project tree context menu showing the difference between standard left click (opens in current tab) and Ctrl/Cmd + Left click (opens in new tab).* -### **Tree Selection Shortcuts** +### Tree Selection Shortcuts *Shortcuts for selecting items in the project tree.* diff --git a/docs/01.introduction/07.project-settings.md b/docs/01.introduction/07.project-settings.md index 30fced2..e964698 100644 --- a/docs/01.introduction/07.project-settings.md +++ b/docs/01.introduction/07.project-settings.md @@ -4,7 +4,7 @@ --- -## **Accessing Project Settings** +## Accessing Project Settings The Project Settings panel is accessible through: @@ -21,7 +21,7 @@ The Project Settings panel is accessible through: --- -## **Overview** +## Overview The Project Settings panel is organized into two main tabs: @@ -30,17 +30,17 @@ The Project Settings panel is organized into two main tabs: --- -## **Run Settings Tab** +## Run Settings Tab The "Run settings" tab contains configuration options and information specific to the current simulation run: -### **Project Information** +### Project Information - **Project Name**: The name of the current project/case - Displayed with a document icon - Shows the case name for the current run -### **Units System** +### Units System - **Set up button**: Click "Set up" to open a dropdown menu with predefined unit system options: - **Set as SI**: Sets units to SI system (m, kg, s, K) @@ -48,13 +48,13 @@ The "Run settings" tab contains configuration options and information specific t - **Set as Imperial**: Sets units to Imperial system (ft, lb, s, F) - Selecting a unit system applies the corresponding units across all settings in the project -### **Mesher Options** +### Mesher Options - **Geometry AI**: Toggle switch for "Use the Geometry AI surface mesher" - **Beta mesher**: Toggle switch for "Use the beta version of Mesher for simulation" -### **Solver Configuration** +### Solver Configuration - **Solver version**: Dropdown menu to select the Flow360 solver version (e.g., `release-25.8`) - Choose from available solver releases @@ -62,7 +62,7 @@ The "Run settings" tab contains configuration options and information specific t - **Project length unit**: Dropdown menu to specify the length unit for the project. Available options: `m` (meters), `cm` (centimeters), `mm` (millimeters), `ft` (feet), `inch` (inches) -### **Run Status and Statistics** +### Run Status and Statistics > **Note:** The following sections (Run Status and Statistics, and Time Information) are only available when a simulation run has finished. @@ -80,7 +80,7 @@ The "Run settings" tab contains configuration options and information specific t - **Location**: The workspace where the project is stored -### **Time Information** +### Time Information - **Total time**: Total duration of the simulation run @@ -92,17 +92,17 @@ The "Run settings" tab contains configuration options and information specific t --- -## **Project Details Tab** +## Project Details Tab The "Project details" tab contains project-level metadata and information: -### **Project Information** +### Project Information - **Project Name**: The name of the project. Can be edited. - **Project ID**: Unique identifier for the project. Frequently used through the python API. -### **Organization** +### Organization - **Folder**: The workspace folder where the project is located. Can be expanded or edited to change the project location @@ -112,13 +112,13 @@ The "Project details" tab contains project-level metadata and information: - **Description**: Optional text field for project description and notes. -### **Project Statistics** +### Project Statistics - **Project cost**: Total FlexCredits consumed across all runs in this project. Cumulative cost of all simulation runs within the project - **Solver version**: The solver version with which the project was created. -### **Timestamps** +### Timestamps - **Creation time**: Timestamp when the project was created diff --git a/docs/01.introduction/README.md b/docs/01.introduction/README.md index e0a5160..f7bd9a7 100644 --- a/docs/01.introduction/README.md +++ b/docs/01.introduction/README.md @@ -2,7 +2,7 @@ *An introduction to the basic features of the Flow360 WebUI including navigation and key concepts.* -## **Contents** +## Contents | *Section* | *Contents* | |-------------|--------------| @@ -15,9 +15,9 @@ |[Project settings](./07.project-settings.md)| Configuration and metadata for projects and simulation runs | --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Dashboard** +### Dashboard *The Dashboard serves as the central hub for managing and monitoring your CFD projects in Flow360. It provides an intuitive overview of your simulations, resources, and project status.* @@ -28,7 +28,7 @@ --- -### **Starting a Project** +### Starting a Project *This section guides you through creating a new project in Flow360, whether starting from geometry, surface mesh, or volume mesh.* @@ -42,7 +42,7 @@ --- -### **Workbench Layout** +### Workbench Layout *The Flow360 workbench provides an interface for CFD simulations, with defined regions for setup, visualization, and analysis.* @@ -56,7 +56,7 @@ --- -### **General Workflow** +### General Workflow *This section outlines the systematic approach to setting up and running CFD simulations using the Flow360 GUI.* @@ -68,7 +68,7 @@ --- -### **Project Tree** +### Project Tree *The project tree is a hierarchical visualization of your CFD workflow, from geometry to results. It helps track progress and navigate between stages.* @@ -79,7 +79,7 @@ --- -### **Project Settings** +### Project Settings *The Project Settings panel provides access to project-level configuration, run settings, and project metadata. This panel allows you to manage project properties, configure units, and view project statistics.* diff --git a/docs/02.simulation-setup/01.flow-conditions/README.md b/docs/02.simulation-setup/01.flow-conditions/README.md index 591100a..fa74b4b 100644 --- a/docs/02.simulation-setup/01.flow-conditions/README.md +++ b/docs/02.simulation-setup/01.flow-conditions/README.md @@ -3,9 +3,9 @@ *Operating condition window allows to specify the properties of the fluid that is simulated as well as its velocity in relation to the analyzed object. The values defined are also used for the calculations of force coefficients. You can choose between two types of a fluid: gas and liquid.* --- -## **Available Options** +## Available Options -### **Gas** +### Gas The simulated fluid is considered an ideal gas. | *Option* | *Description* | *Applicable* | @@ -25,7 +25,7 @@ The simulated fluid is considered an ideal gas. --- -### **Liquid** +### Liquid The simulated fluid is considered a liquid. @@ -39,13 +39,13 @@ The simulated fluid is considered a liquid. | **Dynamic viscosity** | Liquid dynamic viscosity | always | --- -## **Detailed descriptions** +## Detailed descriptions -### **Type** +### Type *Choose a method of defining the freestream velocity.* -### **Velocity magnitude** +### Velocity magnitude *Define the freestream velocity using direct velocity magnitude.* @@ -53,7 +53,7 @@ The simulated fluid is considered a liquid. - **Example:** `100 m/s` >**Note:** For hover or static conditions, you can set this to zero but must provide a reference velocity for coefficient calculations. -### **Reference velocity magnitude** +### Reference velocity magnitude *Optional reference velocity used for calculating force and moment coefficients. Required when freestream velocity is zero.* @@ -61,7 +61,7 @@ The simulated fluid is considered a liquid. - **Example:** `100 m/s` >**Note:** Particularly important for static/hover cases or when you want coefficients referenced to a different velocity than freestream. -### **Mach** +### Mach *Define the freestream Mach number.* @@ -69,7 +69,7 @@ The simulated fluid is considered a liquid. - **Example:** `0.8` >**Note:** For hover or static conditions, you can set this to zero but must provide a reference velocity for coefficient calculations. -### **Reference Mach** +### Reference Mach *Optional reference velocity used for calculating force and moment coefficients. Required when freestream velocity is zero.* @@ -77,7 +77,7 @@ The simulated fluid is considered a liquid. - **Example:** `0.8` >**Note:** Particularly important for static/hover cases or when you want coefficients referenced to a different velocity than freestream. -### **Alpha angle** +### Alpha angle *The angle of attack defining the orientation of the freestream flow relative to the model. Positive values typically indicate nose-up orientation.* @@ -93,7 +93,7 @@ The simulated fluid is considered a liquid. > - $U_∞$ is the x-component of velocity in the global coordinate system > - $W_∞$ is the z-component of velocity in the global coordinate system -### **Beta angle** +### Beta angle *The sideslip angle defining the orientation of the freestream flow relative to the model. Positive values typically indicate flow from the right.* @@ -111,34 +111,34 @@ The simulated fluid is considered a liquid. > - $V_∞$ is the y-component of velocity in the global coordinate system > - $W_∞$ is the z-component of velocity in the global coordinate system -### **Thermal state** +### Thermal state *Choose a method of defining the gas physical properties.* >**Note:** Fluid material is fixed as Air in the GUI. -### **Density** +### Density *Defines the fluid density.* - **Required** - **Example:** `1.0 kg/m³` -### **Temperature** +### Temperature *Defines the fluid temperature.* - **Required** - **Example:** `250K` -### **Altitude** +### Altitude *Defines the altitude for which the air properties are set according to the US Standard Atmosphere.* - **Required** - **Example:** `10000 m` -### **Temperature offset** +### Temperature offset *An offset from the temperature taken from the standard atmosphere.* @@ -146,7 +146,7 @@ The simulated fluid is considered a liquid. - **Example:** `-10 K` >**Note:** If the altitude is set to `10000 m`, the temperature is `223.3 K` according to the US standard atmosphere. With the temperature offset of `-10 K`, the effective freestream temperature will be `213.3 K`. -### **Dynamic visosity** +### Dynamic visosity *The dynamic viscosity of a liquid.* diff --git a/docs/02.simulation-setup/02.mesh/01.farfield.md b/docs/02.simulation-setup/02.mesh/01.farfield.md index d8f702e..825d73e 100644 --- a/docs/02.simulation-setup/02.mesh/01.farfield.md +++ b/docs/02.simulation-setup/02.mesh/01.farfield.md @@ -2,7 +2,7 @@ *A farfield volume zone defines the outer boundaries of your computational domain. It establishes the limits where freestream conditions are applied and ensures proper flow development around your geometry.* -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| | [**Type**](#type) | Method of constructing the farfield | always | @@ -25,9 +25,9 @@ | [**Rear wheel belts Y**](#rear-wheel-belts-y) | Y-range (inner to outer) of the rear wheel belts | **Floor geometry** is `Wheel-belt wind tunnel` | -## **Detailed descriptions** +## Detailed descriptions -### **Type** +### Type *Setting allowing the user to choose between generating the farfield in the workflow and providing the farfield as a part of uploaded geometry.* @@ -40,7 +40,7 @@ > - `Wind tunnel` option is only available with Geometry AI. > - By default, the volume mesher will grow boundary layers on `User defined farfield` and `Wind tunnel` boundaries. Use [Passive Spacing](./06.refinements/04.passive-spacing.md) to project or disable boundary layer growth. -### **Symmetry plane** +### Symmetry plane *Toggle to enable half-domain simulation with a symmetry boundary condition at Y=0.* @@ -50,7 +50,7 @@ > - Significantly reduces computational cost for symmetric geometries > - Only available when using Geometry AI with the beta volume mesher -### **Volume to include** +### Volume to include *Specifies which side of the Y=0 plane to retain when symmetry plane is enabled.* @@ -61,7 +61,7 @@ >**Note:** The geometry must span across Y=0 for this setting to take effect. -### **Method** +### Method *Method of defining the size of an auto-generated farfield.* @@ -76,25 +76,25 @@ --- -### **Wind tunnel parameters** +### Wind tunnel parameters The following parameters define the wind tunnel geometry when **Type** is set to `Wind tunnel`. -#### **Width** +#### Width *Width of the wind tunnel in the Y-direction.* - **Default:** `10 m` - **Units:** Length -#### **Height** +#### Height *Height of the wind tunnel in the Z-direction.* - **Default:** `6 m` - **Units:** Length -#### **Inlet X position** +#### Inlet X position *X-coordinate of the tunnel inlet plane.* @@ -102,7 +102,7 @@ The following parameters define the wind tunnel geometry when **Type** is set to - **Units:** Length >**Note:** Must be less than **Outlet X position**. -#### **Outlet X position** +#### Outlet X position *X-coordinate of the tunnel outlet plane.* @@ -110,7 +110,7 @@ The following parameters define the wind tunnel geometry when **Type** is set to - **Units:** Length >**Note:** Must be greater than **Inlet X position**. -#### **Floor Z position** +#### Floor Z position *Z-coordinate of the tunnel floor.* @@ -119,7 +119,7 @@ The following parameters define the wind tunnel geometry when **Type** is set to --- -### **Floor geometry** +### Floor geometry *Specifies the type of floor configuration for the wind tunnel.* @@ -131,11 +131,11 @@ The following parameters define the wind tunnel geometry when **Type** is set to --- -### **Fixed floor parameters** +### Fixed floor parameters The following parameters are available when **Floor geometry** is set to `Fixed floor`. -#### **Friction patch X** +#### Friction patch X *X-range (minimum, maximum) defining the extent of the friction patch on the floor.* @@ -145,7 +145,7 @@ The following parameters are available when **Floor geometry** is set to `Fixed > - The friction patch applies wall boundary conditions within this X-range > - Must be within the inlet and outlet X positions -#### **Friction patch width** +#### Friction patch width *Width of the friction patch centered at Y=0.* @@ -155,11 +155,11 @@ The following parameters are available when **Floor geometry** is set to `Fixed --- -### **Center-belt wind tunnel parameters** +### Center-belt wind tunnel parameters The following parameters are available when **Floor geometry** is set to `Center-belt wind tunnel` or `Wheel-belt wind tunnel`. -#### **Center belt X** +#### Center belt X *X-range (minimum, maximum) defining the extent of the central moving belt.* @@ -167,7 +167,7 @@ The following parameters are available when **Floor geometry** is set to `Center - **Units:** Length >**Note:** Must be within the inlet and outlet X positions. -#### **Center belt width** +#### Center belt width *Width of the central moving belt centered at Y=0.* @@ -177,11 +177,11 @@ The following parameters are available when **Floor geometry** is set to `Center --- -### **Wheel-belt wind tunnel parameters** +### Wheel-belt wind tunnel parameters The following parameters are available when **Floor geometry** is set to `Wheel-belt wind tunnel`. These are in addition to the center belt parameters. -#### **Front wheel belts X** +#### Front wheel belts X *X-range (minimum, maximum) defining the extent of the front wheel belts.* @@ -189,7 +189,7 @@ The following parameters are available when **Floor geometry** is set to `Wheel- - **Units:** Length >**Note:** Maximum X must be less than the minimum X of the rear wheel belts. -#### **Front wheel belts Y** +#### Front wheel belts Y *Y-range (inner edge, outer edge) defining the lateral position of the front wheel belts.* @@ -200,7 +200,7 @@ The following parameters are available when **Floor geometry** is set to `Wheel- > - The outer edge must be less than half the wind tunnel width > - Belts are symmetric about Y=0 -#### **Rear wheel belts X** +#### Rear wheel belts X *X-range (minimum, maximum) defining the extent of the rear wheel belts.* @@ -208,7 +208,7 @@ The following parameters are available when **Floor geometry** is set to `Wheel- - **Units:** Length >**Note:** Minimum X must be greater than the maximum X of the front wheel belts. -#### **Rear wheel belts Y** +#### Rear wheel belts Y *Y-range (inner edge, outer edge) defining the lateral position of the rear wheel belts.* diff --git a/docs/02.simulation-setup/02.mesh/02.mesh-parameters.md b/docs/02.simulation-setup/02.mesh/02.mesh-parameters.md index f8fabaa..e4d26ff 100644 --- a/docs/02.simulation-setup/02.mesh/02.mesh-parameters.md +++ b/docs/02.simulation-setup/02.mesh/02.mesh-parameters.md @@ -2,7 +2,7 @@ *The Mesh parameters in Flow360 provide fundamental control over mesh generation, affecting both surface and volume mesh characteristics. These settings serve as global defaults that determine the quality and characteristics of the computational mesh.* -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -24,11 +24,11 @@ | [**Sliding interface tolerance**](#sliding-interface-tolerance) | Tolerance for sliding interface detection | `Advanced` | -## **Detailed Descriptions** +## Detailed Descriptions -### **Surface mesh** +### Surface mesh -#### **Surface edge growth rate** +#### Surface edge growth rate *Controls the size progression of mesh elements grown from edges, affecting the transition between regions of different refinement (anisotropic to isotropic).* @@ -39,7 +39,7 @@ > - Cannot be overridden per edge > - Higher values lead to faster mesh size growth but may reduce quality -#### **Surface max edge length** +#### Surface max edge length *Defines the maximum allowable length for any mesh edge on surfaces.* @@ -50,7 +50,7 @@ > - Should be chosen based on geometry scale and required resolution > - Affects overall mesh density and computational cost -#### **Surface max aspect ratio** +#### Surface max aspect ratio *Maximum aspect ratio allowed for surface mesh cells.* @@ -61,7 +61,7 @@ > - Cannot be overridden per face > - Lower values enforce more isotropic surface cells -#### **Geometry accuracy** +#### Geometry accuracy *The smallest length scale that will be resolved accurately by the surface meshing process.* @@ -72,7 +72,7 @@ > - Can be overridden with [Geometry Refinement](./06.refinements/07.geometry-refinement.md) > - A smaller value results in a finer mesh and higher cell count -#### **Curvature resolution angle** +#### Curvature resolution angle *Specifies the maximum angular deviation allowed in the surface mesh.* @@ -85,7 +85,7 @@ > - Can be overridden per face only when using Geometry AI > - Lower values capture curvature more accurately but increase mesh density -#### **Sealing size** +#### Sealing size *Threshold size below which all geometry gaps are automatically closed.* @@ -96,7 +96,7 @@ > - Can be overridden with [Geometry Refinement](./06.refinements/07.geometry-refinement.md) > - Useful for closing small holes or gaps in imperfect CAD geometry -#### **Resolve face boundaries** +#### Resolve face boundaries *Toggle to specify whether boundaries between adjacent faces should be resolved accurately using anisotropic mesh refinement.* @@ -108,9 +108,9 @@ --- -### **Volume mesh** +### Volume mesh -#### **Boundary layer growth rate** +#### Boundary layer growth rate *Defines the growth rate of prismatic layers in the boundary layer region.* @@ -122,7 +122,7 @@ > - Lower values create more gradual growth but increase total element count > - Critical for accurate boundary layer resolution -#### **Boundary layer first layer thickness** +#### Boundary layer first layer thickness *Specifies the height of the first prismatic layer adjacent to wall surfaces.* @@ -135,9 +135,9 @@ --- -### **Advanced** +### Advanced -#### **Refinement factor** +#### Refinement factor *Global scaling factor that affects the overall mesh refinement level.* @@ -149,7 +149,7 @@ > - For example, if `refinement factor = 2`, all spacings will be divided by \( 2^{1/3} \), resulting in approximately 2× more nodes > - Useful for quick mesh resolution studies -#### **Gap treatment strength** +#### Gap treatment strength *Controls how the mesh transitions in narrow gaps between surfaces.* @@ -160,7 +160,7 @@ > - Higher values dedicate more space to isotropic mesh in narrow gaps > - Critical for mesh quality in tight geometric spaces -#### **Number of boundary layers** +#### Number of boundary layers *Specifies a fixed number of volumetric anisotropic (boundary layer) elements.* @@ -171,7 +171,7 @@ > - Cannot be overridden per face > - When not specified, the volume mesher automatically calculates the required number of layers to grow boundary layer elements to isotropic size -#### **Planar face tolerance** +#### Planar face tolerance *Tolerance used for detecting planar faces in the input geometry that need to be remeshed, such as symmetry planes.* @@ -181,7 +181,7 @@ > - Cannot be overridden per face > - Used to identify and preserve flat surfaces during meshing -#### **Surface max adaptation iterations** +#### Surface max adaptation iterations *Maximum number of adaptation iterations for the surface mesher.* @@ -191,7 +191,7 @@ > - Only available when using Geometry AI > - Higher values may improve mesh quality but increase meshing time -#### **Preserve thin geometry** +#### Preserve thin geometry *Toggle to specify whether thin geometry features should be resolved accurately during the surface meshing process.* @@ -202,7 +202,7 @@ > - Can be overridden with [Geometry Refinement](./06.refinements/07.geometry-refinement.md) > - May improve mesh quality but increase meshing time -#### **Sliding interface tolerance** +#### Sliding interface tolerance *Tolerance used for detecting or creating curves lying on sliding interfaces.* diff --git a/docs/02.simulation-setup/02.mesh/03.rotation-zones.md b/docs/02.simulation-setup/02.mesh/03.rotation-zones.md index cfc1198..b53833c 100644 --- a/docs/02.simulation-setup/02.mesh/03.rotation-zones.md +++ b/docs/02.simulation-setup/02.mesh/03.rotation-zones.md @@ -1,7 +1,7 @@ # Rotation regions *Rotation volume zones designed specifically for regions containing rotating components. They ensure proper mesh refinement and enable accurate simulation of rotating machinery.* -## **Configuration Parameters** +## Configuration Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -12,9 +12,9 @@ | **Enclosed entities** | Additional geometric entities within the cylinder | -## **Detailed Descriptions** +## Detailed Descriptions -### **Spacing Axial** +### Spacing Axial Defines the mesh spacing along the cylinder axis. @@ -22,7 +22,7 @@ Defines the mesh spacing along the cylinder axis. - **Example:** `0.02 m` >**Note:** Critical for capturing axial flow features and gradients. -### **Spacing Radial** +### Spacing Radial Specifies the mesh spacing in the radial direction. @@ -30,7 +30,7 @@ Specifies the mesh spacing in the radial direction. - **Example:** `0.01 m` >**Note:** Important for resolving radial flow patterns and boundary layer development. -### **Spacing Circumferential** +### Spacing Circumferential Controls the mesh spacing in the circumferential direction. @@ -38,7 +38,7 @@ Controls the mesh spacing in the circumferential direction. - **Example:** `0.015 m` >**Note:** Essential for capturing rotational effects and circumferential variations. -### **Assigned cylinders** +### Assigned cylinders Identifies the cylindrical regions where axisymmetric refinement will be applied. @@ -47,7 +47,7 @@ Identifies the cylindrical regions where axisymmetric refinement will be applied > - Must reference valid cylinder entities in the geometry. > - Assign the cylinders by selecting from the list using the + button or select graphically in the viewer region. -### **Enclosed entities** +### Enclosed entities Specifies the geometric entities that are directly enclosed by this rotation zone. For multizone meshes with nested cylinders, select entities that are **exactly one level below** the current cylinder in the nesting hierarchy. @@ -64,7 +64,7 @@ Specifies the geometric entities that are directly enclosed by this rotation zon >- **Internal rotating zone**: Enclosed entities should be the **airfoil** (the geometry directly inside it). >- **External rotating zone**: Enclosed entities should be the **internal cylinder** (the cylinder that defines the internal rotating zone, which is the entity one level below the external cylinder). -## **Key Features** +## Key Features - Generates concentric mesh structure ideal for rotating components - Can enclose other objects without intersecting them diff --git a/docs/02.simulation-setup/02.mesh/04.custom-zones.md b/docs/02.simulation-setup/02.mesh/04.custom-zones.md index a115f15..a7517d8 100644 --- a/docs/02.simulation-setup/02.mesh/04.custom-zones.md +++ b/docs/02.simulation-setup/02.mesh/04.custom-zones.md @@ -2,7 +2,7 @@ *Custom zones allow you to create user-defined volume mesh zones from custom volumes. The names of the generated volume zones will match the names of the custom volumes.* -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -11,15 +11,15 @@ | [**Assigned custom volume**](#assigned-custom-volume) | Custom volume entities to generate zones from | always | -## **Detailed Descriptions** +## Detailed Descriptions -### **Name** +### Name *Display name for this custom zone configuration.* - **Default:** `Custom zone` -### **Element type** +### Element type *Specifies the type of mesh elements to be used for the generated volume zones.* @@ -32,7 +32,7 @@ > - `Mixed` typically produces fewer elements and better quality for most geometries > - `Tetrahedra` may be preferred for CHT solid zones -### **Assigned custom volume** +### Assigned custom volume *The custom volume entities from which volume zones will be generated.* diff --git a/docs/02.simulation-setup/02.mesh/05.volume-mesh-slices.md b/docs/02.simulation-setup/02.mesh/05.volume-mesh-slices.md index 83b10d0..0436ed7 100644 --- a/docs/02.simulation-setup/02.mesh/05.volume-mesh-slices.md +++ b/docs/02.simulation-setup/02.mesh/05.volume-mesh-slices.md @@ -2,7 +2,7 @@ *Volume mesh slices allow you to extract planar slice outputs from the generated volume mesh. These slices can be used to inspect the mesh quality and structure at specific locations.* -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -12,15 +12,15 @@ | [**Cutoff radius**](#cutoff-radius) | Limit the radial extent of slices | always | -## **Detailed Descriptions** +## Detailed Descriptions -### **Name** +### Name *Display name for this mesh slice output configuration.* - **Default:** `Volume mesh slice` -### **Assigned slices** +### Assigned slices *The slice entities that define where to extract mesh data.* @@ -30,7 +30,7 @@ > - Each slice is defined by an origin point and a normal direction > - Multiple slices can be assigned to a single output configuration -### **Include crinkled slices** +### Include crinkled slices *Toggle to generate crinkled (stair-stepped) slices.* @@ -40,7 +40,7 @@ > - Crinkled slices follow cell boundaries, showing the actual mesh structure > - Crinkled slices are useful for inspecting mesh topology and cell distribution -### **Cutoff radius** +### Cutoff radius *Optional radial limit for the slice output, measured from the slice origin.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/01.surface-edge-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/01.surface-edge-refinement.md index 825007d..1ad2282 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/01.surface-edge-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/01.surface-edge-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|-----------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Method** +### Method | *Option* | *Description* | |------------|-----------------| @@ -24,7 +24,7 @@ | **Project aniso spacing** | Projects anisotropic spacing from surface to edges | | **Aspect ratio** | Controls element quality by limiting maximum aspect ratio | -### **Assigned edges** +### Assigned edges *Identifies the geometric edges where refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/02.surface-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/02.surface-refinement.md index 0945d9d..15d9472 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/02.surface-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/02.surface-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|-----------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Max Edge Length** +### Max Edge Length *Defines the upper bound for surface mesh element size.* @@ -23,7 +23,7 @@ - **Example:** `0.05 m` >**Note:** Should be chosen based on smallest geometric feature requiring resolution. -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric surfaces where refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/03.boundary-layer-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/03.boundary-layer-refinement.md index b791149..3814330 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/03.boundary-layer-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/03.boundary-layer-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|-----------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **First Layer Thickness** +### First Layer Thickness *Specifies the height of the initial prismatic layer adjacent to the wall.* @@ -23,7 +23,7 @@ - **Example:** `1e-5 m` >**Note:** Critical for achieving desired y+ values and resolving viscous effects. -### **Assigned surfaces** +### Assigned surfaces *Identifies the wall surfaces where boundary layer refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/04.passive-spacing.md b/docs/02.simulation-setup/02.mesh/06.refinements/04.passive-spacing.md index c75d92b..0d9bab1 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/04.passive-spacing.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/04.passive-spacing.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|------------------------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Type** +### Type *Specifies the methodology for spacing control.* @@ -25,7 +25,7 @@ - `unchanged`: Preserves existing surface mesh. >**Note:** Selection determines how mesh spacing is controlled. -### **Assigned surfaces** +### Assigned surfaces *Identifies the surfaces where spacing control will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/05.uniform-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/05.uniform-refinement.md index 2d16afa..0598e38 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/05.uniform-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/05.uniform-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|----------------------------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Spacing** +### Spacing *Defines the uniform mesh spacing within the refinement region.* @@ -23,7 +23,7 @@ - **Example:** `0.1 m` >**Note:** Should be chosen based on flow feature size and resolution requirements. -### **Assigned boxes and cylinders** +### Assigned boxes and cylinders *Specifies the volumes where uniform refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/06.axisymmetric-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/06.axisymmetric-refinement.md index 04b3a40..6dc28a4 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/06.axisymmetric-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/06.axisymmetric-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|----------------------------------| @@ -15,9 +15,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Spacing Axial** +### Spacing Axial *Defines the mesh spacing along the cylinder axis.* @@ -25,7 +25,7 @@ - **Example:** `0.02 m` >**Note:** Critical for capturing axial flow features and gradients. -### **Spacing Radial** +### Spacing Radial *Specifies the mesh spacing in the radial direction.* @@ -33,7 +33,7 @@ - **Example:** `0.01 m` >**Note:** Important for resolving radial flow patterns and boundary layer development. -### **Spacing Circumferential** +### Spacing Circumferential *Controls the mesh spacing in the circumferential direction.* @@ -41,7 +41,7 @@ - **Example:** `0.015 m` >**Note:** Essential for capturing rotational effects and circumferential variations. -### **Assigned volumes** +### Assigned volumes *Identifies the axisymmetric regions where axisymmetric refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/07.geometry-refinement.md b/docs/02.simulation-setup/02.mesh/06.refinements/07.geometry-refinement.md index 19ad5a0..b48cece 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/07.geometry-refinement.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/07.geometry-refinement.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------|-----------------| @@ -14,9 +14,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Geometry accuracy** +### Geometry accuracy *Specifies the minimum length scale that the surface meshing process will accurately resolve.* @@ -27,7 +27,7 @@ > - A smaller `Geometry accuracy` value will result in a finer mesh and consequently a larger cell count and longer computation time. > - Start with a larger value and decrease it iteratively to find the optimal balance between accuracy and computational cost. -### **Preserve thin geometry** +### Preserve thin geometry *Specifies whether thin geometry features should be accurately resolved during surface meshing.* @@ -35,7 +35,7 @@ > **Notes:** > - Resolves features with thickness roughly equal to `geometry_accuracy`. -### **Assigned surfaces** +### Assigned surfaces *The list of surfaces where the geometry refinement will be applied.* diff --git a/docs/02.simulation-setup/02.mesh/06.refinements/README.md b/docs/02.simulation-setup/02.mesh/06.refinements/README.md index 2e51e31..a8d319b 100644 --- a/docs/02.simulation-setup/02.mesh/06.refinements/README.md +++ b/docs/02.simulation-setup/02.mesh/06.refinements/README.md @@ -2,7 +2,7 @@ *This document provides an overview of mesh refinement capabilities in Flow360. Refinements enable precise control over mesh resolution in specific regions of your geometry to better capture flow features or geometric details.* -## **Available Refinement Types** +## Available Refinement Types | *Refinement type* | *Description* | |--------------------|-----------------| @@ -14,9 +14,9 @@ |[**Axisymmetric Refinement**](./06.axisymmetric-refinement.md) | Creates structured-like mesh with cylindrical bias | |[**Geometry Refinement**](./07.geometry-refinement.md) | Controls mesh resolution based on geometric features | -## **General Guidelines** +## General Guidelines -### **Refinement Selection** +### Refinement Selection 1. **Surface Features** - Use Surface Edge Refinement for leading/trailing edges @@ -29,7 +29,7 @@ - Apply Axisymmetric Refinement for rotating machinery - Consider Passive Spacing for interface regions -### **Best Practices** +### Best Practices - Start with coarser refinements and gradually increase resolution where needed - Ensure smooth transitions between regions of different refinement levels @@ -37,7 +37,7 @@ - Balance resolution requirements with computational cost - Account for flow regime and Reynolds number effects -### **Common Applications** +### Common Applications 1. **Aerodynamic Simulations** - Surface Edge Refinement for leading edges diff --git a/docs/02.simulation-setup/02.mesh/README.md b/docs/02.simulation-setup/02.mesh/README.md index 228e689..75a70ac 100644 --- a/docs/02.simulation-setup/02.mesh/README.md +++ b/docs/02.simulation-setup/02.mesh/README.md @@ -1,7 +1,7 @@ # Mesh A section for defining the meshing settings. -## **Contents** +## Contents | *Settings group* | *Description* | |--------------------|-----------------| @@ -14,29 +14,29 @@ A section for defining the meshing settings. --- -## **Detailed Descriptions** +## Detailed Descriptions -### **[Farfield](./01.farfield.md)** +### [Farfield](./01.farfield.md) *Defines the outer boundaries of your computational domain. Includes automated farfield, user-defined farfield, and wind tunnel configurations with various floor types.* -### **[Mesh (meshing defaults)](./02.mesh-parameters.md)** +### [Mesh (meshing defaults)](./02.mesh-parameters.md) *Fundamental control parameters for mesh generation affecting both surface and volume mesh characteristics. Provides global defaults for element size progression, boundary layer characteristics, surface mesh properties, and overall mesh quality control.* -### **[Rotation zones](./03.rotation-zones.md)** +### [Rotation zones](./03.rotation-zones.md) *Specialized cylindrical volume zones designed for regions containing rotating components. Ensures proper mesh refinement and enables accurate simulation of rotating machinery with concentric mesh structure ideal for rotating components.* -### **[Custom zones](./04.custom-zones.md)** +### [Custom zones](./04.custom-zones.md) *User-defined volume zones created from custom volumes or seedpoint volumes for specialized meshing regions.* -### **[Volume mesh slices](./05.volume-mesh-slices.md)** +### [Volume mesh slices](./05.volume-mesh-slices.md) *Configuration for extracting slice outputs from the generated volume mesh.* -### **[Refinements](./06.refinements/README.md)** +### [Refinements](./06.refinements/README.md) *Comprehensive local mesh control system for critical regions. Provides seven refinement types.* diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/01.wall.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/01.wall.md index dea97fd..ef1a301 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/01.wall.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/01.wall.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -24,9 +24,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Use wall function** +### Use wall function *Enables wall function approximation to model the near-wall region without resolving it.* @@ -34,7 +34,7 @@ - **Default:** Disabled - **Note:** When enabled, allows the use of coarser meshes with larger y+ values (30-300). -### **Motion** +### Motion *Defines how the wall moves relative to the fluid.* @@ -51,35 +51,35 @@ > - When using the `Rotating wall` or `User-defined` option, the specified velocity will be in reference to the absolute reference frame. > - If the wall is supposed to be stationary in the absolute reference frame, the velocity should be set to `0` using `Rotating wall` or `User-defined` option. -### **Center** +### Center *Defines the coordinates of the center of rotation for a rotating wall.* - **Required when `Rotating wall` selected.** - **Example:** `(0, 0, 0) m` -### **Axis** +### Axis *Defines the rotation axis components for a rotating wall.* - **Required when `Rotating wall` selected.** - **Example:** `(0, 0, 1)` -### **Angular velocity** +### Angular velocity *Defines the rate of rotation for a rotating wall.* - **Required when `Rotating wall` selected.** - **Example:** `300 RPM` -### **Static pressure** +### Static pressure *Static Pressure for Slater porous bleed model.* - **Required when `Slater porous bleed` selected.** - **Example:** `101325 Pa` -### **Porosity** +### Porosity *Porosity for Slater porous bleed model.* @@ -89,14 +89,14 @@ >- Can be between `0` (exclusive) and `1` (inclusive). >- Porosity of `0` is equivalent to a solid wall, and porosity of `1` is equivalent to a fluid interface. -### **Activation step** +### Activation step *Pseudo step in the simulation at which Slater porous bleed model is activated.* - **Default:** `0` - **Example:** `10` -### **Velocity components** +### Velocity components *Specifies the velocity vector for moving walls.* @@ -104,7 +104,7 @@ - **Example:** `(10, 0, 0) m/s` for a wall moving in the x-direction -### **Heat flux** +### Heat flux *Defines the thermal behavior of the wall using its heat flux.* @@ -112,14 +112,14 @@ - **Example:** `-30 W/m²` >**Notes:** Heat flux of `0` means an adiabatic wall. -### **Temperature** +### Temperature *Defines the static temperature of the wall.* - **Required when `Temperature` selected.** - **Example:** `300 K` -### **Roughness height** +### Roughness height *Specifies the equivalent sand grain roughness height of the wall surface.* @@ -127,7 +127,7 @@ - **Example:** `0.0001 m` >**Note:** Only available for boundaries associated with a Fluid zone. -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the wall boundary condition is applied.* diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/02.freestream.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/02.freestream.md index 6c2786d..99652dc 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/02.freestream.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/02.freestream.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -16,21 +16,21 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Use operating condition's velocity** +### Use operating condition's velocity *Uses freestream conditions defined in the [Operating condition](../../01.flow-conditions/README.md) section.* - **Default:** Selected -### **Custom** +### Custom *Allows specification of local freestream conditions for this boundary instead of using the freestream conditions defined in the Operating Condition section.* - **Default:** Unselected -### **Velocity Components** +### Velocity Components *Explicit values or expressions for the freestream velocity vector, available when overriding Operating Condition settings.* @@ -42,7 +42,7 @@ >- Each component can be a constant value or a mathematical expression using variables like x, y, z, t >- Mathematical expressions are only available through the Python API, not in the GUI -### **Turbulence Quantities** +### Turbulence Quantities *Optional specification of turbulence parameters at the boundary.* @@ -53,7 +53,7 @@ >- Only specify at most two turbulence parameters >- See [Turbulence Quantities documentation](./08.turbulence-quantities.md) for valid combinations and detailed explanations -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the freestream boundary condition is applied.* diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/03.inflow.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/03.inflow.md index 794f468..68bf356 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/03.inflow.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/03.inflow.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -19,23 +19,23 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Total temperature** +### Total temperature *The stagnation (total) temperature of the flow at the inlet boundary.* - **Required** - **Example (constant):** `300 K` -### **Velocity direction** +### Velocity direction *The primary direction of the incoming flow at the inlet boundary.* - **Default:** If not specified, the boundary patch normal is used - **Example:** `(1, 0, 0)` -### **Total pressure** +### Total pressure *The stagnation (total) pressure of the flow at the inlet boundary. This is the pressure the flow would have if brought to rest isentropically.* @@ -44,7 +44,7 @@ >**Important:** For subsonic flows (Total Pressure specification), the full flow state is not specified at the inflow boundary. When total temperature, velocity direction, and total pressure are specified, the static pressure at the inflow is only determined after convergence of the solution. This occurs because in subsonic flow, one of the characteristics travels upstream, so information cannot be fully determined at the upstream boundary. -### **Static pressure** +### Static pressure *The static pressure for supersonic inflow conditions. This is the actual pressure of the flowing fluid at the inlet boundary.* @@ -55,21 +55,21 @@ >- This is necessary because in supersonic flows, information cannot propagate upstream, so the complete flow state must be prescribed at the boundary >- It is useful to use the isentropic relations to specify the velocity when setting up supersonic inflow conditions -### **Mass flow rate (value)** +### Mass flow rate (value) *The mass flow rate through the inlet boundary.* - **Required:** Yes (when Inflow specification is `Mass Flow Rate`) - **Example:** `10 kg/s` -### **Ramp steps** +### Ramp steps *The number of pseudo time steps over which to gradually increase the mass flow rate to the specified value.* - **Default:** `0` (full mass flow rate applied immediately) - **Example:** `100` -### **Turbulence quantity** +### Turbulence quantity *Optional specification of turbulence parameters at the boundary.* @@ -79,14 +79,14 @@ >- Only specify at most two turbulence parameters >- See [Turbulence Quantities documentation](./08.turbulence-quantities.md) for valid combinations and detailed explanations -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the inflow boundary condition is applied.* - **Accepted types:** Surface >**Note:** Assign the boundaries by selecting from the list using the + button or select graphically in the viewer region. -## **Turbulence Specification** +## Turbulence Specification For recommendations on turbulence parameter values for various flow conditions, see the [Turbulence Quantities documentation](./08.turbulence-quantities.md). @@ -95,7 +95,7 @@ For recommendations on turbulence parameter values for various flow conditions,

💡 Tips

 -### **Choosing Inflow Specification Method** +### Choosing Inflow Specification Method - **Total Pressure:** This specification is often best suited when: - You know the pressure at the inlet (e.g., atmospheric conditions). @@ -112,13 +112,13 @@ For recommendations on turbulence parameter values for various flow conditions, - You know both the total and static pressure at the inlet. - You are modeling high-speed flows such as jet engines, rocket nozzles, or supersonic wind tunnels. -### **Inlet Placement** +### Inlet Placement - Place inlets where flow conditions are known and relatively uniform - Allow sufficient distance upstream of complex geometry (5-10 characteristic lengths) - Avoid placing inlets immediately upstream of sharp turns or area changes -### **Convergence Strategies** +### Convergence Strategies - Start with a lower mass flow rate and gradually increase it - Monitor residuals and mass conservation to ensure proper convergence diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/04.outflow.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/04.outflow.md index 0963005..681cedc 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/04.outflow.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/04.outflow.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -17,9 +17,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Outflow specification** +### Outflow specification *Method used to specify the outflow conditions.* @@ -29,7 +29,7 @@ - `Mach ` >**Note:** Choose the method that best matches your known boundary conditions or simulation requirements. -### **Pressure** +### Pressure *The static pressure at the outlet boundary.* @@ -37,7 +37,7 @@ - **Example:** `101325 Pa` >**Note:** The solver enforces this pressure at the boundary. -### **Mach** +### Mach *The target Mach number at the outlet boundary.* @@ -45,7 +45,7 @@ - **Example:** `0.8` >**Note:** The solver adjusts the back pressure to achieve the specified Mach number. -### **Mass flow rate** +### Mass flow rate *The mass flow rate through the outlet boundary.* @@ -53,7 +53,7 @@ - **Example:** `10 kg/s` >**Note:** The solver adjusts the pressure at the boundary to achieve the specified mass flow rate. -### **Ramp steps** [Python only] +### Ramp steps [Python only] *Number of pseudo steps over which to gradually increase the mass flow rate to its specified value within 1 physical step.* @@ -61,7 +61,7 @@ - **Example:** `100` >**Note:** Ramping can improve stability for simulations with high mass flow rates. -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the outflow boundary condition is applied.* @@ -73,7 +73,7 @@

💡 Tips

 -### **Choosing Outflow Specification Method** +### Choosing Outflow Specification Method - **Pressure** is best when: - You know the pressure at the outlet (e.g., atmospheric conditions) @@ -90,21 +90,21 @@ - Modeling systems with multiple inlets/outlets - When matching experimental flow conditions -### **Outlet Placement** +### Outlet Placement - Place outlets where flow is fully developed if possible - Allow sufficient distance downstream of complex geometry (10-15 characteristic lengths) - Avoid placing outlets near regions with strong gradients or flow separation - For external aerodynamics, ensure outlet boundaries are far downstream of wake regions -### **Convergence Strategies** +### Convergence Strategies - Start with a higher static pressure and gradually decrease it - Use the Ramp Steps option for challenging cases - For subsonic internal flows, try to match the expected static pressure - For supersonic flows, ensure the outlet is placed where the flow is fully supersonic -### **Common Issues** +### Common Issues - Reversed flow at outlets may indicate incorrect pressure settings - For multiple outlets, ensure total mass flow is conserved diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/05.periodic.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/05.periodic.md index d96f1ed..e953e1d 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/05.periodic.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/05.periodic.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -14,9 +14,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Periodicity Type** +### Periodicity Type *Defines the geometric relation between periodic boundaries.* @@ -26,7 +26,7 @@ - **Default:** `Translational` >**Note:** Translational periodicity is typically used for linear arrays, while rotational periodicity is used for circular arrangements. -### **Axis of rotation** +### Axis of rotation *The axis about which rotational periodicity is applied.* @@ -34,7 +34,7 @@ - **Example:** Vector `(0, 0, 1)` for rotation around the z-axis. >**Note:** The rotation angle is determined automatically from the mesh geometry. -### **Assigned surfaces** +### Assigned surfaces *Matching pairs of boundaries that will be treated as periodic interfaces.* @@ -48,7 +48,7 @@

💡 Tips

 -### **Mesh Preparation for Periodic Boundaries** +### Mesh Preparation for Periodic Boundaries - **For Translational Periodicity:** - Periodic surfaces should have similar (but not necessarily identical) mesh resolution @@ -60,7 +60,7 @@ - Flow360 automatically handles the rotational transformation - For best results, maintain similar element sizes across interfaces -### **Common Applications** +### Common Applications - **Translational Periodicity:** - Airfoil or blade cascades @@ -74,7 +74,7 @@ - Propeller/rotor blade analysis using one blade - Components with cyclic symmetry -### **Performance Considerations** +### Performance Considerations - Periodic boundaries typically reduce computational cost significantly - For rotational cases, ensure sufficient sector size to capture relevant flow features diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/06.symmetry.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/06.symmetry.md index 490f8c3..eced441 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/06.symmetry.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/06.symmetry.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -12,9 +12,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the symmetry boundary condition is applied.* @@ -39,7 +39,7 @@ Key properties of the symmetry boundary:

💡 Tips

 -### **When to Use Symmetry** +### When to Use Symmetry - **Geometric Symmetry:** Use when the geometry has a clear plane of symmetry - Example: Aircraft simulated with half-model (using vertical symmetry plane) @@ -50,13 +50,13 @@ Key properties of the symmetry boundary: - Example: Straight-ahead flow for ground vehicles - Example: Axisymmetric flows like nozzles (using an axis of symmetry) -### **Computational Benefits** +### Computational Benefits - Reduces computational domain size by a factor of 2 for each symmetry plane - Can significantly decrease mesh size and computation time - Allows allocation of computational resources to higher mesh resolution in the simulated portion -### **Mesh Considerations** +### Mesh Considerations - Ensure the mesh at the symmetry boundary is aligned with the symmetry plane - Create a clean, high-quality mesh at the symmetry boundary diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/07.slip-wall.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/07.slip-wall.md index 2249548..e67eab3 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/07.slip-wall.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/07.slip-wall.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |------------|----------------------------------|----------| @@ -12,9 +12,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Assigned surfaces** +### Assigned surfaces *Specifies the geometric boundaries to which the slip wall boundary condition is applied.* @@ -23,7 +23,7 @@ >- Can reference surfaces by name or pattern. >- Compatible with the `AutomatedFarfield` feature. -## **Key properties** +## Key properties - Zero normal velocity (no flow through the boundary) - Zero shear stress (tangential velocity can vary freely) @@ -36,7 +36,7 @@

💡 Tips

 -### **When to Use Slip Wall** +### When to Use Slip Wall - **Inviscid Flow Approximations:** - When viscous effects are negligible compared to pressure effects @@ -49,14 +49,14 @@ - Ground plane approximation when boundary layer effects aren't important - Far-field boundaries in some cases -### **Computational Benefits** +### Computational Benefits - Requires less mesh resolution near the wall (no boundary layer to resolve) - Can improve convergence for some flow problems - Reduces computational cost compared to resolving viscous walls - Allows for coarser meshes with larger y+ values at the wall -### **Comparison with Other Boundary Types** +### Comparison with Other Boundary Types - **Slip Wall vs. Regular Wall:** - Slip wall: Zero shear stress, no boundary layer diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/08.turbulence-quantities.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/08.turbulence-quantities.md index 34f411c..6439eb7 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/08.turbulence-quantities.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/08.turbulence-quantities.md @@ -6,7 +6,7 @@ --- -## **Available Methods** +## Available Methods You can specify turbulence quantities using one of the following methods, depending on your turbulence model: @@ -34,9 +34,9 @@ You can specify turbulence quantities using one of the following methods, depend --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Turbulent Viscosity Ratio** +### Turbulent Viscosity Ratio *The ratio between turbulent viscosity and laminar viscosity.* @@ -47,7 +47,7 @@ You can specify turbulence quantities using one of the following methods, depend >- For Spalart-Allmaras, this value is converted to Modified Viscosity Ratio. >- Typical values: `0.1`-`10` for external aerodynamics, `10`-`100`for internal flows. -### **Modified Viscosity Ratio** +### Modified Viscosity Ratio *The ratio between modified turbulent viscosity (nuHat) and freestream laminar viscosity.* @@ -57,7 +57,7 @@ You can specify turbulence quantities using one of the following methods, depend >- Applicable only to Spalart-Allmaras model. >- Typical range: `1`-`10` for most applications. -### **Modified Viscosity** +### Modified Viscosity *The absolute value of the modified turbulent viscosity (nuHat).* @@ -66,7 +66,7 @@ You can specify turbulence quantities using one of the following methods, depend >**Note:** Applicable only to Spalart-Allmaras model. - **Units:** Dimensional value with units of viscosity. -### **Turbulent Intensity** +### Turbulent Intensity *Relative turbulence level (as a decimal, not percentage).* @@ -76,7 +76,7 @@ You can specify turbulence quantities using one of the following methods, depend >- Used in formula: k = 1.5(U_ref × I)² where k is turbulent kinetic energy, $U_{ref}$ is reference velocity, I is intensity. >- Typical values: `0.001`-`0.01` (0.1-1%) for external flows, `0.01`-`0.1` (1-10%) for internal flows. -### **Turbulent Length Scale** +### Turbulent Length Scale *Characteristic size of turbulent eddies.* @@ -84,7 +84,7 @@ You can specify turbulence quantities using one of the following methods, depend - **Example:** `0.1 * m` >**Note:** Typically proportional to characteristic length of the domain. For example, 10% of inlet diameter for internal flows. -### **Turbulent Kinetic Energy** +### Turbulent Kinetic Energy *Energy per unit mass in turbulent fluctuations.* @@ -94,7 +94,7 @@ You can specify turbulence quantities using one of the following methods, depend >- Most precise method when specific k value is known. >- Requires dimensional value in consistent units. -### **Specific Dissipation Rate** +### Specific Dissipation Rate *Rate at which turbulence energy converts to thermal energy.* @@ -104,7 +104,7 @@ You can specify turbulence quantities using one of the following methods, depend --- -## **Valid Parameter Combinations** +## Valid Parameter Combinations The following combinations are valid: diff --git a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md index e7f3159..2793cee 100644 --- a/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md +++ b/docs/02.simulation-setup/03.flow-solver/01.boundary-conditions/README.md @@ -4,7 +4,7 @@ Boundary conditions specify how the fluid behaves at the boundaries of the simulation domain. Boundaries conditions define the physical and mathematical conditions at the enclosed faces of the computational domain. Flow360 provides a comprehensive set of boundary conditions to support various simulation scenarios. -## **Overview of Boundary Conditions** +## Overview of Boundary Conditions | *Option* | *Description* | *Key Parameters* | |------------|----------------------------------|----------| diff --git a/docs/02.simulation-setup/03.flow-solver/02.time.md b/docs/02.simulation-setup/03.flow-solver/02.time.md index ec0eb7c..cd15e26 100644 --- a/docs/02.simulation-setup/03.flow-solver/02.time.md +++ b/docs/02.simulation-setup/03.flow-solver/02.time.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options ### Steady @@ -42,9 +42,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Simulation Type** +### Simulation Type *Determines whether the simulation is steady (time-invariant) or unsteady (time-accurate).* @@ -52,7 +52,7 @@ - **Default:** Steady >**Note:** Steady simulations are appropriate for flows that have reached equilibrium, while unsteady simulations are necessary for time-dependent phenomena. -### **Max steps** (Steady only) +### Max steps (Steady only) *The maximum number of pseudo-time steps to run for a steady simulation.* @@ -60,7 +60,7 @@ - **Example:** `5000` >**Note:** Increase this value for complex simulations that may require more iterations to reach convergence. -### **Steps** (Unsteady only) +### Steps (Unsteady only) *The total number of physical time steps for an unsteady simulation.* @@ -68,7 +68,7 @@ - **Example:** `1000` >**Note:** Set based on the total physical time needed to capture the phenomenon of interest. -### **Step size** (Unsteady only) +### Step size (Unsteady only) *The physical time interval between solution snapshots.* @@ -76,7 +76,7 @@ - **Example:** `0.001 s` >**Note:** Should be small enough to resolve the time-dependent features of interest. -### **Maximum pseudo steps** (Unsteady only) +### Maximum pseudo steps (Unsteady only) *Maximum number of iterations performed within each physical time step.* @@ -84,7 +84,7 @@ - **Example:** `30` >**Note:** Higher values ensure better convergence within each physical time step but increase computational cost. -### **Order of accuracy** (Unsteady only) +### Order of accuracy (Unsteady only) *The temporal discretization order.* @@ -92,7 +92,7 @@ - **Default:** `2` >**Note:** Second-order is generally recommended for better accuracy. -### **CFL type** +### CFL type *Method for controlling the Courant-Friedrichs-Lewy (CFL) number, which affects convergence.* @@ -100,7 +100,7 @@ - **Default:** Adaptive >**Note:** Adaptive automatically adjusts CFL based on solution behavior, while Ramp linearly increases it. -### **Min (CFL)** +### Min (CFL) *Lower bound for the CFL number.* @@ -108,7 +108,7 @@ - **Example:** `0.05` >**Note:** Lower values improve stability for challenging cases. -### **Max (CFL)** +### Max (CFL) *Upper bound for the CFL number.* @@ -116,7 +116,7 @@ - **Example:** `50,000` >**Note:** Higher values can accelerate convergence if the solution remains stable. -### **Max relative change** +### Max relative change *Controls how quickly the CFL can increase.* @@ -124,7 +124,7 @@ - **Example:** `5.0` >**Note:** Higher values allow more aggressive CFL increases. -### **Convergence limiting factor** +### Convergence limiting factor *Controls the CFL adaptation.* @@ -132,7 +132,7 @@ - **Example:** `0.5` >**Note:** Lower values make the adaptation more conservative. -### **Initial (CFL)** +### Initial (CFL) *Starting CFL number.* @@ -140,7 +140,7 @@ - **Example:** `2` >**Note:** Lower values improve stability at the start of the simulation. -### **Final (CFL)** +### Final (CFL) *Maximum CFL number to reach.* @@ -148,7 +148,7 @@ - **Example:** `300` >**Note:** Higher values can accelerate convergence if the solution remains stable. -### **Ramp steps** +### Ramp steps *Number of steps to reach the final CFL.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/01.navier-stokes-solver.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/01.navier-stokes-solver.md index c8b8c8b..5e64dcb 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/01.navier-stokes-solver.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/01.navier-stokes-solver.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -25,9 +25,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Absolute tolerance** +### Absolute tolerance *The primary convergence metric for how far to reduce the Navier-Stokes residuals.* @@ -38,7 +38,7 @@ >- Controls when the solver determines the solution has converged >- Smaller values result in more accurate solutions but may require more iterations -### **Relative tolerance** +### Relative tolerance *Relative residual reduction target for the Navier-Stokes equations per physical step.* @@ -49,7 +49,7 @@ >- For unsteady cases, typically set to 1e-2 >- Once residuals drop by prescribed order of magnitude (0.01 means 2 orders of magnitude), solver proceeds to next physical step -### **Kappa MUSCL** +### Kappa MUSCL *Controls the blending between upwind and central schemes in the spatial discretization.* @@ -61,7 +61,7 @@ >- `0.33`: Blended upwind/central scheme (less dissipative, good for low subsonic flows) >- `1.0`: Unstable full downwind scheme (avoid) -### **Order of accuracy** +### Order of accuracy *Determines whether the solver uses 1st or 2nd order spatial discretization.* @@ -73,7 +73,7 @@ >- For initial flow field development in unsteady cases with rotating components, running 1st order for 1-2 revolutions can help establish the flow before switching to 2nd order >- Should match the turbulence model's order of accuracy -### **Equation evaluation frequency** +### Equation evaluation frequency *Controls how often (in pseudo steps) the Navier–Stokes equations are solved.* @@ -83,7 +83,7 @@ >- `1` provides the most robust convergence >- Higher values can reduce time cost but may slow down convergence -### **Linear solver - max iterations*** +### Linear solver - max iterations* *Configures the maximum number of iterations solved at each pseudo-step for Navier-Stokes equations.* @@ -92,7 +92,7 @@ >**Note:** >- Increasing the parameter can improve robustness at added cost per pseudo-step -### **CFL multiplier** +### CFL multiplier *Scaling factor applied to the CFL number defined in Time Stepping.* @@ -102,7 +102,7 @@ > - Reducing this value can help stability for challenging cases > - Effective CFL = Time Stepping CFL × CFL Multiplier -### **Numerical dissipation factor** +### Numerical dissipation factor *Factor that controls the reduction in numerical flux dissipation for the low-dissipation Roe scheme.* @@ -112,7 +112,7 @@ >- Range: [`0.01`, `1.0`] >- Recommended value: `0.2` for low-dissipation -### **Limit velocity** +### Limit velocity *Applies limiters to velocity to enhance stability in transonic/supersonic flows.* @@ -122,7 +122,7 @@ >- Enable for transonic or supersonic cases >- Can help prevent divergence in regions with strong shocks -### **Limit pressure density** +### Limit pressure density *Applies limiters to pressure and density to enhance stability in transonic/supersonic flows.* @@ -132,7 +132,7 @@ >- Enable for transonic or supersonic cases >- Can help prevent negative pressures or densities near shocks -### **Low Mach preconditioner** +### Low Mach preconditioner *Improves solver convergence for low Mach number flows by addressing the stiffness in the equation system.* @@ -143,7 +143,7 @@ >- Particularly beneficial for nearly incompressible flows >- Can significantly accelerate convergence for low-speed aerodynamics -### **Low Mach preconditioner threshold** +### Low Mach preconditioner threshold *Minimum Mach number used in the preconditioner scaling.* @@ -153,7 +153,7 @@ >- For flow regions with Mach numbers smaller than this threshold, the threshold value is used >- Only relevant when low Mach preconditioner is enabled -### **Update Jacobian frequency** +### Update Jacobian frequency *Controls how often the Jacobian matrix is updated during the solution process.* @@ -164,7 +164,7 @@ >- Reducing to `1` may help convergence for difficult cases >- May slow the solver by up to approximately 30% when set to `1` -### **Max force jacobian update physical steps** +### Max force jacobian update physical steps *If the current physical step is lower than this value, jacobian matrix will be updated at every pseudo step.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/02.turbulence-model.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/02.turbulence-model.md index 3bba0c3..94f1656 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/02.turbulence-model.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/02.turbulence-model.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -25,9 +25,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Type** +### Type *The turbulence modeling approach used in the simulation.* @@ -41,7 +41,7 @@ >- SST provides better predictions for separated flows and adverse pressure gradients >- None can be used for laminar flow simulations or for ILES simulations when combined with appropriate numerical settings -### **Absolute tolerance** +### Absolute tolerance *The convergence threshold for turbulence equation residuals.* @@ -52,7 +52,7 @@ >- Controls when the solver considers the turbulence equations converged >- May need to be relaxed for challenging cases -### **Relative tolerance** +### Relative tolerance *Relative residual reduction target for the turbulence equations per physical step.* @@ -63,7 +63,7 @@ >- For unsteady cases, typically set to 1e-2 >- Once residuals drop by prescribed order of magnitude (0.01 means 2 orders of magnitude), solver proceeds to next physical step -### **Rotation correction** +### Rotation correction *Applies corrections to the turbulence model for rotation and curvature effects.* @@ -74,7 +74,7 @@ >- Improves accuracy for flows with system rotation >- Accounts for effects of rotation and curvature on turbulence production -### **Hybrid model** +### Hybrid model *Settings for Detached Eddy Simulation (DES) or other hybrid RANS-LES approaches.* @@ -87,7 +87,7 @@ >- Requires sufficiently fine mesh in regions of interest >- Better captures unsteady large-scale structures than pure RANS -### **Quadratic constitutive relation** +### Quadratic constitutive relation *Uses a non-linear relation for the Reynolds stress tensor instead of the Boussinesq approximation.* @@ -98,7 +98,7 @@ >- Particularly useful for strongly swirling flows >- Slightly increases computational cost -### **Order of accuracy** +### Order of accuracy *Spatial discretization order for turbulence variables.* @@ -108,7 +108,7 @@ >- `1` is more robust; `2` is more accurate >- In most cases it should be kept at default value -### **Equation evaluation frequency** +### Equation evaluation frequency *Controls how often (in pseudo steps) turbulence equations are solved.* @@ -118,7 +118,7 @@ >- `1` provides the most robust convergence >- Higher values can reduce time cost but may slow down convergence -### **Linear solver - max iterations*** +### Linear solver - max iterations* *Configures the maximum number of iterations solved at each pseudo-step for turbulence equations.* @@ -127,7 +127,7 @@ >**Note:** >- Increasing the parameter can improve robustness at added cost per pseudo-step -### **CFL multiplier** +### CFL multiplier *Scales the CFL number specifically for the turbulence equations.* @@ -138,7 +138,7 @@ >- Reducing this can improve stability for difficult cases >- Effective turbulence CFL = Time Stepping CFL × CFL Multiplier -### **Reconstruction gradient limiter** +### Reconstruction gradient limiter *Controls the aggressiveness of gradient limiting for turbulence variables.* @@ -150,7 +150,7 @@ >- `2.0`: No limiting (can be unstable) >- Lower values improve stability but increase numerical dissipation -### **Modeling constants** +### Modeling constants *Model-specific constants that control various aspects of the turbulence model.* @@ -163,7 +163,7 @@ >- Only modify if you have specific reason and validation data >- Proper validation required when modifying constants -### **Update Jacobian frequency** +### Update Jacobian frequency *Controls how often the Jacobian matrix for the turbulence equations is updated.* @@ -174,7 +174,7 @@ >- For challenging cases, set to 1 >- For well-behaved flows, 4 is typically sufficient -### **Max force jacobian update physical steps** +### Max force jacobian update physical steps *If the current physical step is lower than this value, jacobian matrix will be updated at every pseudo step.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/03.transition-model.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/03.transition-model.md index 46c3401..c83b541 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/03.transition-model.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/03.transition-model.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -24,9 +24,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Type** +### Type *The type of transition modeling approach used in the simulation.* @@ -39,7 +39,7 @@ >- AmplificationFactorTransport is based on the Gamma-ReTheta model with enhancements >- Applicable to a wide range of external and internal flows -### **Turbulence intensity percent** +### Turbulence intensity percent *The freestream turbulence intensity as a percentage.* @@ -52,7 +52,7 @@ > - Internally converted to N_crit via correlation > - Lower values delay transition (typical wind tunnel: `0.05`-`0.1`%) -### **N_crit** +### N_crit *The critical amplification factor for transition onset.* @@ -66,7 +66,7 @@ > - Wind tunnel typically `5`-`8` depending on quality > - Relation to turbulence intensity: N_crit = -8.43 - 2.4*ln(0.025*tanh(Tu%/2.5)) -### **Absolute tolerance** +### Absolute tolerance *The convergence threshold for transition equation residuals.* @@ -77,7 +77,7 @@ > - Can typically be less strict than Navier-Stokes tolerance > - May need to be relaxed for challenging transition cases -### **Relative tolerance** +### Relative tolerance *Relative residual reduction target for the transition equations per physical step.* @@ -88,7 +88,7 @@ >- For unsteady cases, typically set to 1e-2 >- Once residuals drop by prescribed order of magnitude (0.01 means 2 orders of magnitude), solver proceeds to next physical step -### **Trip regions** +### Trip regions *Box regions where transition is forced to occur.* @@ -99,7 +99,7 @@ > - Can be used to force transition at specific locations > - Multiple trip regions can be defined -### **Order of accuracy** +### Order of accuracy *Spatial discretization order for transition variables.* @@ -109,7 +109,7 @@ > - `1` is more robust; `2` is more accurate > - In most cases it should be kept at default value -### **Equation evaluation frequency** +### Equation evaluation frequency *Controls how often (in pseudo steps) transition equations are solved.* @@ -119,7 +119,7 @@ >- `1` provides the most robust convergence >- Higher values can reduce time cost but may slow down convergence -### **Max force jacobian update physical pseudo steps** +### Max force jacobian update physical pseudo steps *If the current physical step is lower than this value, jacobian matrix will be updated at every pseudo step.* @@ -128,7 +128,7 @@ > **Notes:** >- Useful for cases where more stability is needed at the beginning -### **Linear solver - max iterations*** +### Linear solver - max iterations* *Configures the maximum number of iterations solved at each pseudo-step for transition equations.* @@ -137,7 +137,7 @@ >**Note:** >- Increasing the parameter can improve robustness at added cost per pseudo-step -### **Update Jacobian frequency** +### Update Jacobian frequency *Controls how often the Jacobian matrix for the transition equations is updated.* @@ -148,7 +148,7 @@ > - For challenging cases with complex transition, set to `1` > - For well-behaved flows, 4 is typically sufficient -### **CFL multiplier** +### CFL multiplier *Scaling factor applied to the CFL number for transition equations.* @@ -159,7 +159,7 @@ > - Can often be higher than Navier-Stokes CFL for efficiency > - Reduce for stability in complex transition scenarios -### **Reconstruction gradient limiter** +### Reconstruction gradient limiter *Controls the aggressiveness of gradient limiting for transition variables.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md index 80a7cb0..c243c34 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/04.initial-condition.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -17,9 +17,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Type** +### Type *The method used to specify the initial condition.* @@ -31,7 +31,7 @@ >- Standard expressions are most common for new simulations >- Modified restart solutions allow patching specific regions of a restart solution -### **Rho** +### Rho *Mathematical expression defining the initial density field.* @@ -43,7 +43,7 @@ > - Can use spatial coordinates (x, y, z) and mathematical functions > - Fluid properties are taken from the operating condition -### **U** +### U *Mathematical expression defining the initial x-velocity field.* @@ -54,7 +54,7 @@ >- Relative to the grid coordinates, not necessarily the flow direction >- Commonly set to freestream values for external flows -### **V** +### V *Mathematical expression defining the initial y-velocity field.* @@ -65,7 +65,7 @@ >- Relative to the grid coordinates >- Can specify flow angularity or disturbances -### **W** +### W *Mathematical expression defining the initial z-velocity field.* @@ -76,7 +76,7 @@ >- Relative to the grid coordinates >- Can specify swirl or sideslip conditions -### **P** +### P *Mathematical expression defining the initial pressure field.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/05.stopping-criteria.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/05.stopping-criteria.md index 7d1b464..d0cfb2f 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/05.stopping-criteria.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/05.stopping-criteria.md @@ -6,7 +6,7 @@ --- -## **How Stopping Criteria Work** +## How Stopping Criteria Work When you configure one or more stopping criteria: @@ -24,7 +24,7 @@ When you configure one or more stopping criteria: --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -36,16 +36,16 @@ When you configure one or more stopping criteria: --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Name** +### Name *A descriptive identifier for this stopping criterion.* - **Default:** `"Criterion 1"`, `"Criterion 2"`, etc. (automatically assigned) - **Example:** `"Lift convergence"`, `"Drag tolerance"` -### **Output type** +### Output type *Specifies the category of output that contains the field to be monitored.* @@ -56,7 +56,7 @@ When you configure one or more stopping criteria: - `Surface Probe`: Monitor flow variables from surface probe outputs > **Note:** The chosen output type must be configured in the [Output section](../../../04.output/README.md) of your simulation setup before it can be used here. -### **Output field** +### Output field *The specific scalar field within the selected output to monitor for convergence. The available fields depend on the output type: Force outputs provide force and moment coefficients, Probe outputs provide flow variables at point locations, and Surface Probe outputs provide flow variables on surfaces.* @@ -65,7 +65,7 @@ When you configure one or more stopping criteria: > **Notes:** > - The selected field must be one of the `output_fields` defined in the selected output instance. -### **Tolerance** +### Tolerance *Convergence threshold for the monitored field. The stopping criterion is satisfied when the monitored field change becomes lower than this tolerance. If a **Tolerance window size** is specified, the criterion evaluates the variation of the monitored field within that window. If no tolerance window size is specified, the criterion directly compares the latest value with the tolerance. Note that this criterion must be satisfied along with solver tolerances (Navier-Stokes, turbulence, and transition model residuals) for the simulation to stop.* @@ -74,7 +74,7 @@ When you configure one or more stopping criteria: > **Notes:** > - This value is non-dimensional if the monitored field is a string-defined default field (e.g., `'CL'`, `'CD'`, `'Cp'`). -### **Tolerance window size** +### Tolerance window size *The number of data points from the monitor output used to check whether the variation of the monitored field within this window is below the tolerance. For steady simulations, this refers to the number of iterations. For unsteady simulations, this refers to the number of time steps. If not set, the criterion will directly compare the latest value with the tolerance.* @@ -105,7 +105,7 @@ When you configure one or more stopping criteria: --- -## **Related** +## Related - [Probe Outputs](../../../04.output/02.outputs-list/07.probe-outputs.md) - Setting up probe outputs - [Surface Probe Outputs](../../../04.output/02.outputs-list/09.surface-probe-outputs.md) - Setting up surface probe outputs diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/README.md b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/README.md index 9b198a6..e43c173 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/README.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/01.fluid/README.md @@ -4,7 +4,7 @@ > **Note:** The Fluid model itself does not contain fluid parameters such as density and temperature. These properties are instead specified in the **[Operating Condition](../../../01.flow-conditions/README.md)** section of your simulation setup. This separation allows the same Fluid model configuration to be used with different conditions. -## **Major Components** +## Major Components The Fluid model consists of five primary components, each documented in detail in its own section: @@ -18,7 +18,7 @@ The Fluid model consists of five primary components, each documented in detail i 5. [**Stopping Criteria**](./05.stopping-criteria.md): Allows automatic termination of the simulation when monitored output fields (forces, probe values, or surface probe data) reach specified tolerance thresholds, providing efficient convergence control. -## **Configuration Example** +## Configuration Example Below is a representative example of a Fluid model configuration (shown for reference purposes): @@ -52,7 +52,7 @@ Fluid: Tolerance window size: 100 ``` -## **Common Applications** +## Common Applications The Fluid model is used in virtually all Flow360 simulations, including: @@ -62,7 +62,7 @@ The Fluid model is used in virtually all Flow360 simulations, including: - Propulsion systems (propellers, rotors, jets) - Heat transfer applications (when coupled with thermal models) -## **Best Practices** +## Best Practices - Match the solver settings to your specific application requirements and flow regime - For most aerospace applications, the Spalart-Allmaras turbulence model provides a good balance of accuracy and efficiency diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/01.heat-equation-solver.md b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/01.heat-equation-solver.md index f7ae4e8..ee16c71 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/01.heat-equation-solver.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/01.heat-equation-solver.md @@ -1,10 +1,10 @@ -# **Heat equation solver** +# Heat equation solver *The Heat equation solver is used for configuring the numerical solver settings for conjugate heat transfer simulations. It controls how the heat equation is solved within solid regions.* --- -## **Available Options** +## Available Options | *Option* | *Description*| |------------|----------------| @@ -16,9 +16,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Absolute tolerance** +### Absolute tolerance *Absolute residual tolerance that determines the convergence of the heat equation in conjugate heat transfer.* @@ -26,7 +26,7 @@ - **Example:** `1e-10` >**Note:** This value should be the same or higher than the absolute tolerance for the linear solver by a small margin. -### **Relative tolerance** +### Relative tolerance *Absolute residual tolerance that determines the convergence of the heat equation in conjugate heat transfer.* @@ -34,7 +34,7 @@ - **Example:** `1e-3` > **Note:** If the value drops by that factor, the solver proceeds to the next step. -### **Order of accuracy** +### Order of accuracy *Order of accuracy in space for the heat equation solver.* @@ -42,7 +42,7 @@ - **Example:** `2` > **Note:** This value is fixed at 2 and cannot be changed. -### **Equation evaluation frequency** +### Equation evaluation frequency *Frequency at which to solve the heat equation in conjugate heat transfer simulations.* @@ -50,7 +50,7 @@ - **Example:** `2` > **Note:** Lower values mean more frequent updates but higher computational cost. -### **Linear solver** +### Linear solver *Configuration for the linear solver used to solve the heat equation.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/02.material.md b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/02.material.md index d12ac46..c877496 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/02.material.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/02.material.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |------------------------|----------------------------------------------------| @@ -14,16 +14,16 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Thermal conductivity** +### Thermal conductivity *Thermal conductivity of the material, which determines how efficiently heat is conducted through the solid.* - **Required** - **Example:** `235 kg·m/(K·s³)` -### **Density** +### Density *The mass per unit volume of the material.* @@ -31,7 +31,7 @@ - **Example:** `2710 kg/m³` > **Note:** Optional. If not specified, some calculations may not be available. -### **Specific heat capacity** +### Specific heat capacity *The amount of heat required to raise the temperature of a unit mass of the material by one degree.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/03.initial-condition.md b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/03.initial-condition.md index 0eff162..1e570a7 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/03.initial-condition.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/03.initial-condition.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |---------------|-----------------------------------------------------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Constants** +### Constants *Optional dictionary of key-value pairs to define constants or reusable expressions for the initial condition.* @@ -25,7 +25,7 @@ > - Values are string expressions or numbers. > - Useful for parameterizing initial conditions. -### **Temperature** +### Temperature *Specifies the initial temperature throughout the solid domain. Can be a constant or an expression.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/README.md b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/README.md index f9ff628..1f1ddc6 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/README.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/02.solid/README.md @@ -6,7 +6,7 @@ The Solid model is only available in the volume mesh workflow. It cannot be used *The Solid model is used for setting up conjugate heat transfer volume models that contain all the common fields every heat transfer zone should have. This model is essential for simulating heat transfer in solid materials within the Flow360 simulation environment.* -## **Major Components** +## Major Components 1. **[Heat equation solver](./01.heat-equation-solver.md)**: Controls settings for the heat equation solver, including tolerances and iteration limits. 2. **[Material](./02.material.md)**: Defines material properties of the solid, such as thermal conductivity, density, and specific heat capacity. @@ -14,7 +14,7 @@ The Solid model is only available in the volume mesh workflow. It cannot be used 4. **[Initial condition](./03.initial-condition.md)**: Sets initial temperature field for the heat equation. 5. **Assigned zones**: A list of volume zones where the heat transfer equations will be solved. -## **Configuration Example** +## Configuration Example Below is a representative example of a Solid model configuration (shown for reference purposes): @@ -38,7 +38,7 @@ Solid: Assigned zones: ["solid-*"] ``` -## **Common Applications** +## Common Applications The Solid model is used in conjugate heat transfer simulations, including: @@ -48,7 +48,7 @@ The Solid model is used in conjugate heat transfer simulations, including: - Building insulation and thermal management - Aerospace applications (re-entry vehicle heat shields, turbine blade cooling) -## **Best Practices** +## Best Practices - Ensure all material properties are specified in consistent units. - When using patterns in entities, verify all matched volumes are intended for heat transfer simulation. diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/03.rotation.md b/docs/02.simulation-setup/03.flow-solver/03.physics/03.rotation.md index 77c1316..07d2659 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/03.rotation.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/03.rotation.md @@ -13,7 +13,7 @@ The Rotation model provides different approaches to simulate rotating components >**Important:** Physical mesh rotation is the default approach for unsteady cases, while MRF is the default for steady ones. --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | *Applicable* | |-------------|---------------|--------------| @@ -27,9 +27,9 @@ The Rotation model provides different approaches to simulate rotating components --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Rotation** +### Rotation *The angular velocity or rotation angle as a function of time.* @@ -40,7 +40,7 @@ The Rotation model provides different approaches to simulate rotating components - `From user defined dynamics`: Rotation controlled by user dynamics >**Note:** The appropriate option depends on both your simulation type (steady or unsteady) and your modeling requirements. -### **Angular velocity** +### Angular velocity *Defines a constant angular velocity for the rotating domain.* @@ -50,7 +50,7 @@ The Rotation model provides different approaches to simulate rotating components >- Used in steady simulations with MRF to specify the rotational speed of the reference frame. >- Used in unsteady simulations to specify a constant physical rotation rate. -### **Angle expression** +### Angle expression *Defines the rotation angle as a function of time.* @@ -62,7 +62,7 @@ The Rotation model provides different approaches to simulate rotating components >- Can only be used in unsteady/time-accurate simulations with physical mesh rotation. >- Incompatible with steady-state MRF/SRF approaches. -### **From user defined dynamics** +### From user defined dynamics *Sets the rotation to be controlled by user defined dynamics.* @@ -72,7 +72,7 @@ The Rotation model provides different approaches to simulate rotating components > - Can only be used in unsteady/time-accurate simulations with physical mesh rotation. > - Incompatible with steady-state MRF/SRF approaches. -### **Transient MRF** +### Transient MRF *Flag to specify whether the non-inertial reference frame model is to be used for the rotation model.* @@ -80,7 +80,7 @@ The Rotation model provides different approaches to simulate rotating components - **Example:** Selected >**Note:** Controls whether rotation is handled via reference frame transformation (MRF) or physical mesh rotation during unsteady simulations. -### **Parent Volume** +### Parent Volume *The parent rotating entity in a nested rotation case.* @@ -91,7 +91,7 @@ The Rotation model provides different approaches to simulate rotating components >- Child rotation is relative to the parent rotation. >- Works in both steady MRF/SRF and unsteady approaches. -### **Assigned zones** +### Assigned zones *The entity list for the Rotation model. The entity should be Cylinder or GenericVolume type.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/04.bet-disk.md b/docs/02.simulation-setup/03.flow-solver/03.physics/04.bet-disk.md index b938569..e45b72d 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/04.bet-disk.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/04.bet-disk.md @@ -5,7 +5,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | *Applicable* | |-------------|---------------|--------------| @@ -25,9 +25,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **BET data source** +### BET data source *A method of defining the BET disk using different data formats.* @@ -43,14 +43,14 @@ - The duct part of the DFDC input file is NOT used - To simulate a ducted fan, mesh the duct geometry separately and position the BET disk correctly -### **Assigned volumes** +### Assigned volumes *The cylinder entity that defines the location and dimensions of the disk. The cylinder's center, axis, outer radius, and height are taken as the rotation center, rotation axis, radius, and thickness of the BET Disk, respectively.* - **Required** >**Note:** The cylinder entity must be properly sized and positioned to represent the rotor disk. -### **Rotation direction rule** +### Rotation direction rule *The rule for relating rotation direction and thrust direction.* @@ -58,7 +58,7 @@ - **Options:** `Right hand` or `Left hand` >**Note:** Determines whether the rotor follows the right-hand or left-hand rule for rotation relative to the thrust axis. -### **Omega** +### Omega *The rotational speed of the propeller or rotor.* @@ -66,7 +66,7 @@ - **Example:** `812.31 RPM` >**Note:** Can be specified in various angular velocity units such as rad/s or rpm. -### **Number of blades** +### Number of blades *The number of blades to model in the BET simulation.* @@ -74,7 +74,7 @@ - **Range:** `1`-`10` >**Note:** Must be a positive integer, representing the physical blade count of the propeller or rotor. -### **Chord ref** +### Chord ref *Dimensional reference chord used to compute sectional blade loadings.* @@ -82,7 +82,7 @@ - **Example:** `0.1 m` >**Note:** This value is used in the calculation of sectional thrust and torque coefficients. -### **N loading nodes** +### N loading nodes *Number of nodes used to compute the sectional thrust and torque coefficients.* @@ -91,7 +91,7 @@ - **Example:** `20` >**Note:** Recommended value is 20. More nodes provide more detailed radial loading distribution at the cost of computation time. -### **Tip gap** +### Tip gap *Dimensional distance between blade tip and solid bodies to define a tip loss factor.* @@ -102,7 +102,7 @@ >- A finite value represents the gap between blade tips and structures like ducts -### **Blade line chord** +### Blade line chord *Dimensional chord to use if performing an unsteady BET Line simulation.* @@ -110,7 +110,7 @@ - **Example:** `0.1 * u.m` >**Note:** Default of 0.0 indicates a steady BET Disk simulation. Set to a positive value for unsteady BET Line simulation. -### **Initial blade direction** +### Initial blade direction *Orientation of the first blade in the BET model.* @@ -121,7 +121,7 @@ --- -### **File Input Options** +### File Input Options Flow360 provides multiple ways to set up BET Disk models through file imports: diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/05.actuator-disk.md b/docs/02.simulation-setup/03.flow-solver/03.physics/05.actuator-disk.md index d8ca0b5..9feac64 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/05.actuator-disk.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/05.actuator-disk.md @@ -5,7 +5,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -15,9 +15,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Assigned volumes** +### Assigned volumes *The cylinder entities that define the location and dimensions of the disk. The cylinder's center, axis, height, and outer radius are used as the actuator disk's center, thrust axis, thickness, and radius respectively.* @@ -26,7 +26,7 @@ >- The cylinder axis defines the direction of the thrust >- Ensure the cylinder is sized appropriately for your application -### **Unit** +### Unit *Specifies units of the values specified in the uploaded file.* @@ -37,7 +37,7 @@ >- Positive circumferential force follows the same direction as the thrust axis with the right hand rule >- In the GUI, you can either input values directly or upload JSON/CSV files with the distribution data -### **File upload** +### File upload *A window for uploading a file defining the behaviour of the actuator disk.* diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/06.porous-medium.md b/docs/02.simulation-setup/03.flow-solver/03.physics/06.porous-medium.md index d0fde97..b13cb66 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/06.porous-medium.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/06.porous-medium.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -15,16 +15,16 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Assigned zones** +### Assigned zones *Zones assigned to the Porous Medium model. The entity should be defined by Box or zones from the geometry/volume mesh. The axes of entity must be specified to serve as the principle axes of the porous medium material model.* - **Required** >**Note:** Each entity must have axes defined that determine the principal directions for the resistance coefficients. -### **Darcy coefficients** +### Darcy coefficients *Darcy coefficient of the porous media model which determines the scaling of the viscous loss term. The 3 values define the coefficient for each of the 3 axes defined by the reference frame of the volume zone.* @@ -36,7 +36,7 @@ >- When using `Box.from_principal_axes()`, the first two directions are those you provide in the `axes` parameter, and the third is the cross product of these two. >- When using `Box.from_axis_and_angle()`, visualize the 3D graphics to identify the directions correctly. -### **Forchheimer coefficient** +### Forchheimer coefficient *Forchheimer coefficient of the porous media model which determines the scaling of the inertial loss term.* @@ -48,7 +48,7 @@ >- These coefficients affect the quadratic (velocity-squared) pressure drop term. >- Typically dominant at higher flow rates. -### **Volumetric heat source** +### Volumetric heat source *The volumetric heat source within the porous region.* @@ -70,7 +70,7 @@ - Consider conducting sensitivity studies if experimental data for coefficients is limited. - When constructing boxes for porous media, carefully define axes to match your physical system's principal directions. -### **Best Practices** +### Best Practices - Base resistance coefficients on experimental data when possible - For anisotropic media, define directional resistances appropriately @@ -80,7 +80,7 @@ - Verify pressure drop predictions against known values for similar devices - Consider the impact of porosity on flow volume and domain sizing -### **Common Use Cases** +### Common Use Cases - Heat Exchangers and Radiators - Automotive cooling systems - HVAC equipment @@ -98,7 +98,7 @@ - Vegetation modeling - Urban air flow through building arrays -### **Determining Resistance Coefficients** +### Determining Resistance Coefficients - From Experimental Data 1. Measure pressure drop vs flow rate diff --git a/docs/02.simulation-setup/03.flow-solver/03.physics/README.md b/docs/02.simulation-setup/03.flow-solver/03.physics/README.md index 0d911bb..aa03ba6 100644 --- a/docs/02.simulation-setup/03.flow-solver/03.physics/README.md +++ b/docs/02.simulation-setup/03.flow-solver/03.physics/README.md @@ -2,7 +2,7 @@ *This section covers the physical models that simulate the 3D flow behavior in Flow360.* -## **Available Models** +## Available Models | *Model* | *Description* | *Key Parameters* | |------------|----------------------------------|----------| @@ -17,9 +17,9 @@ Click on each model to see detailed documentation including available parameters --- -## **Detailed Descriptions** +## Detailed Descriptions -### **[Fluid](./01.fluid/README.md)** +### [Fluid](./01.fluid/README.md) *Modelling of the fluid behaviour in the domain.* @@ -29,7 +29,7 @@ Click on each model to see detailed documentation including available parameters - **[Transition model](./01.fluid/03.transition-model.md)** - Laminar-to-turbulent transition prediction for improved accuracy - **[Initial condition](./01.fluid/04.initial-condition.md)** - Flow field initialization strategies and convergence acceleration -### **[Solid](./02.solid/README.md)** +### [Solid](./02.solid/README.md) *Conjugate heat transfer modeling for solid materials enabling accurate thermal analysis of components in contact with fluid flow. Provides material property specification, heat equation solver configuration, and thermal boundary condition management for multi-physics simulations.* @@ -38,7 +38,7 @@ Click on each model to see detailed documentation including available parameters - **[Material](02.solid/02.material.md)** - Material properties specification - **[Initial condition](02.solid/03.initial-condition.md)** - The initial state of solid bodies -### **[Rotation](./03.rotation.md)** +### [Rotation](./03.rotation.md) *Advanced rotating component handling with multiple approaches for modeling rotating machinery, propellers, and turbines. Supports Moving Reference Frame (MRF), Sliding Reference Frame (SRF), and physical rotation methods with comprehensive angular velocity specification and interface treatment.* @@ -48,7 +48,7 @@ Click on each model to see detailed documentation including available parameters - Interface treatment between rotating and stationary regions - Support for complex multi-rotor configurations -### **[BET disk](./04.bet-disk.md)** +### [BET disk](./04.bet-disk.md) *Blade Element Theory implementation for high-fidelity propeller and rotor modeling. Enables detailed aerodynamic analysis of rotating blades through sectional force calculations, polar data integration, and performance prediction for aerospace and marine applications.* @@ -58,7 +58,7 @@ Click on each model to see detailed documentation including available parameters - Performance prediction including thrust and power - Support for complex blade geometries and operating conditions -### **[Actuator disk](./05.actuator-disk.md)** +### [Actuator disk](./05.actuator-disk.md) *Simplified propeller and rotor modeling approach using momentum theory. Provides efficient representation of rotating components through thrust coefficient specification and swirl distribution modeling, ideal for preliminary design and optimization studies.* @@ -68,7 +68,7 @@ Click on each model to see detailed documentation including available parameters - Efficient computation for design optimization - Support for multiple actuator disk configurations -### **[Porous medium](./06.porous-medium.md)** +### [Porous medium](./06.porous-medium.md) *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.* diff --git a/docs/02.simulation-setup/03.flow-solver/04.user-defined-dynamics.md b/docs/02.simulation-setup/03.flow-solver/04.user-defined-dynamics.md index 19f6660..6711b54 100644 --- a/docs/02.simulation-setup/03.flow-solver/04.user-defined-dynamics.md +++ b/docs/02.simulation-setup/03.flow-solver/04.user-defined-dynamics.md @@ -2,7 +2,7 @@ *User-defined dynamics (UDD) is a powerful feature in Flow360 that allows you to implement custom control laws and coupled physics within your simulations. You define state variables that evolve according to mathematical expressions you specify, creating feedback loops where flow solution quantities influence the simulation in real-time.* -## **Overview** +## Overview User Defined Dynamics enables you to: @@ -12,13 +12,13 @@ User Defined Dynamics enables you to: This creates a feedback loop where the flow solution affects the dynamics, and the dynamics affect the flow solution, enabling simulations of complex coupled phenomena. -## **Web UI Implementation** +## Web UI Implementation > **Important**: Currently, User Defined Dynamics must be configured using JSON files in the Web UI. The Web UI does not yet provide a graphical interface for setting up UDD parameters. You will need to manually edit the case JSON file to add the User Defined Dynamics configuration. > **Recommendation**: We recommend using the Python API for implementing User Defined Dynamics, as it provides more flexibility, better debugging capabilities, and a more intuitive interface for complex dynamic scenarios. -## **Basic Structure** +## Basic Structure A User Defined Dynamics system consists of the following components: @@ -58,7 +58,7 @@ A User Defined Dynamics system consists of the following components: > **Note**: All expressions and variables entered in User Defined Dynamics must be C-syntax compatible. For details on the syntax requirements and supported operations, see the Flow360 Python API documentation. -## **Creating a JSON Configuration** +## Creating a JSON Configuration The JSON structure mirrors the Python API, with the following key fields: @@ -70,7 +70,7 @@ The JSON structure mirrors the Python API, with the following key fields: - ``input_boundary_patches``: (Optional) Object containing entity references - ``output_target``: (Optional) Object containing entity reference -### **Example JSON Configuration** +### Example JSON Configuration The following example shows a complete JSON configuration for a spring-mass-damper system controlling rotation: @@ -114,7 +114,7 @@ The following example shows a complete JSON configuration for a spring-mass-damp } ``` -### **Corresponding Python Code** +### Corresponding Python Code The JSON configuration above corresponds to the following Python API code: @@ -147,7 +147,7 @@ dynamic = fl.UserDefinedDynamic( **Note**: In the JSON version, the conditional expressions in ``update_law`` use ternary operator syntax ``(condition) ? (true_value) : (false_value)`` instead of the ``if-else`` statements shown in the Python code. -## **Best Practices** +## Best Practices 1. Start with simple motions and gradually add complexity 2. Test your UDD implementation with coarse meshes before running full simulations @@ -155,6 +155,6 @@ dynamic = fl.UserDefinedDynamic( 4. Monitor forces and moments during motion to ensure physical behavior 5. Use the Python API when possible for easier debugging and more intuitive configuration -## **Related Documentation** +## Related Documentation For detailed implementation examples, please refer to the Flow360 Python API documentation. \ No newline at end of file diff --git a/docs/02.simulation-setup/03.flow-solver/README.md b/docs/02.simulation-setup/03.flow-solver/README.md index 0ed8b86..6d9914e 100644 --- a/docs/02.simulation-setup/03.flow-solver/README.md +++ b/docs/02.simulation-setup/03.flow-solver/README.md @@ -1,7 +1,7 @@ # Flow solver A section for setting the solver numerics and domain boundary conditions. -## **Contents** +## Contents | *Option* | *Description* | |------------|----------------------------------| @@ -12,9 +12,9 @@ A section for setting the solver numerics and domain boundary conditions. --- -## **Detailed Descriptions** +## Detailed Descriptions -### **[Boundary conditions](./01.boundary-conditions/README.md)** +### [Boundary conditions](./01.boundary-conditions/README.md) *Comprehensive set of boundary conditions including walls, freestream, inflow/outflow, periodic, symmetry, and slip wall conditions. Defines how fluid behaves at domain boundaries with support for wall motion, thermal conditions, turbulence quantities, and various flow specifications.* @@ -28,11 +28,11 @@ A section for setting the solver numerics and domain boundary conditions. - **[Slip Wall](./01.boundary-conditions/07.slip-wall.md)** - Zero normal velocity walls allowing tangential flow - **[Turbulence Quantities](./01.boundary-conditions/08.turbulence-quantities.md)** - Turbulence parameter specifications for all boundary types -### **[Time](./02.time.md)** +### [Time](./02.time.md) *Advanced time stepping configuration for both steady and unsteady simulations. Controls simulation type (steady/unsteady), CFL management (Adaptive/Ramp), convergence parameters, physical time steps, pseudo-steps, and temporal accuracy. Includes detailed guidelines for time step selection based on vortex shedding frequencies and rotational motion.* -### **[Physics](./03.physics/README.md)** +### [Physics](./03.physics/README.md) *Complete physical modeling framework encompassing fluid dynamics (Navier-Stokes solver, turbulence models, transition models, initial conditions), heat transfer (conjugate heat transfer in solids), and special models (rotation, BET disk, actuator disk, porous media). Provides comprehensive parameter control for accurate 3D flow simulation.* @@ -44,7 +44,7 @@ A section for setting the solver numerics and domain boundary conditions. - **[Actuator disk](./03.physics/05.actuator-disk.md)** - Simplified propeller and rotor modeling - **[Porous medium](./03.physics/06.porous-medium.md)** - Flow through porous regions modeling -### **[User-defined dynamics](./04.user-defined-dynamics.md)** +### [User-defined dynamics](./04.user-defined-dynamics.md) *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.* diff --git a/docs/02.simulation-setup/04.output/01.reference-dimensions.md b/docs/02.simulation-setup/04.output/01.reference-dimensions.md index 285dc77..df2b964 100644 --- a/docs/02.simulation-setup/04.output/01.reference-dimensions.md +++ b/docs/02.simulation-setup/04.output/01.reference-dimensions.md @@ -4,7 +4,7 @@ --- -## **Available Parameters** +## Available Parameters | *Parameter* | *Description* | |-------------|---------------| @@ -14,9 +14,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Moment reference center** +### Moment reference center *The moment reference center specifies the point about which aerodynamic moments are computed. This point is typically located at a significant position on the aircraft, such as the center of gravity or a specific percentage of the mean aerodynamic chord.* @@ -24,7 +24,7 @@ - **Example:** `(0.25, 0.0, 0.0) m` >**Note:** The coordinate system follows the right-hand rule convention. -### **Moment length** +### Moment length *Reference lengths used in the calculation of non-dimensional moment coefficients. These values are typically related to the characteristic dimensions of the geometry.* @@ -32,7 +32,7 @@ - **Example:** `(1.0, 5.0, 1.0) m` >**Note:** Each component corresponds to the respective axis of rotation. -### **Area** +### Area *The reference area is used to non-dimensionalize force and moment coefficients. For aircraft applications, this is typically the wing planform area, whereas for automotive cases it would be the frontal area of the car.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md b/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md index c64fe62..9151c73 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/00.output-fields.md @@ -6,7 +6,7 @@ --- -## **Universal Fields** +## Universal Fields *These fields are available for all output types.* @@ -43,7 +43,7 @@ --- -## **Volume and Slice Specific Fields** +## Volume and Slice Specific Fields *These fields are available only for Volume Output and Slice Output types.* @@ -58,11 +58,11 @@ | `kOmegaSST_hybridModel` | Hybrid RANS-LES output for kOmegaSST solver (supports both DDES and ZDES) | Non-dimensional | | `localCFL` | Local CFL number | Non-dimensional | -### **Hybrid RANS-LES Output Variables** +### Hybrid RANS-LES Output Variables The `SpalartAllmaras_hybridModel` and `kOmegaSST_hybridModel` output fields provide diagnostic variables for hybrid RANS-LES simulations. The specific variables included depend on whether you're using **DDES** (Delayed Detached Eddy Simulation) or **ZDES** (Zonal Detached Eddy Simulation) as the shielding function. -#### **DDES Variables** (when `shielding_function="DDES"`) +#### DDES Variables (when `shielding_function="DDES"`) When using DDES, the hybrid model output includes five key variables: @@ -78,7 +78,7 @@ When using DDES, the hybrid model output includes five key variables: Among these variables, `f_d` is the most significant, as it enables users to identify and visualize the regions dominated by RANS and DES behavior within the computational domain. -#### **ZDES Variables** (when `shielding_function="ZDES"`) +#### ZDES Variables (when `shielding_function="ZDES"`) When using ZDES, the hybrid model output includes four key variables: @@ -92,7 +92,7 @@ When using ZDES, the hybrid model output includes four key variables: --- -## **Surface Specific Fields** +## Surface Specific Fields *These fields are available only for Surface Output and Surface Probe Output types.* @@ -112,7 +112,7 @@ When using ZDES, the hybrid model output includes four key variables: --- -## **Isosurface Specific Fields** +## Isosurface Specific Fields *These fields are available only for Isosurface Output types.* @@ -125,7 +125,7 @@ Isosurface outputs support all universal fields listed above. The most commonly --- -## **Custom Variables** +## Custom Variables *User-defined expressions with dimensions. These can be created using the Variable Settings tool or Python API.* @@ -142,7 +142,7 @@ By default, the following expressions are available: --- -## **Related Documentation** +## Related Documentation - [Scaling Values and Nondimensionalization](./00.scaling-values.md) - Learn how to convert non-dimensional values to physical units - [Variable Settings](../../05.tools/02.variable-settings.md) - Create custom output variables diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md index 1666430..5030030 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/01.volume-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -16,7 +16,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 `Frequency` and `Frequency offset` parameters refer to the **global** time step, which is transferred from the parent case. @@ -24,9 +24,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *Select the flow variables to include in the volume output.* @@ -34,7 +34,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Mach, pressure, qcriterion` >**Notes:** volume outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Volume and Slice Specific Fields](./00.output-fields.md#volume-and-slice-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference, including details on hybrid RANS-LES output variables. -### **Output format** +### Output format *The file format used to save the volume output data.* @@ -47,7 +47,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -59,7 +59,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, in number of physical time steps.* @@ -72,7 +72,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md index ed2707d..8173204 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/02.time-averaging-volume-output.md @@ -2,7 +2,7 @@ *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.* -## **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 `Frequency`, `Frequency offset`, and `Start step` parameters refer 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 -### **Output fields** +### Output fields *Select the flow variables to include in the volume output.* @@ -33,7 +33,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Mach, pressure, velocity` >**Notes:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for volume outputs. -### **Output format** +### Output format *The file format used to save the volume output data.* @@ -46,7 +46,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Start step** +### Start step *Specifies the physical time step to start calculating time averaging.* @@ -56,7 +56,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Set this to begin averaging after initial transients have died out. When set to `-1`, the solver will automatically determine when to start averaging based on flow convergence. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Save interval** +### Save interval *Choose the points in the simulaton where the results are saved.* @@ -68,7 +68,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, in number of physical time steps.* @@ -81,7 +81,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Higher frequencies provide better temporal resolution but increase storage requirements. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md index 661d568..99d45f6 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/03.surface-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -18,7 +18,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 `Frequency` and `Frequency offset` parameters refer to the **global** time step, which is transferred from the parent case. @@ -26,16 +26,16 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be included in the surface output files.* - **Default:** None (user must select at least one field) - **Example:** `Cp`, `Cf`, `Mach` >**Notes:** surface outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. -### **Output format** +### Output format *The file format in which surface data will be saved.* @@ -48,7 +48,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.szplt` format, or `both` to save in both formats. -### **Write single file** +### Write single file *When enabled, all surface outputs are written to a single file instead of separate files for each surface.* @@ -58,7 +58,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - `false` >**Note:** Currently only supported for Tecplot format. -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -70,7 +70,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *Controls how often surface output files are saved during the simulation.* @@ -83,7 +83,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Frequency offset** +### Frequency offset *Specifies the time step at which to begin recording surface outputs.* @@ -96,7 +96,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Assigned boundaries** +### Assigned boundaries *The boundary surfaces from your mesh that will be included in this output.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md index be0aaf4..860102b 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/04.time-averaging-surface-output.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -21,7 +21,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 `Frequency`, `Frequency offset`, and `Start step` parameters refer to the **global** time step, which is transferred from the parent case. @@ -29,16 +29,16 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be time-averaged in the output files.* - **Example:** `Cp`, `velocity`, `pressure` >**Note:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for surface outputs. -### **Output format** +### Output format *Specifies the file format for the output files.* @@ -51,7 +51,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Start step** +### Start step *Specifies the time step at which to begin the time-averaging process.* @@ -61,7 +61,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Set this to a time step after initial transients have settled for more meaningful statistics. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Write single file** +### Write single file *Controls whether all surface outputs are written to a single file instead of one file per surface.* @@ -71,7 +71,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - `false` >**Note:** This option currently only supports Tecplot output format. -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -83,7 +83,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *Controls how often the time-averaged output files are generated.* @@ -95,7 +95,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Setting to `-1` will only produce output at the end of the simulation. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *Specifies the time step at which to begin saving the time-averaged output.* @@ -107,7 +107,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - This setting works in conjunction with `Frequency` to control the time steps at which output is produced. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Assigned boundaries** +### Assigned boundaries *The geometry surfaces where time-averaging will be applied.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md index bacbfa7..cad10f7 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/05.slice-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -17,7 +17,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 `Frequency` and `Frequency offset` parameters refer to the **global** time step, which is transferred from the parent case. @@ -25,9 +25,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *Select the flow variables to include in the output files.* @@ -35,7 +35,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Cp, Mach, velocity` >**Notes:** slice outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Volume and Slice Specific Fields](./00.output-fields.md#volume-and-slice-specific-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. -### **Output format** +### Output format *The file format for saving the slice data.* @@ -48,7 +48,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -60,7 +60,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, measured in number of physical time steps.* @@ -73,7 +73,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* @@ -86,7 +86,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Assigned slices** +### Assigned slices *Define one or more slice planes through the computational domain.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md index d22e79f..b1e49e8 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/06.time-averaging-slice-output.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -20,7 +20,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 `Frequency`, `Frequency offset`, and `Start step` parameters refer to the **global** time step, which is transferred from the parent case. @@ -28,9 +28,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *Select the flow variables to include in the slice output.* @@ -38,7 +38,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Mach, pressure, velocity` >**Notes:** see [Available Output Fields](./00.output-fields.md) for a complete list of fields available for slice outputs. -### **Output format** +### Output format *The file format used to save the slice output data.* @@ -51,7 +51,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Start step** +### Start step *Specifies the physical time step to start calculating time averaging.* @@ -61,7 +61,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Set this to begin averaging after initial transients have died out. When set to `-1`, the solver will automatically determine when to start averaging based on flow convergence. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -73,7 +73,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, in number of physical time steps.* @@ -85,7 +85,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Higher frequencies provide better temporal resolution but increase storage requirements. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* @@ -97,7 +97,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Useful when you want to skip initial transient flow development. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Assigned slices** +### Assigned slices *Defines the 2D cutting planes through the computational domain.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md index 70eac04..f995f87 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/07.probe-outputs.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -13,10 +13,10 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be monitored at the specified probe locations.* @@ -24,7 +24,7 @@ - **Example:** `primitiveVars`, `Cp`, `Mach` >**Notes:** probe outputs support all [Universal Fields](./00.output-fields.md#universal-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference. -### **Probes** +### Probes *The specific points or arrays of points where flow variables will be monitored. Regardless of the motion of the mesh, the points retain their positions in the global reference frame during the simulation.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md index 47aa91d..a1bb302 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/08.time-averaging-probe-outputs.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -19,7 +19,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 `Frequency`, `Frequency offset`, and `Start step` parameters refer to the **global** time step, which is transferred from the parent case. @@ -27,10 +27,10 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be time-averaged at the specified probe locations.* @@ -38,7 +38,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `primitiveVars`, `Cp`, `Mach` >**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./00.output-fields.md#universal-fields) for a complete list of supported variables. -### **Start step** +### Start step *The physical time step at which time-averaging begins.* @@ -48,7 +48,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Use positive integers to start averaging from a specific time step. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -60,7 +60,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often (in physical time steps) the time-averaged data is saved.* @@ -72,7 +72,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Set to a positive integer to save at that interval, or `-1` to save only at the end. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *Defines when the first time-averaged output occurs.* @@ -83,7 +83,7 @@ When working with **child cases** (cases forked from a parent simulation), it's >**Notes:** > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Probes** +### Probes *The specific points or arrays of points where time-averaged flow variables will be monitored. Regardless of the motion of the mesh, the points retain their positions in the global reference frame during the simulation.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md b/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md index 368b4cb..dd4fd97 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/09.surface-probe-outputs.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -14,9 +14,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be monitored at the specified probe locations projected onto surfaces.* @@ -24,7 +24,7 @@ - **Example:** `Cp`, `Cf`, `yPlus` >**Notes:** surface probe outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields), the same as Surface Outputs. See the [Available Output Fields](./00.output-fields.md) page for a complete reference. -### **Assigned probes** +### Assigned probes *The specific points or arrays of points that will be projected onto surfaces for monitoring. The projection is executed at the start of the simulation. If the surface that the point was projected to is moving (mesh motion), the point moves with it (it remains stationary in the reference frame of the target surface).* @@ -39,7 +39,7 @@ - **Point Definition:** The creation of points is described in detail [here](../../../04.entities-browser/05.points.md) -### **Assigned target boundaries** +### Assigned target boundaries *The surfaces onto which the probe points will be projected for monitoring.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md index 5c76606..6e27f3c 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/10.surface-slice-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -17,7 +17,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 `Frequency` and `Frequency offset` parameters refer to the **global** time step, which is transferred from the parent case. @@ -25,9 +25,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Slices** +### Slices *A list of slice definitions, each containing name, origin, and normal.* @@ -45,7 +45,7 @@ When working with **child cases** (cases forked from a parent simulation), it's ``` > **Note:** Each slice requires a name, origin point (3D coordinates), and normal vector (does not need to be normalized). -### **Target surfaces** +### Target surfaces *The surfaces that the slices will intersect with.* @@ -53,7 +53,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `volume_mesh["wing"]` >**Note:** Must reference boundary names from your mesh. -### **Output fields** +### Output fields *The flow variables to include in the output.* @@ -61,14 +61,14 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `["Cp", "velocity_m_per_s", "pressure_pa"]` >**Notes:** surface slice outputs support all [Universal Fields](./00.output-fields.md#universal-fields) and all [Surface Specific Fields](./00.output-fields.md#surface-specific-fields), the same as Surface Outputs. See the [Available Output Fields](./00.output-fields.md) page for a complete reference. -### **Output format** +### Output format *The format used for the output files.* - **Default:** `"paraview"` >**Note:** Currently only "paraview" format is supported. -### **Frequency** +### Frequency *How often to save outputs during an unsteady simulation.* @@ -80,7 +80,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Only applicable for unsteady simulations. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md index 2cb7f8e..1fa7c9e 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/11.isosurface-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -17,7 +17,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 `Frequency` and `Frequency offset` parameters refer to the **global** time step, which is transferred from the parent case. @@ -25,9 +25,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *Select the flow variables to include in the isosurface output.* @@ -35,7 +35,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Mach, pressure, velocity` >**Notes:** isosurface outputs support all [Universal Fields](./00.output-fields.md#universal-fields). See the [Available Output Fields](./00.output-fields.md) page for a complete reference, including commonly used fields for isosurface visualization. -### **Output format** +### Output format *The file format used to save the isosurface output data.* @@ -49,7 +49,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -61,7 +61,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, in number of physical time steps.* @@ -74,7 +74,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* @@ -87,7 +87,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). > - This setting is only applicable for unsteady cases. -### **Assigned isosurfaces** +### Assigned isosurfaces *Define one or more isosurfaces by specifying a field variable and iso-value.* @@ -100,7 +100,7 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Available Isosurface Fields** +## Available Isosurface Fields *Isosurfaces can be defined based on the following field variables:* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md index ad994e0..1555e41 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/12.time-averaging-isosurface-output.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -20,7 +20,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 `Frequency`, `Frequency offset`, and `Start step` parameters refer to the **global** time step, which is transferred from the parent case. @@ -28,9 +28,9 @@ When working with **child cases** (cases forked from a parent simulation), it's --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *Select the flow variables to include in the isosurface output.* @@ -38,7 +38,7 @@ When working with **child cases** (cases forked from a parent simulation), it's - **Example:** `Mach`, `pressure`, `velocity` >**Note:** Select only the fields you need for your analysis. See [Available Output Fields](./00.output-fields.md#universal-fields) for a complete list of supported variables. -### **Output format** +### Output format *The file format used to save the isosurface output data.* @@ -52,7 +52,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose the format that best suits your post-processing workflow. > - Select `paraview` for `.vtu` format, `tecplot` for `.plt` format, or `both` to save in both formats. -### **Start step** +### Start step *The physical time step at which time-averaging begins.* @@ -62,7 +62,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Use positive integers to start averaging from a specific time step. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Save interval** +### Save interval *Choose the points in the simulation where the results are saved.* @@ -74,7 +74,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Choose `Save at end` to save only the final results of the simulation. > - Choose `Custom` to save the results in given intervals. -### **Frequency** +### Frequency *How often to save outputs, in number of physical time steps.* @@ -86,7 +86,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Higher frequencies provide better temporal resolution but increase storage requirements. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Frequency offset** +### Frequency offset *The time step at which to start the output animation.* @@ -98,7 +98,7 @@ When working with **child cases** (cases forked from a parent simulation), it's > - Useful when you want to skip initial transient flow development. > - Important for child cases - this parameter refers to the **global** time step (see [Global Time Stepping](#global-time-stepping-in-child-cases)). -### **Isosurfaces** +### Isosurfaces *Define one or more isosurfaces by specifying a field variable and iso-value.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/13.aeroacoustic-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/13.aeroacoustic-output.md index c327612..a1e1b80 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/13.aeroacoustic-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/13.aeroacoustic-output.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -15,9 +15,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Observers** +### Observers *Defines positions where acoustic data will be recorded. Each observer requires a position (3D coordinates) and a group name.* @@ -25,7 +25,7 @@ - **Example:** See Python example below >**Note:** Observers can be placed outside the simulation domain but must not be on or inside solid surfaces. -### **Write per surface output** +### Write per surface output *When enabled, aeroacoustic results are written for each surface separately, in addition to the combined results for all surfaces.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md index dfbb684..e9dd5bc 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/14.streamline-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -13,9 +13,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be included along the streamlines.* @@ -25,7 +25,7 @@ > - Streamline outputs only support **custom variables** (UserVariable), not predefined output fields. Create custom variables using the [Variable Settings](../../../05.tools/02.variable-settings.md) tool or Python API. > - Vector-valued fields will be colored by their magnitude. -### **Assigned points** +### Assigned points *Points that define the placement of streamlines. The Streamline is a path of a particle that passes through a given point.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md index 954f150..eb21ad2 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/15.time-averaging-streamline-output.md @@ -6,7 +6,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | |----------|---------------| @@ -16,9 +16,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The flow variables that will be included along the time-averaged streamlines.* @@ -28,7 +28,7 @@ > - Time-averaging streamline outputs only support **custom variables** (UserVariable), not predefined output fields. Create custom variables using the [Variable Settings](../../../05.tools/02.variable-settings.md) tool or Python API. > - Vector-valued fields will be colored by their magnitude. -### **Start step** +### Start step *The physical time step at which time-averaging begins.* @@ -40,7 +40,7 @@ > - Set this to a time step after initial transients have settled for more meaningful statistics. > - Important for child cases - this parameter refers to the **global** time step, which gets transferred from the parent case. See [Global Time Stepping in Child Cases](06.time-averaging-slice-output.md#global-time-stepping-in-child-cases) for more details. -### **Assigned points** +### Assigned points *Points that define the placement of streamlines. Streamtraces are computed upwind and downwind, and may originate from a single point, from a line, or from points evenly distributed across a parallelogram.* diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/16.force-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/16.force-output.md index dbe8c8b..4957e87 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/16.force-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/16.force-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -16,9 +16,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Output fields** +### Output fields *The force and moment coefficient fields that will be included in the force output.* @@ -36,7 +36,7 @@ - **Pressure components:** `CLPressure`, `CDPressure`, `CFxPressure`, `CFyPressure`, `CFzPressure`, `CMxPressure`, `CMyPressure`, `CMzPressure` - **Skin friction components:** `CLSkinFriction`, `CDSkinFriction`, `CFxSkinFriction`, `CFySkinFriction`, `CFzSkinFriction`, `CMxSkinFriction`, `CMySkinFriction`, `CMzSkinFriction` -### **Statistics function** +### Statistics function *Optional moving statistics function to apply to the output fields. When set to `None`, raw force and moment values are output. When a statistics function is selected, the specified statistic is calculated over a moving window.* @@ -49,7 +49,7 @@ - `standard_deviation` - Sample standard deviation (normalized by n-1, using Bessel's correction) of values in the window - `range` - Difference between the maximum and minimum values in the window -### **Moving window size** +### Moving window size *The size of the moving window in number of data points over which the statistics function is calculated. The window size is defined by the number of data points recorded in the output, not directly by pseudo-steps.* @@ -60,7 +60,7 @@ - **For steady simulations:** The solver typically outputs a data point once every 10 pseudo steps. This means a moving window size of 10 would cover 100 pseudo steps. - **For unsteady simulations:** The solver outputs a data point for every physical step. A moving window size of 10 would cover 10 physical steps. -### **Start step** +### Start step *The number of steps (pseudo or physical) to skip at the beginning of the simulation before the moving statistics calculation starts. This parameter is referenced to the start step of the simulation (pseudo-step 0).* @@ -71,7 +71,7 @@ - **For unsteady simulations:** The value is used directly as specified (corresponds to physical steps). - **Reference:** See [Global Time Stepping in Child Cases](02.time-averaging-volume-output.md#global-time-stepping-in-child-cases) for details on how start step is handled in child cases. -### **Assigned models** +### Assigned models *The surface or volume models whose force contributions will be calculated and included in the force output.* @@ -85,7 +85,7 @@ --- -## **Use Cases** +## Use Cases Force Output is useful for: diff --git a/docs/02.simulation-setup/04.output/02.outputs-list/17.force-distribution-output.md b/docs/02.simulation-setup/04.output/02.outputs-list/17.force-distribution-output.md index 795d316..2edfcdd 100644 --- a/docs/02.simulation-setup/04.output/02.outputs-list/17.force-distribution-output.md +++ b/docs/02.simulation-setup/04.output/02.outputs-list/17.force-distribution-output.md @@ -4,7 +4,7 @@ --- -## **Available Options** +## Available Options | *Option* | *Description* | *Applicable* | |----------|---------------|--------------| @@ -14,9 +14,9 @@ --- -## **Detailed Descriptions** +## Detailed Descriptions -### **Name** +### Name *Unique identifier for the force distribution output.* @@ -24,7 +24,7 @@ - **Example:** `"spanwise"`, `"chordwise"` >**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.* @@ -33,7 +33,7 @@ - **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). The sampling locations to calculate the force distribution are uniformly distributed along the specified direction in general, but for boundaries which have zero projection on the YZ plane, e.g. a flat floor, the sampling locations are coarser.* @@ -45,7 +45,7 @@ --- -## **Use Cases** +## Use Cases Force Distribution Output is useful for: @@ -57,7 +57,7 @@ Force Distribution Output is useful for: --- -## **Output Data** +## Output Data The output provides axis-aligned components of force and moment coefficients along the specified distribution direction. Data is saved in CSV format (pattern: `_forceDistribution.csv`) and can be accessed through the download from the **Assets** button. It is also possible to visualise the output from the Analysis -> Monitor -> 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 1a93a18..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,7 +37,7 @@ --- -## **Reference Documentation** +## Reference Documentation - **[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 diff --git a/docs/02.simulation-setup/04.output/README.md b/docs/02.simulation-setup/04.output/README.md index 7a19c44..a96ce07 100644 --- a/docs/02.simulation-setup/04.output/README.md +++ b/docs/02.simulation-setup/04.output/README.md @@ -2,7 +2,7 @@ *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* | |--------------------|-----------------------| diff --git a/docs/02.simulation-setup/README.md b/docs/02.simulation-setup/README.md index 35d67fb..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 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.