Skip to content

Commit d115c6b

Browse files
piotrklubapiotrkluba
committed
edited image formatting
1 parent 2de1fe9 commit d115c6b

5 files changed

Lines changed: 34 additions & 39 deletions

File tree

‎docs/01.introduction/02.starting-project.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66

77
*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.*
88

9-
<p align="center">
10-
<img src="./Figures/new_project.png"/>
11-
</p>
9+
![new_project](./Figures/new_project.png)
1210

1311
---
1412

‎docs/01.introduction/03.workbench-layout/05.viewer-region.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@
3636

3737
| *Feature* | *Icon* | *Description* |
3838
|----------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
39-
| **View modes** | <img src="./Figures/view_selection.png" height="48" width="1000" alt="view selection"/> | Toggle between Geometry, Mesh, and Visualization views |
40-
| **Boundary conditions** | <img src="./Figures/boundary_conditions.png" height="48" alt="boundary conditions"/> | Toggle coloring of boundaries based on their assigned boundary condition |
41-
| **Diagnostic tools** | <img src="./Figures/diagnostic_tools.png" height="48" alt="diagnostic tools"/> | Geometry quality inspection features |
42-
| **Mesh display** | <img src="./Figures/mesh_display_solid.png" height="48" alt="mesh display solid"/> <img src="./Figures/mesh_display_edges.png" height="48" alt="mesh display edges"/> | Mesh display options: solid or solid with edges |
43-
| **Entity selection mode** | <img src="./Figures/entity_selection.png" height="48" alt="entity selection"/> | Tools for selecting and managing geometry entities |
44-
| **Entities visibility** | <img src="./Figures/entities_visibility.png" height="48" alt="entities visibility"/> | Toggle the visibility of entities by clicking the eye icon when hovering over them |
45-
| **Mesh metrics** | <img src="./Figures/mesh_metrics.png" height="48" alt="mesh metrics"/> | Expand the mesh metrics view by clicking on the icon when in mesh view |
46-
| **Viewpoints** | <img src="./Figures/viewpoint.png" height="48" alt="viewpoint"/> | Controls for saving and loading specific camera positions |
47-
| **Length scale indicator** | <img src="./Figures/length_scale.png" height="48" alt="length scale"/> | Visual reference showing model dimensions to help maintain perspective |
48-
| **Rotation cube** | <img src="./Figures/rotation_cube.png" height="48" alt="rotation cube"/> | Interactive orientation widget for quick view rotation to standard angles |
39+
| **View modes** | ![view_selection](./Figures/view_selection.png) | Toggle between Geometry, Mesh, and Visualization views |
40+
| **Boundary conditions** | ![boundary_conditions](./Figures/boundary_conditions.png) | Toggle coloring of boundaries based on their assigned boundary condition |
41+
| **Diagnostic tools** | ![diagnostic_tools](./Figures/diagnostic_tools.png) | Geometry quality inspection features |
42+
| **Mesh display** | ![mesh_display_solid](./Figures/mesh_display_solid.png) ![mesh_display_edges](./Figures/mesh_display_edges.png) | Mesh display options: solid or solid with edges |
43+
| **Entity selection mode** | ![entity_selection](./Figures/entity_selection.png) | Tools for selecting and managing geometry entities |
44+
| **Entities visibility** | ![entities_visibility](./Figures/entities_visibility.png) | Toggle the visibility of entities by clicking the eye icon when hovering over them |
45+
| **Mesh metrics** | ![mesh_metrics](./Figures/mesh_metrics.png) | Expand the mesh metrics view by clicking on the icon when in mesh view |
46+
| **Viewpoints** | ![viewpoint](./Figures/viewpoint.png) | Controls for saving and loading specific camera positions |
47+
| **Length scale indicator** | ![length_scale](./Figures/length_scale.png) | Visual reference showing model dimensions to help maintain perspective |
48+
| **Rotation cube** | ![rotation_cube](./Figures/rotation_cube.png) | Interactive orientation widget for quick view rotation to standard angles |
4949

5050
---
5151

@@ -81,10 +81,10 @@
8181

8282
| **Entity Type** | **Icon** | **Description** |
8383
|-----------------|----------|-----------------|
84-
| Points | <img src="./Figures/points.png" width="32" height="32" alt="points"/> | Select individual points/vertices |
85-
| Edges | <img src="./Figures/edges.png" width="32" height="32" alt="edges"/> | Select edge elements |
86-
| Faces | <img src="./Figures/faces.png" width="32" height="32" alt="faces"/> | Select face/surface elements |
87-
| Volumes | <img src="./Figures/volumes.png" width="32" height="32" alt="volumes"/> | Select volume elements |
84+
| Points | ![points](./Figures/points.png) | Select individual points/vertices |
85+
| Edges | ![edges](./Figures/edges.png) | Select edge elements |
86+
| Faces | ![faces](./Figures/faces.png) | Select face/surface elements |
87+
| Volumes | ![volumes](./Figures/volumes.png) | Select volume elements |
8888

8989
>**Note:** You can use any combination of selection modes.
9090

