[FXC-4908] Tools content

docs/05.tools/01.probing.md

@@ -0,0 +1,57 @@
+# Probing
+
+*Probing allows you to probe the location of any point on an imported geometry. This tool is useful for inspecting specific locations, measuring distances, and verifying geometry coordinates.*
+
+---
+
+## **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**
+
+The Probing tool is available when:
+
+- Geometry is loaded in the viewer
+- The probe tool icon appears in the viewer toolbar
+- Clicking the probe icon opens the "Probe location" panel
+
+<div align="center">
+
+![Probe](./Figures/probe.png)
+
+</div>
+
+---
+
+## **Operating Modes**
+
+Probing offers two modes of operation:
+
+### **Selection in Viewer**
+
+In this mode, you can directly click on any point in the 3D viewer to probe its location.
+
+- Click anywhere on the geometry surface in the viewer
+- The location coordinates are automatically displayed
+- The probed location is highlighted or marked in the viewer
+- Clicking a new point replaces the previous probed location
+
+### **Location Specification**
+
+In this mode, you can manually specify the coordinates of the point you want to probe.
+
+- Enter the X, Y, and Z coordinates directly
+- The specified location is displayed in the viewer
+- Useful for probing exact locations or locations that may be difficult to click
+
+---
+
+## **Interface Elements**
+
+The Probing interface appears as a pop-up panel with the following elements:
+
+- **Location field**: Labeled "Location -" with an edit icon, displays or allows input of the X, Y, Z coordinates
+- **Entity Name field**: Labeled "Entity Name -", shows the entity or surface name at the probed location

docs/05.tools/02.variable-settings.md

@@ -0,0 +1,128 @@
+# Variable Settings
+
+*The Variable Settings tab allows you to create and manage user-defined variables for use in simulations and post-processing. Variables can be defined using mathematical expressions involving constants, units, and other variables.*
+
+---
+
+## **Accessing Variable Settings**
+
+<div align="center">
+
+![Settings](./Figures/settings.png)
+
+</div>
+
+---
+
+## **Variable Types**
+
+The Variable Settings tool organizes variables into different categories through a tabbed interface:
+
+### **Custom Variables**
+
+The "Custom variables" tab displays user-defined variables in a table format with columns:
+
+- **Name**: The variable name (e.g., `velocity_ref`, `rho`, `q_inf`)
+- **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**
+
+Variables that can be used as inputs to the simulation, such as boundary condition values.
+
+#### **Post-processing**
+
+Variables defined for output and visualization purposes.
+
+### **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**
+
+The library allows you to pre-define variables which can be later imported to the custom variable panel.
+
+---
+
+## **Creating Variables**
+
+To create a new variable:
+
+1. Open the Variable Settings tool from the viewer toolbar
+2. Navigate to the "Custom variables" tab or "Library" tab
+3. Click the green "+ Add variable" button located to the right of the variables table
+4. Enter the variable name in the "Name" column
+5. Define the expression in the "Expression" box using:
+   - Constants with units (e.g., `100*u.m/u.s`)
+   - Mathematical operations (`+`, `-`, `*`, `/`, `**`)
+   - References to other variables
+   - Solution variables
+6. Optionally add a description in the "Description" box
+
+### **Importing a Variables from Library**
+
+To import solution variables into custom variables you can either:
+
+1. Navigate to the "Custom Variables" tab and select "Import from Library" **or** navigate directly to the "Library" tab.
+
+3. This brings you to the "Library" page, select the variables you want to import and then click on "Import to custom variables". The variables will appear in the "Custom Variables" tab.
+
+---
+
+## **Variable Expression Syntax**
+
+Variables support a rich expression syntax:
+
+- **Units**: Access units through the `u` namespace (e.g., `u.m`, `u.s`, `u.kg`, `u.Pa`)
+- **Mathematical operations**: Standard arithmetic and functions
+- **Variable references**: Reference other custom variables by name
+- **Solution variables**: Access solver quantities
+
+---
+
+## **Example Variables**
+
+Compute a dimensional time step for a rotor simulation with the following variables:
+
+<div align="center">
+
+![VariablesExample](./Figures/variables.png)
+
+</div>
+
+then you can set the rotational speed with:
+
+<div align="center">
+
+![RotorSpeed](./Figures/rotor_speed.png)
+
+</div>
+
+and the time step with:
+
+<div align="center">
+
+![TimeStep](./Figures/time_settings.png)
+
+</div>
+
+---
+
+<details>
+<summary><h3 style="display:inline-block">❓ Frequently Asked Questions</h3></summary>
+
+- **Where can I use custom variables?**  
+  > Custom variables can be used in boundary conditions, initial conditions, output expressions, and other simulation parameters that accept expressions.
+
+- **What happens if I reference a variable that doesn't exist?**  
+  > Flow360 will display an error indicating that the variable is not defined. Make sure to define variables before referencing them.
+
+- **Can I import variables from a library?**  
+  > The Variable Settings tool includes a library feature that allows you to select and import pre-defined solution variables into your custom variables.
+
+- **How do I delete a variable?**  
+  > Variables can be removed through the Variable Settings interface. Note that variables referenced elsewhere may need to be updated first.
+
+</details>

