Skip to content

Commit 2e773c2

Browse files
forest-appsforest-apps
committed
Update user manual of FreeFloating
1 parent a289b2e commit 2e773c2

56 files changed

Lines changed: 352 additions & 15 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.

‎content/dp_capability_tool/_index.zh-cn.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "DP Capability Tool"
55

66

77
{{< hextra/hero-badge link="https://github.com/forest-apps/forest-apps.github.io/releases/download/DpCapabilityTool1.0_Windows.zip/DpCapabilityTool1.0_Windows.zip" >}}
8-
<span>Download and start with DpCapabilityTool.exe</span>
8+
<span>下载并运行文件 DpCapabilityTool.exe</span>
99
{{< /hextra/hero-badge >}}
1010

1111

‎content/free_floating/_index.md‎

Lines changed: 175 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,179 @@
11
---
2-
linkTitle: "Documentation"
3-
title: "FreeFloating"
2+
linkTitle: "HydroModeller"
3+
title: "HydroModeller"
44
---
55

6-
<div style="text-align: center; margin-top: 1em;">
7-
{{< hextra/hero-badge link="index.xml" >}}
8-
<span>RSS Feed</span>
9-
{{< icon name="rss" attributes="height=14" >}}
6+
{{< hextra/hero-badge link="https://github.com/forest-apps/forest-apps.github.io/releases/download/FreeFloating1.0_Windows.zip/FreeFloating1.0_Windows.zip" >}}
7+
<span>Download and start with FreeFloating.exe</span>
108
{{< /hextra/hero-badge >}}
11-
</div>
9+
10+
11+
## 1 Introduction
12+
13+
FreeFloating is a comprehensive 3D pre- and post-processing tool designed for wave diffraction and radiation analysis, leveraging the power of the open-source solver HAMS. It provides a user-friendly interface that simplifies the process of modeling all essential data required for the hydrodynamic analysis of floating offshore structures. Through this interface, users can easily define parameters for complex geometries, environmental conditions, and physical properties, facilitating efficient and accurate simulations. Additionally, the tool features a 3D model view, allowing users to visualize the structure in detail, inspect geometries, and ensure the accuracy of the model setup before running simulations.
14+
15+
Once the analysis is complete, FreeFloating generates key hydrodynamic coefficients, including response amplitude operators (RAOs) for added mass, damping coefficients, excitation forces, and motion responses. These results are not only presented in detailed numerical form but can also be visualized through graphical plots. This allows users to intuitively interpret the behavior of the structure under various environmental conditions, such as waves, currents, and wind forces.
16+
17+
## 2 User interface
18+
19+
The user interface consists of 5 main area, including
20+
21+
- Application title bar
22+
- Application menu bar
23+
- Project panel
24+
- 3D model view
25+
26+
27+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-12-23.png">
28+
29+
### 2.1 Application title bar
30+
31+
Application title bar is on the top of the user interface, showing the basic information of the project, such as the path of the project file.
32+
33+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-13-36.png">
34+
35+
### 2.2 Application menu bar
36+
37+
Application menu bar is composed of drop-down menus that contain a list of grouped menu items for the functionality related to the application or a project.
38+
39+
File menu contains the functionality to create/open/save a project. The recent projects can be remembered and reopened from the Open Recent list.
40+
41+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-14-16.png">
42+
43+
### 2.3 3D model view
44+
45+
In the 3D model view, users can explore and interact with 3D representations of basic shapes, full floating offshore structures, and their surrounding environments. This feature offers a dynamic, immersive experience, enabling users to thoroughly understand the geometry and structural layout of their models. Users can rotate, zoom, and pan to examine the model from various angles and perspectives. These interactions are managed through the mouse’s left, middle, or right buttons, with additional control options available by using the Ctrl, Shift, or Alt keys for more precise navigation and functionality.
46+
47+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-15-06.png">
48+
49+
### 2.4 Project panel
50+
51+
Project Panel, located on the left side of the main user interface, contains all the models related to a project. This includes settings for the location, waves, hydro body, loading conditions and analyses, providing easy access to essential project elements for efficient navigation and management.
52+
53+
Project panel is structured as a hierarchical tree, organizing all components of the model for easy access and management. Each node in the tree represents a different part of the project, such as geometry elements, settings, or simulation results. A visibility symbol, either 👁 for visible or ◯ for hidden, is displayed in front of each node, allowing users to quickly toggle the display of objects within the 3D model view. In addition to controlling visibility, users can right-click on any node to access a comprehensive context menu. This menu provides all the necessary modeling functionalities.
54+
55+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-15-51.png">
56+
57+
#### 2.4.1 Location
58+
59+
The water depth can be defined in the Location settings, while the acceleration due to gravity and water density are set to their default values.
60+
61+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-16-28.png">
62+
63+
#### 2.4.2 Waves
64+
65+
In the Waves settings, you can specify wave frequencies and directions.
66+
67+
Wave frequencies can be defined by inputting the wave period, wave frequency, or wave length.
68+
69+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-17-30.png">
70+
71+
Wave directions are specified as angles measured counterclockwise from the X-axis. A wave direction of 0 degrees indicates that the waves are moving along the positive X-axis.
72+
73+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-18-00.png">
74+
75+
#### 2.4.3 Hydro body
76+
77+
Hydro body includes the panel model for wave diffraction and radiation analysis.
78+
79+
##### 2.4.3.1 Panel model
80+
81+
Panel model files in formats of WAMIT, SESAM, HAMS, Abaqus, and AQWA are supported.
82+
83+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-18-49.png">
84+
85+
The panel mesh settings can be adjusted in the mesh settings dialog, where you can modify options for symmetrical planes and visualization.
86+
87+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-19-28.png">
88+
89+
The panels and nodes of a panel model can be cleared using the function available in the context menu. Additionally, basic information about the model can be accessed through this menu.
90+
91+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-20-00.png">
92+
93+
#### 2.4.4 Loading conditions
94+
95+
Loading conditions can be added to the "Loading Conditions" folder.
96+
97+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-20-36.png">
98+
99+
##### 2.4.4.1 Loading condition
100+
101+
The settings of a loading condition include: general settings, damping data, external restoring data and visualization settings.
102+
103+
The general settings consist of the loading condition's name and the waterline level (Z).
104+
105+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-21-12.png">
106+
107+
Users can configure both the linear damping matrix and the quadratic damping matrix for the loading condition.
108+
109+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-21-38.png">
110+
111+
The external restoring matrix can also be specified to account for the influence of mooring lines.
112+
113+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-22-04.png">
114+
115+
A reference plane and seabed can be rendered for better visualization of the floating structure using the settings in the "Visualization" tab.
116+
117+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-22-42.png">
118+
119+
Key details of a loading condition, such as displacement, center of buoyancy, and flotation area, can be displayed through the context menu.
120+
121+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-23-07.png">
122+
123+
###### 2.4.4.1.1 Mass model
124+
125+
A mass model is necessary for each loading condition. The mass data can be entered manually by the user or estimated based on the displaced water.
126+
127+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-24-02.png">
128+
129+
When the mass model is estimated based on displaced water, the total mass, center of gravity, and radii of gyration are calculated accordingly. Users must then fine-tune the mass data, including the center of gravity and radii of gyration, to ensure that the mass model of the floating offshore structure is reasonable.
130+
131+
###### 2.4.4.1.2 Water plane model
132+
133+
A water plane model can be added to a loading condition to eliminate the irregular frequencies.
134+
135+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-24-53.png">
136+
137+
A water plane model is similar to a panel model, and can be imported from panel mesh files in formats such as WAMIT, SESAM, HAMS, Abaqus, and AQWA. However, it retains only the panels at the top Z level.
138+
139+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-25-21.png">
140+
141+
###### 2.4.4.1.3 Wave elevation points
142+
143+
Users can define points on the free surface to assess the wave elevation RAO. Similar to the water plane model, a panel mesh can be imported from mesh files in formats such as WAMIT, SESAM, HAMS, Abaqus, and AQWA. Alternatively, individual points can be manually specified by the user.
144+
145+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-25-56.png">
146+
147+
###### 2.4.4.1.4 Field pressure points
148+
149+
Users have the ability to define specific points within the fluid field to evaluate the pressure RAO, which provides insight into how pressure fluctuates at various locations due to wave interactions.
150+
151+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-26-33.png">
152+
153+
#### 2.4.5 Analyses
154+
155+
##### 2.4.5.1 Analysis
156+
157+
Wave diffraction and radiation analysis can be performed for a single loading condition. Users can turn on or off the options for specific needs, including
158+
159+
- Added mass of the 0 and infinite frequencies
160+
- Remove irregular frequencies
161+
- Thread number
162+
163+
A water plane model is necessary in the loading condition to eliminate irregular frequencies. The thread number controls the maximum number of parallel threads, with a higher number speeding up the calculation process significantly.
164+
165+
Once the settings are correctly configured, the analysis can be started from the context menu.
166+
167+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-27-22.png">
168+
169+
The task execution dialog will display detailed processing information, providing real-time updates on the progress of the analysis. This includes key details such as the current stage of the process and any relevant system messages or notifications.
170+
171+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-27-48.png">
172+
173+
Once the analysis is successfully completed, the result plots can be accessed and viewed via the context menu.
174+
175+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-28-13.png">
176+
177+
A summary file containing the results in text format is also provided.
178+
179+
<img title="a title" alt="Alt text" src="images/Snipaste_2024-09-19_11-28-40.png">

0 commit comments

Comments
 (0)