‎docs/01.introduction/03.workbench-layout/07.status-bar.md‎

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

99
| *Component* | *Icon* | *Description* |
1010
|--------------|-------------------|----------------------------------------------------------------|
11-
| **Inspector** | <img src="./Figures/inspector.png" height="48" alt="inspector"/> | Displays and validates required simulation parameters |
12-
| **Run Status** | <img src="./Figures/run_status.png" height="48" alt="run status"/> | Shows simulation progress, job status, and execution information |
11+
| **Inspector** |![inspector](./Figures/inspector.png) | Displays and validates required simulation parameters |
12+
| **Run Status** | ![run_status](./Figures/run_status.png) | Shows simulation progress, job status, and execution information |
1313
---
1414

1515
## **Detailed Descriptions**
@@ -18,9 +18,7 @@
1818

1919
*The Inspector panel validates and displays essential simulation parameters that must be defined or corrected before running the simulation.*
2020

21-
<p align="center">
22-
<img src="./Figures/inspector_details.png" alt="Inspector Panel">
23-
</p>
21+
![inspector_details](./Figures/inspector_details.png)
2422

2523
>**Important:** A simulation cannot be started until all required fields are filled and all errors are resolved (Inspector shows 0).
2624
@@ -38,9 +36,9 @@ The Inspector provides comprehensive validation feedback:
3836

3937
*The Run Status panel provides a hierarchical view of simulation execution stages and progress.*
4038

41-
<p align="center">
42-
<img src="./Figures/run_status_details.png" alt="Run Status Panel">
43-
</p>
39+
40+
![run_details](./Figures/run_status_details.png)
41+
4442

4543
- **Status Information:**
4644
- Real-time simulation logs

‎docs/01.introduction/05.project-tree.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,21 @@
66
>
77
>For example, if a surface mesh with identical settings already exists in the project, Flow360 will reuse it rather than generating a duplicate. Similarly, when a case with matching simulation parameters exists, the system will utilize the existing case instead of running a redundant simulation.
88
9-
<div align="center">
10-
<img src="./Figures/project_tree.png" alt="project_tree">
11-
</div>
9+
10+
![project_tree](./Figures/project_tree.png)
1211

1312
---
1413

1514
## **Icon Explanation**
1615

1716
| *Icon* | *Name* | *Description* |
1817
|----------|----------|-----------------|
19-
| <img src="./Figures/geometry.svg" width="32" height="32" alt="geometry"/> | Geometry | Represents the CAD geometry input for the simulation |
20-
| <img src="./Figures/surface_mesh.svg" width="32" height="32" alt="surface mesh"/> | Surface Mesh | Represents the discretized surface of the geometry |
21-
| <img src="./Figures/volume_mesh.svg" width="32" height="32" alt="volume mesh"/> | Volume Mesh | Represents the 3D computational mesh used for simulation |
22-
| <img src="./Figures/case.svg" width="32" height="32" alt="case"/> | Case | Represents a simulation case with defined parameters |
23-
| <img src="./Figures/fork.svg" width="32" height="32" alt="fork"/> | Fork | Indicates a continuation / branched variant of an existing parent |
24-
| <img src="./Figures/draft.svg" width="32" height="32" alt="draft"/> | Draft | Represents a simulation setup that hasn't been run yet |
18+
| ![geometry](./Figures/geometry.svg) | Geometry | Represents the CAD geometry input for the simulation |
19+
| ![surface_mesh](./Figures/surface_mesh.svg) | Surface Mesh | Represents the discretized surface of the geometry |
20+
| ![volume_mesh](./Figures/volume_mesh.svg) | Volume Mesh | Represents the 3D computational mesh used for simulation |
21+
| ![case](./Figures/case.svg) | Case | Represents a simulation case with defined parameters |
22+
| ![fork](./Figures/fork.svg) | Fork | Indicates a continuation / branched variant of an existing parent |
23+
| ![draft](./Figures/draft.svg) | Draft | Represents a simulation setup that hasn't been run yet |
2524

2625
---
2726

@@ -119,9 +118,9 @@ The project tree supports multiple branches at each level:
119118
120119
When clicking on a component in the project tree, a menu of available actions appears. Below are the available actions:
121120
122-
<div align="center">
123-
<img src="./Figures/details.png" width="50%" alt="details"/>
124-
</div>
121+
122+
![details](./Figures/details.png)
123+
125124
126125
| **Action** | **Description** |
127126
|------------|-----------------|

‎docs/02.simulation-setup/README.md‎

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

33
*This section covers all aspects of setting up a simulation in Flow360, including flow conditions, meshing, solver configuration, and output settings.*
44

5-
## 📋 **Contents**
5+
## **Contents**
66

77
| *Section* | *Description* |
88
|-------------|-----------------|
@@ -13,7 +13,7 @@
1313

1414
---
1515

16-
## 🔍 **Detailed Subsections**
16+
## **Detailed Subsections**
1717

1818
- **Flow Conditions:**
1919
- [Operating condition](./01.flow-conditions/01.operating-condition.md): Define physical values of fluid properties

0 commit comments

Comments
 (0)