docs/05.tools/03.surface-mesh-diagnostics.md

@@ -0,0 +1,67 @@
+# Surface Mesh Diagnostics
+
+*The Surface Mesh Diagnostics tool provides comprehensive analysis capabilities for assessing the quality of surface meshes. When a surface mesh is loaded, this tool becomes available to help identify potential mesh quality issues.*
+
+---
+
+## **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:
+
+- Identifying poor quality mesh elements
+- Verifying mesh quality before volume mesh generation
+- Understanding mesh characteristics across different surfaces
+- Diagnosing potential issues that could affect simulation accuracy
+
+---
+
+## **Accessing Surface Mesh Diagnostics**
+
+The Surface Mesh Diagnostics tool is available when:
+
+- A surface mesh is loaded in the viewer
+- The "Surface Mesh Diagnostic" button appears in the viewer toolbar
+
+<div align="center">
+
+![InspectionButton](./Figures/inspection.png)
+
+</div>
+
+- Clicking the button opens the "Surface Mesh Diagnostic" interface
+
+---
+
+## **Diagnostic Features**
+
+### **Quality Metrics**
+
+The "Surface mesh metrics" section provides access to various pre-computed mesh quality metrics through a searchable dropdown:
+
+- **None**: Option to disable metric visualization
+- **Area**: Surface element area
+- **Aspect Ratio**: Ratio of longest to shortest edge
+- **Incircle/Circumcircle Radius Ratio Quality**: Quality measure based on inscribed and circumscribed circles
+- **Maximum Angle**: Largest angle in the element
+- **Minimum Angle**: Smallest angle in the element
+- **Minimum Edge Length**: Shortest edge length in the element
+- **Skewness Quality**: Measure of element distortion
+
+> 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**
+
+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**
+
+The "Poor quality elements" tab allows you to filter and identify problematic mesh elements:
+
+- **Metric selection**: Choose a mesh quality metric from the dropdown (e.g., Aspect Ratio)
+- **Condition operators**: Set comparison operators (">", "<", ">=", "<=", "=", "≠")
+- **Threshold values**: Enter numerical thresholds (e.g., "25" for Aspect Ratio > 25)
+- **Add conditions**: Use the "+ Add condition" button to combine multiple quality criteria
+- **Apply filters**: Click the green "Apply" button to filter elements based on conditions

docs/05.tools/04.volume-mesh-diagnostics.md

@@ -0,0 +1,74 @@
+# Volume Mesh Diagnostics
+
+*The Volume Mesh Diagnostics tool provides comprehensive analysis capabilities for assessing the quality of volume meshes through automatically generated slices. This tool helps identify mesh quality issues in the 3D volume mesh.*
+
+---
+
+## **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:
+
+- Identify poor quality volume elements
+- Inspect mesh quality at different locations
+- Understand mesh characteristics throughout the domain
+- Diagnose potential issues that could affect simulation accuracy
+
+---
+
+## **Accessing Volume Mesh Diagnostics**
+
+The Volume Mesh Diagnostics tool is available when:
+
+- A volume mesh is loaded in the viewer
+- The "Volume Mesh Diagnostic" button appears in the viewer toolbar (below the file path in the top bar)
+
+<div align="center">
+
+![VolumeDiagnosis](./Figures/inspection.png)
+
+</div>
+
+- Clicking the button opens the "Volume Mesh Diagnostic" interface
+
+---
+
+## **Diagnostic Features**
+
+### **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:
+
+- **Aspect Ratio**: Ratio of longest to shortest edge of the volume cells
+- **Minimum Edge Length**: Shortest edge length in the volume cells
+- **Maximum Edge Length**: Longest edge length in the volume cells
+- **Volume**: Volume of the individual cells in the slice
+- **Maximum Aspect Ratio**: Largest aspect ratio found in the slice
+
+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**
+
+The tool automatically creates slices for analysis:
+
+- **Worst-quality slices**: Slices are automatically generated based on worst aspect ratio and minimum edge length locations
+- **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**
+
+The diagnosis settings panel provides comprehensive slice management:
+
+- **Slices list section**: View and manage all available slices in the "Slices list" section
+- **Search functionality**: Use the "Search" input field to filter slices by name or criteria
+- **Visibility toggle**: Eye icon next to each slice entry allows you to show or hide individual slices in the viewer
+- **Slice switching**: "Switch to crinkled" button toggles between crinkled (showing actual mesh element boundaries) and smooth slice visualization
+
+<div align="center">
+
+![CrinkledView](./Figures/crinkled.png)
+
+</div>
+
+- **Slice information**: Hover over slice entries to see tooltips with detailed information:
+  - Example: "Worst-quality x-normal slice based on smallest minimum edge length in zone farfield"
+  - Example: "Worst-quality x-normal slice based on maximum aspect ratio in zone farfield"