Skip to content

Commit 45a91e8

Browse files
[FXC-4770] Organise Output Section (#56)
* update * comments * remove bold headers
1 parent 11e9105 commit 45a91e8

113 files changed

Lines changed: 1112 additions & 1215 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.vuepress/template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ orphan: true
2020

2121
## 🔍 **Detailed Descriptions**
2222

23-
### **Option_1**
23+
### Option_1
2424

2525
*More detailed explanation or additional context of Option_1.*
2626

2727
- **Default:** `default value`
2828
- **Example:** `sample input`
2929
- **Notes:** Additional notes or caveats.
3030

31-
### **Option_2**
31+
### Option_2
3232

3333
*Detailed explanation for Option_2, clarifying possible values or scenarios.*
3434

3535
- **Default:** `default value`
3636
- **Example:** `sample input`
3737
- **Notes:** Additional notes or caveats.
3838

39-
### **Option_n**
39+
### Option_n
4040

4141
*Explanation of the last option.*
4242

docs/01.introduction/01.dashboard.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
---
66

7-
## **Dashboard Components**
7+
## Dashboard Components
88

99
| *Component* | *Description* |
1010
|--------------|-----------------|
@@ -15,9 +15,9 @@
1515

1616
---
1717

18-
## **Detailed Descriptions**
18+
## Detailed Descriptions
1919

20-
### **Recent**
20+
### Recent
2121

2222
*The main area displays a grid of recent project cards, showing your latest CFD simulations in chronological order.*
2323

@@ -32,14 +32,14 @@
3232
- Manually refresh all project resource statuses
3333
- Located next to New project button
3434

35-
### **FlexCredits**
35+
### FlexCredits
3636

3737
*Shows your current balance of computation credits.*
3838

3939
- **Balance:** Numerical value of your current FlexCredit balance.
4040
- **Updates:** Credits are consumed based on computational resources used.
4141

42-
### **Pending resources**
42+
### Pending resources
4343

4444
*Displays pending computational resources and their current status.*
4545

@@ -50,7 +50,7 @@
5050

5151
>**Note:** Below **Pending resources** there is a visual representation of all project's statuses called **Projects**.
5252
53-
### **Start with the example**
53+
### Start with the example
5454

5555
*A quick-start option for new users to begin with Flow360.*
5656

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

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

33
*This document describes how to start a project in Flow360 GUI.*
44

5-
## **New Project**
5+
## New Project
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

99
![new_project](./Figures/new_project.png)
1010

1111
---
1212

13-
## **Available Options**
13+
## Available Options
1414

1515
| *Option* | *Description* | *Default* |
1616
|--------------------|------------------------------------------------------------|--------------------------|
@@ -22,41 +22,41 @@
2222

2323
---
2424

25-
## **Detailed Descriptions**
25+
## Detailed Descriptions
2626

27-
### **Project name**
27+
### Project name
2828

2929
*Unique name that identifies your simulation project in the Flow360 system.*
3030

3131
- **Default:** `Untitled`
3232
- **Example:** `Wing_Analysis_M08`
3333
>**Note:** Choose a descriptive name that helps identify the project purpose.
3434
35-
### **Solver version**
35+
### Solver version
3636

3737
*Specifies the Flow360 solver version to be used for the simulation.*
3838

3939
- **Default:** Latest stable release
4040
- **Example:** `release-24.11`
4141
>**Note:** It's recommended to use the latest stable release unless specific version compatibility is required.
4242
43-
### **Unit**
43+
### Unit
4444

4545
*Defines the physical unit for interpreting mesh/geometry dimensions.*
4646

4747
- **Default:** `m` (meter)
4848
- **Example:** `inch`
4949
>**Note:** Ensure this matches the units used in your CAD or mesh file to avoid scaling issues.
5050
51-
### **Description**
51+
### Description
5252

5353
*Optional field for adding project notes, objectives, or other relevant information.*
5454

5555
- **Default:** Empty
5656
- **Example:** `High-lift configuration analysis at takeoff conditions`
5757
>**Note:** Below the description field you can add tags to your project by clicking the `+ Add` icon.
5858
59-
### **Creation methods**
59+
### Creation methods
6060

6161
*Choose how to initialize your project.*
6262

docs/01.introduction/03.workbench-layout/04.top-bar.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
---
88

9-
## **Available Components** (from left to right)
9+
## Available Components (from left to right)
1010

1111
| *Component* | *Icon* | *Description* |
1212
|---------------------|-------------|-------------------------------------------------------------------------------|
@@ -23,13 +23,13 @@
2323

2424
---
2525

26-
## **Detailed Descriptions**
26+
## Detailed Descriptions
2727

28-
### **Flow360 logo**
28+
### Flow360 logo
2929

3030
*Quick access to return to the Flow360 Dashboard, maintaining efficient workflow navigation.*
3131

32-
### **Project tree**
32+
### Project tree
3333

3434
*Hierarchical organization of project components, providing structured access to simulation elements.*
3535

@@ -38,51 +38,51 @@
3838
- Direct component access
3939
- See [Project tree](../05.project-tree.md) for more details
4040

41-
### **More**
41+
### More
4242

4343
*Additional project management options accessible via a three-dot menu.*
4444

4545
- Import/Export simulation settings
4646
- Import/Export viewpoints
4747

48-
### **View only**
48+
### View only
4949

5050
*Notification that the project is currently being viewed in view-only mode.*
5151

5252
- Simulation parameters cannot be changed in this mode
5353
- To exit, click on New run or select a component from the project tree
5454

55-
### **Assets**
55+
### Assets
5656

5757
![assets](./Figures/assets.svg) *Central repository for project-related resources and files.*
5858

5959
- Information about each asset
6060
- Downloadable files list for each asset
6161

62-
### **Resource**
62+
### Resource
6363

6464
![resource](./Figures/resource_icon.svg) *Import geometry resources and sample surfaces.*
6565

6666
- **Geometry resource**: Import additional geometry files (Geometry AI only)
6767
- **Sample surface**: Import sample surface data
6868

6969

70-
### **Probe**
70+
### Probe
7171

7272
![probe](./Figures/probe-icon.svg) *Show location of entered coordinates or show coordinates of a clicked location.*
7373

7474
- Enter coordinates to highlight a location in the viewer
7575
- Click on geometry to display coordinates of that point
7676

77-
### **Help**
77+
### Help
7878

7979
![help](./Figures/help.svg) *Access to documentation, support resources, and guidance materials.*
8080

81-
### **Project settings**
81+
### Project settings
8282

8383
![settings](./Figures/project_settings.svg) *Configuration interface for project-specific parameters. Includes run settings and project details.*
8484

85-
### **Fork/New run**
85+
### Fork/New run
8686

8787
*Create an extension of a case based on current configuration.*
8888

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

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

33
*The viewer region is the primary visualization interface in Flow360 GUI, providing interactive 3D visualization capabilities for geometry inspection, mesh analysis, and results visualization.*
44

5-
## **Example Views**
5+
## Example Views
66

77
### Geometry View Mode
88
![viewer_geometry](./Figures/viewer_geometry.png)
@@ -12,7 +12,7 @@
1212
![viewer_mesh](./Figures/viewer_mesh.png)
1313
*Example of the mesh view mode displaying a mesh visualization.*
1414

15-
## **Core Features**
15+
## Core Features
1616

1717
| *Feature* | *Icon* | *Description* |
1818
|----------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
@@ -29,9 +29,9 @@
2929

3030
---
3131

32-
## **Detailed Descriptions**
32+
## Detailed Descriptions
3333

34-
### **View modes**
34+
### View modes
3535

3636
*Toggle between Geometry/Mesh/Visualization views using top toolbar tabs.*
3737

@@ -41,21 +41,21 @@
4141

4242
>**Note:** Each mode provides context-specific tools and options.
4343
44-
### **Boundary conditions**
44+
### Boundary conditions
4545

4646
*Toggle coloring of boundaries based on their assigned boundary condition.*
4747

4848
>**Note:** Helps verify boundary condition assignments before mesh generation.
4949
50-
### **Diagnostic tools**
50+
### Diagnostic tools
5151

5252
*Tools for geometry quality inspection and validation that color areas of geometry depending on their level of confidence.*
5353

54-
### **Mesh display**
54+
### Mesh display
5555

5656
*Control the visualization of mesh elements and their properties. Can be set as either solid or solid with edges.*
5757

58-
### **Entity selection mode**
58+
### Entity selection mode
5959

6060
*Tools for selecting and managing geometry entities.*
6161

@@ -68,15 +68,15 @@
6868

6969
>**Note:** You can use any combination of selection modes.
7070
71-
### **Entities visibility**
71+
### Entities visibility
7272

7373
*Toggle the visibility of entities by clicking the eye icon when hovering over them.*
7474

75-
### **Mesh metrics**
75+
### Mesh metrics
7676

7777
*Quantitative mesh quality assessment tools for analyzing both surface and volume mesh characteristics.*
7878

79-
### **Element types overview**
79+
### Element types overview
8080

8181
The mesh quality visualization provides statistics for different element types commonly found in CFD meshes:
8282

@@ -112,15 +112,15 @@ Nodes are present in every mesh and represent the intersection points of mesh el
112112
| **Aspect Ratio** | Element shape quality indicator | Identifies highly stretched or compressed elements |
113113
| **Volume** | Element volume measurement | Helps detect very small or large elements that might affect solution stability |
114114

115-
### **Viewpoints**
115+
### Viewpoints
116116

117117
*Controls for saving and loading specific camera positions.*
118118

119119
- **Usage:**
120120
- Click the + icon to add a new viewpoint that will be the current camera position
121121
- Name the viewpoint to be representative of the camera position
122122

123-
### **Length scale indicator**
123+
### Length scale indicator
124124

125125
*Visual reference showing model dimensions to help maintain perspective.*
126126

@@ -129,7 +129,7 @@ Nodes are present in every mesh and represent the intersection points of mesh el
129129
- Unit system consistency
130130
- Reference dimension display
131131

132-
### **Rotation cube**
132+
### Rotation cube
133133

134134
*Interactive orientation widget for quick view rotation to standard angles.*
135135

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
---
66

7-
## **Available Components**
7+
## Available Components
88

99
| *Component* | *Icon* | *Description* |
1010
|--------------|-------------------|----------------------------------------------------------------|
1111
| **Inspector** |![inspector](./Figures/inspector.png) | Displays and validates required simulation parameters |
1212
| **Run Status** | ![run_status](./Figures/run_status.png) | Shows simulation progress, job status, and execution information |
1313
---
1414

15-
## **Detailed Descriptions**
15+
## Detailed Descriptions
1616

17-
### **Inspector**
17+
### Inspector
1818

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

@@ -32,7 +32,7 @@ The Inspector provides comprehensive validation feedback:
3232
- Context information ("relevant for: Case")
3333
- Detailed error messages when applicable
3434

35-
### **Run Status**
35+
### Run Status
3636

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

docs/01.introduction/03.workbench-layout/README.md

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

77
---
88

9-
## **Main Interface Sections**
9+
## Main Interface Sections
1010

1111
| *Section* | *Description* |
1212
|-------------|-----------------|
@@ -20,7 +20,7 @@
2020

2121
---
2222

23-
## **Detailed Descriptions**
23+
## Detailed Descriptions
2424

2525
### 1️⃣ **Viewer region**
2626

0 commit comments

Comments
 (0)