asv_wave_sim 项目安装与使用教程

asv_wave_sim 项目安装与使用教程

asv_wave_sim This package contains plugins that support the simulation of waves and surface vessels in Gazebo. 项目地址: https://gitcode.com/gh_mirrors/as/asv_wave_sim

1. 项目目录结构及介绍

asv_wave_sim 项目是一个用于在 Gazebo 中模拟波浪和水面船只的插件包。项目的目录结构如下：

asv_wave_sim/
├── gz-waves-models/
│   ├── models/
│   ├── world_models/
│   └── worlds/
├── gz-waves/
│   ├── src/
│   │   └── gui/
│   │       └── plugins/
│   │           └── waves_control/
│   └── include/
├── doc/
├── LICENSE
├── LICENSE_THIRDPARTY
├── README.md
└── CPPLINT.cfg

目录结构介绍

• gz-waves-models/: 包含用于模拟波浪和水面船只的模型文件和世界文件。

  • models/: 存放水面船只的模型文件。
  • world_models/: 存放世界模型文件。
  • worlds/: 存放世界文件。

• gz-waves/: 包含波浪模拟的核心代码和 GUI 插件。

  • src/: 存放源代码文件。
    • gui/plugins/waves_control/: 包含用于控制波浪参数的 GUI 插件。
  • include/: 存放头文件。

• doc/: 存放项目文档。

• LICENSE: 项目的许可证文件。

• LICENSE_THIRDPARTY: 第三方库的许可证文件。

• README.md: 项目的介绍和使用说明。

• CPPLINT.cfg: 代码风格检查配置文件。

2. 项目启动文件介绍

项目的启动文件主要用于启动 Gazebo 模拟环境，并加载波浪和水面船只的模型。启动文件通常位于 gz-waves-models/worlds/ 目录下。

启动文件示例

<sdf version="1.6">
  <world name="waves">
    <plugin filename="gz-waves1-waves-model-system" name="gz::sim::systems::WavesModel">
      <static>0</static>
      <update_rate>30</update_rate>
      <wave>
        <tile_size>256.0</tile_size>
        <cell_count>128</cell_count>
        <algorithm>fft</algorithm>
        <wind_speed>5.0</wind_speed>
        <wind_angle_deg>135</wind_angle_deg>
        <steepness>2</steepness>
      </wave>
    </plugin>
    <plugin filename="gz-waves1-waves-visual-system" name="gz::sim::systems::WavesVisual">
      <static>0</static>
      <mesh_deformation_method>DYNAMIC_GEOMETRY</mesh_deformation_method>
      <tiles_x>-1 1</tiles_x>
      <tiles_y>-1 1</tiles_y>
      <wave>
        <algorithm>fft</algorithm>
        <tile_size>256.0</tile_size>
        <cell_count>128</cell_count>
        <wind_speed>5.0</wind_speed>
        <wind_angle_deg>135</wind_angle_deg>
        <steepness>2</steepness>
      </wave>
    </plugin>
  </world>
</sdf>

启动文件说明

• sdf: 定义模拟世界的根元素。
• world: 定义模拟世界的名称和插件。
• plugin: 加载波浪模拟的插件。
  • WavesModel: 用于模拟波浪的模型插件。
  • WavesVisual: 用于可视化波浪的插件。

3. 项目配置文件介绍

项目的配置文件主要用于设置波浪模拟的参数，如波浪大小、风速、风向等。配置文件通常位于 gz-waves-models/world_models/ 目录下。

配置文件示例

<wave>
  <tile_size>256.0</tile_size>
  <cell_count>128</cell_count>
  <algorithm>fft</algorithm>
  <wind_speed>5.0</wind_speed>
  <wind_angle_deg>135</wind_angle_deg>
  <steepness>2</steepness>
</wave>

配置文件说明

• tile_size: 定义波浪网格的大小。
• cell_count: 定义波浪网格的单元数量。
• algorithm: 定义波浪生成算法，可选值为 fft、trochoid 等。
• wind_speed: 定义风速。
• wind_angle_deg: 定义风向。
• steepness: 定义波浪的陡峭程度。

通过配置这些参数，可以调整波浪模拟的效果，以适应不同的模拟需求。

asv_wave_sim This package contains plugins that support the simulation of waves and surface vessels in Gazebo. 项目地址: https://gitcode.com/gh_mirrors/as/asv_wave_sim