Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/.vuepress/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ orphan: true

## 🔍 **Detailed Descriptions**

### **Option_1**
### Option_1

*More detailed explanation or additional context of Option_1.*

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

### **Option_2**
### Option_2

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

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

### **Option_n**
### Option_n

*Explanation of the last option.*

Expand Down
12 changes: 6 additions & 6 deletions docs/01.introduction/01.dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

---

## **Dashboard Components**
## Dashboard Components

| *Component* | *Description* |
|--------------|-----------------|
Expand All @@ -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.*

Expand All @@ -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.*

Expand All @@ -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.*

Expand Down
16 changes: 8 additions & 8 deletions docs/01.introduction/02.starting-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

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

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

---

## **Available Options**
## Available Options

| *Option* | *Description* | *Default* |
|--------------------|------------------------------------------------------------|--------------------------|
Expand All @@ -22,41 +22,41 @@

---

## **Detailed Descriptions**
## Detailed Descriptions

### **Project name**
### Project name

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

- **Default:** `Untitled`
- **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.*

- **Default:** Latest stable release
- **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.*

- **Default:** `m` (meter)
- **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.*

- **Default:** Empty
- **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.*

Expand Down
24 changes: 12 additions & 12 deletions docs/01.introduction/03.workbench-layout/04.top-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

---

## **Available Components** (from left to right)
## Available Components (from left to right)

| *Component* | *Icon* | *Description* |
|---------------------|-------------|-------------------------------------------------------------------------------|
Expand All @@ -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.*

Expand All @@ -38,51 +38,51 @@
- 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.*

- **Geometry resource**: Import additional geometry files (Geometry AI only)
- **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.*

Expand Down
28 changes: 14 additions & 14 deletions docs/01.introduction/03.workbench-layout/05.viewer-region.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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* |
|----------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
Expand All @@ -29,9 +29,9 @@

---

## **Detailed Descriptions**
## Detailed Descriptions

### **View modes**
### View modes

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

Expand All @@ -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.*

Expand All @@ -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:

Expand Down Expand Up @@ -112,15 +112,15 @@ 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.*

- **Usage:**
- 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.*

Expand All @@ -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.*

Expand Down
8 changes: 4 additions & 4 deletions docs/01.introduction/03.workbench-layout/07.status-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

---

## **Available Components**
## Available Components

| *Component* | *Icon* | *Description* |
|--------------|-------------------|----------------------------------------------------------------|
| **Inspector** |![inspector](./Figures/inspector.png) | Displays and validates required simulation parameters |
| **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.*

Expand All @@ -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.*

Expand Down
4 changes: 2 additions & 2 deletions docs/01.introduction/03.workbench-layout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

---

## **Main Interface Sections**
## Main Interface Sections

| *Section* | *Description* |
|-------------|-----------------|
Expand All @@ -20,7 +20,7 @@

---

## **Detailed Descriptions**
## Detailed Descriptions

### 1️⃣ **Viewer region**

Expand Down
Loading
Loading