海流
POSIMはワールドの海流を生成し、各ロボットの位置で流速を計算します。ROSサービスで設定を変更できます。空間的に一様な海流と、深さによって変わる海流では、トピックと設定が異なります。
サンプルを動かす
使用するPOSIM環境(Ubuntuネイティブ、WSL、Docker、macOSのリモートデスクトップ)でターミナルAとBを準備します。Aで起動します。
ros2 launch posim_demos posim_robot.launch.py \
namespace:=rexrov world_name:=ocean_current_plugin z:=-5 paused:=false \
gui:=true headless:=false use_teleop:=false use_web_joystick:=false
BでGazebo、ROSの順に確認します。最初の表示をCtrl+Cで止めてから、次のコマンドを実行してください。
gz topic -e -t /ocean_current
ros2 topic echo /hydrodynamics/currentVelocityTopic --once
ワールドの海流を設定する
2つのプラグインを<world>直下に配置します。ワールドの海流プラグインをROSプラグインより先に置いてください。全体の構成はサンプルワールドを参照できます。
<plugin filename="OceanCurrentWorldPlugin"
name="posim_gz_world_plugins::OceanCurrentWorldPlugin">
<namespace>hydrodynamics</namespace>
<constant_current>
<use_constant_current>true</use_constant_current>
<topic>ocean_current</topic>
<velocity><mean>0.3</mean><min>0</min><max>0.6</max><mu>0</mu><noiseAmp>0</noiseAmp></velocity>
<horizontal_angle><mean>0</mean><min>-3.14</min><max>3.14</max><mu>0</mu><noiseAmp>0</noiseAmp></horizontal_angle>
<vertical_angle><mean>0</mean><min>-1.57</min><max>1.57</max><mu>0</mu><noiseAmp>0</noiseAmp></vertical_angle>
</constant_current>
<transient_current>
<topic_stratified>stratified_current_velocity</topic_stratified>
<databasefileName>transientOceanCurrentDatabase.csv</databasefileName>
</transient_current>
</plugin>
<plugin filename="OceanCurrentPlugin" name="posim_ros_gz_plugins::OceanCurrentPlugin">
<namespace>hydrodynamics</namespace>
</plugin>
両方に同じ、空ではないnamespaceを指定します。constant_currentとtransient_currentの両ブロックが必要です。必須設定がない場合は配信を無効にしてエラーを出力します。一様流の速さ・水平角・垂直角には、それぞれ独立したガウス・マルコフモデルを使います。
| パラメーター | 意味と既定値 |
|---|---|
両プラグインのnamespace |
共通の名前空間。この例ではhydrodynamics |
constant_current/use_constant_current |
一様流を配信するか。false |
constant_current/topic |
一様流のGazeboトピック。ocean_current |
transient_current/topic_stratified |
名前空間内の層別Gazeboトピック。stratified_current_velocity |
transient_current/databasefileName |
インストール済みposim_worlds/worlds内のCSV。transientOceanCurrentDatabase.csv |
transient_current/databasefilePath |
任意のCSVパス。ファイル名指定より優先 |
各確率モデルのmean |
速さ(m/s)または角度(rad)の初期平均値。0 |
min, max |
下限・上限。−1、1。min < maxとし、平均値を範囲内に設定 |
noiseAmp |
ランダムな増分の振幅。0 |
mu |
ガウス・マルコフモデルの減衰係数。0 |
tidal_oscillation |
任意の潮流データ設定ブロック |
深度別の流速プロファイルを用意する
サンプルCSVの列は、ワールドX軸の速度(m/s)、ワールドY軸の速度(m/s)、深さ(m)の順です。従来のキーvelocity_north、velocity_east、velocity_downは、それぞれワールドX、Y、Z軸に直接対応します。
- 先頭3行の説明・見出しを残します。
- 少なくとも2層を用意し、各データ行に有限の数値を3つ指定します。
- 深さは0以上で、厳密に増加する順に並べます。
- ファイルがない場合や形式が不正な場合は、海流の配信を無効にします。
ワールドのROSプラグインはデータベース全体を配信します。モデル側のプラグインが機体の深さに合わせて補間します。流体力の計算では、機体の速度に対する相対的な流れが使われます。
ロボットにプロファイルを適用する
REXROVのサンプルは初期状態では一様流/ocean_currentを使います。深度プロファイルを使うには、REXROVモデルでコメントアウトされている次のブロックを、重複させずに<model>直下で有効にします。
<plugin filename="OceanCurrentModelPlugin"
name="posim_gz_model_plugins::OceanCurrentModelPlugin">
<namespace>rexrov</namespace>
<flow_velocity_topic>ocean_current</flow_velocity_topic>
<transient_current>
<topic_stratified>/hydrodynamics/stratified_current_velocity_topic_database</topic_stratified>
<velocity_north><mean>0</mean><mu>0</mu><noiseAmp>0</noiseAmp><noiseFreq>0</noiseFreq></velocity_north>
<velocity_east><mean>0</mean><mu>0</mu><noiseAmp>0</noiseAmp><noiseFreq>0</noiseFreq></velocity_east>
<velocity_down><mean>0</mean><mu>0</mu><noiseAmp>0</noiseAmp><noiseFreq>0</noiseFreq></velocity_down>
</transient_current>
<tide_oscillation>false</tide_oscillation>
</plugin>
既存のgz-sim-hydrodynamics-systemにも<namespace>rexrov</namespace>を追加します。そのプラグインのリンク、密度、抗力係数は保ちます。ワークスペースを再ビルドし、環境を読み込んでください。
| モデルのパラメーター | 意味と既定値 |
|---|---|
namespace |
必須。流体力プラグインの名前空間と一致させる。この例ではrexrov |
flow_velocity_topic |
/model/<namespace>/以下の接尾辞。ocean_current |
transient_current/topic_stratified |
データベースのROS入力。hydrodynamics/stratified_current_velocity_topic_database |
velocity_north, velocity_east, velocity_down |
各成分の任意の確率設定。省略した成分にはノイズを加えない |
各成分のmean |
初期速度、m/s。0。データ受信後は補間した速度に置き換える |
mu |
0~1の減衰係数。経過したシミュレーション時間(秒)を使って適用。既定値0 |
noiseAmp |
補間速度から許容する偏差、m/s。0 |
noiseFreq |
更新ごとのランダム増分の振幅。0。Hz単位の周波数ではない |
tide_oscillation |
提供された潮流データをモデルに適用するか。false |
結果は/model/rexrov/ocean_currentに、Gazeboではgz.msgs.Vector3d、ROSではgeometry_msgs/msg/TwistStampedとして配信されます。出力値と機体の応答を確認してください。
深さはモデルのワールド座標から求め、水面より上では0とします。層の間は補間し、範囲外では最も近い層の値を使います。一時停止中や同じ時刻が繰り返された場合は更新しません。不正なデータベースメッセージは全体を拒否し、最後の有効なプロファイルを維持します。
システムとトピック
| システム | 役割 |
|---|---|
posim_gz_world_plugins::OceanCurrentWorldPlugin |
ワールドの海流と深度別データを生成 |
| モデルの海流プラグイン | ロボットの位置で流速を補間 |
posim_ros_gz_plugins::OceanCurrentPlugin |
ROSデータ配信と設定サービスを提供 |
| サンプルのトピック | 通信系と型 |
|---|---|
/ocean_current |
Gazebo、gz.msgs.Vector3d |
/hydrodynamics/stratified_current_velocity |
Gazebo、層別データ |
/hydrodynamics/stratifiedCurrentVelocityTopic |
ROS、posim_interfaces/msg/StratifiedCurrentVelocity |
/hydrodynamics/currentVelocityTopic |
ROS、geometry_msgs/msg/TwistStamped |
/hydrodynamics/stratified_current_velocity_topic_database |
ROS、posim_interfaces/msg/StratifiedCurrentDatabase |
SDFの名前を確認し、流体力プラグインを意図した海流の出力先に接続してください。
ROSサービスで流れを調整する
Bでサービスを調べ、水平な0.3 m/sの流れを設定します。
ros2 service list -t
ros2 service call /hydrodynamics/set_current_velocity posim_interfaces/srv/SetCurrentVelocity \
'{velocity: 0.3, horizontal_angle: 0.0, vertical_angle: 0.0}'
速さはm/s、角度はラジアンです。応答のsuccessと配信値を確認します。層ごとの設定インターフェースは次のコマンドで確認できます。
ros2 interface show posim_interfaces/srv/SetStratifiedCurrentVelocity
モデルを読み取り、範囲を変更して、最初の層を設定する例です。
ros2 service call /hydrodynamics/get_current_velocity_model \
posim_interfaces/srv/GetCurrentModel '{}'
ros2 service call /hydrodynamics/set_current_velocity_model \
posim_interfaces/srv/SetCurrentModel \
'{mean: 0.3, min: 0.0, max: 0.6, noise: 0.0, mu: 0.0}'
ros2 service call /hydrodynamics/set_stratified_current_velocity \
posim_interfaces/srv/SetStratifiedCurrentVelocity \
'{layer: 0, velocity: 0.2, horizontal_angle: 0.0, vertical_angle: 0.0}'
/hydrodynamics以下のサービス |
インターフェース | 入力フィールド |
|---|---|---|
get_current_velocity_model, get_current_horz_angle_model, get_current_vert_angle_model |
GetCurrentModel |
空のリクエスト |
set_current_velocity_model, set_current_horz_angle_model, set_current_vert_angle_model |
SetCurrentModel |
mean, min, max, noise, mu |
set_current_velocity |
SetCurrentVelocity |
velocity, horizontal_angle, vertical_angle |
set_current_horz_angle, set_current_vert_angle |
SetCurrentDirection |
angle |
set_stratified_current_velocity |
SetStratifiedCurrentVelocity |
layer, velocity, horizontal_angle, vertical_angle |
set_stratified_current_horz_angle, set_stratified_current_vert_angle |
SetStratifiedCurrentDirection |
layer, angle |
設定値の条件
- リクエストは全体を適用するか、変更せずに
success: falseを返します。 - 値は有限で、設定された範囲内である必要があります。速さの上下限は0以上、角度の範囲は水平±π以内、垂直±π/2以内です。
- モデル設定は全体と各深度層に適用されます。各層の平均値は維持するため、新しい範囲にもすべての平均値が収まる必要があります。
layerは0から数えます。ROSのnoiseはSDFのnoiseAmpに対応します。
潮流データを使う
<tidal_oscillation>にCSV、またはM2/S2/N2などの分潮、上げ潮・下げ潮の流向、開始時刻(GMT)を設定します。分潮の例では、振幅はm、位相は度、角速度は度/時です。海流サービスの角度はラジアンなので区別してください。
潮流モードでは、計算した分潮信号、またはCSVの速度を100で割った値に、水深プロファイルの第1列を掛けます。例の高さ振幅は数値係数として使われ、潮位を流速に変換するモデルではありません。目的の流速に合わせて信号とプロファイルの組み合わせを校正してください。
潮流CSVは見出し1行とYYYY-MM-DD HH:MM,event,speed形式のデータ行で構成します。
- イベントは
flood、ebb、slack。速度は有限のcm/s値です。読み飛ばすslack行では-も使えます。 - 日付は有効で、厳密に時刻が増加する順に並べます。
- 正負が交互になるピークを少なくとも2つ保持します。時刻範囲外では最初または最後のピーク値を使います。
- ファイルの欠落、設定不足、不正なデータがあると、ワールドの海流プラグインを無効にします。
これらは実験の入力データです。単位、補間範囲、ワールドの原点、時刻の基準をそろえてください。同じ初期姿勢から流速と機体の動きを比較します。
海流と機体の応答









図・動画:POSIM Notion Wiki。DAVEの出典は引用とライセンスを参照してください。コマンドとトピック名はこのページの記載を使用します。