WEC-Sim2 Overview 訳
佐賀大学
今井康貴(imaiy@cc.saga-u.ac.jp)
This section provides an overview of the WEC-Sim work flow.
この章では，WEC-Sim の作業の流れを説明する．
First, the WEC-Sim file structure is described; then, steps for setting up and running the WEC-Sim
code are described.
まず，WEC-Sim のファイル構造を示す．WEC-Sim のコードを設定し，実行手順を説明する．
The WEC-Sim workflow diagram is shown below.
WEC-Sim のワークフローを以下に示す．
A description of this workflow is provided in the following sections.
このワークフローは以下の章で説明される．
For information about the implementation and structure of the WEC-Sim source code, refer to theCode Structure section.
WEC-Sim のソースコードの実装および構成の詳細は，Code Structure 章を参照のこと．

WEC-Sim Workflow Diagram
WEC-Sim の実行手順
WEC-Sim Model Files
WEC-Sim のモデルファイル
All files required for a WEC-Sim simulation must be contained within a case directory referred toas $CASE.
WEC-Sim のシミュレーションに必要なすべてのファイルは，$CASE と呼ばれるディレクトリに入れる．
This directory can be located anywhere on your computer.
このディレクトリは，コンピュータ上の任意の場所に配置できる
The table below list the WEC-Sim case directory structure and required files.
下の表に WEC-Sim ケースのディレクトリ構造と必要なファイルを示す
File Type
File NameDirectory
Input FilewecSimInputFile.m$CASE
1

Simulink Model
Hydrodynamic Data
Geometry File*.slx*.h5*.stl$CASE$CASE/hydroData$CASE/geometry

Input File 入力ファイル
A WEC-Sim input file (wecSimInputFile.m) is required for each run.
WEC-Sim の入力ファイル（wecSimInputFile.m）が必要である．
The input file must be named wecSimInputFile.m and placed within the case directory.
入力ファイルは wecSimInputFile.m という名前でケースディレクトリ内に置く
The main structure of the input file consists of initializing all the objects necessary to run WEC-Sim
simulations, and defining any user specified properties for each object.
入力ファイルは，WEC-Sim のシミュレーションを実行に必要なすべてのオブジェクトを初期化し，各オブジェクトのユーザ指定プロパティを定義する
The input file for each WEC-Sim simulation requires initialization and definition of the simulation
and wave classes, at least one instance of the body class, and at least one instance of the constraint
or PTO classes.
各 WEC-Sim のシミュレーションの入力ファイルは，シミュレーションと波クラスの初期化および定義を必要とする． また，船体クラスの少なくとも 1 つのインスタンス，制約または PTO ク
ラスの少なくとも 1 つのインスタンスを必要とする
For details about WEC-Sim's objects and available properties for each object, refer to the WEC-SimObjects section.
WEC-Sim のオブジェクト詳細と，各オブジェクトに使用可能なプロパティの詳細は，WEC-Simオブジェクトの章を参照のこと
An example WEC-Sim input file is shown below for the OSWEC Tutorial.
OSWEC チュートリアルの WEC-Sim 入力ファイルは以下に示される
Additional examples are provided in the Tutorials section.
さらなる例は，チュートリアルの章で提供される
WEC-Sim is an object oriented code and the input file reflects this.
WEC-Sim はオブジェクト指向のコードで，入力ファイルはこれを反映する
The WEC-Sim input file (wecSimInputFile.m) for the OSWEC initializes and specifies properties
for simulation, body, constraint and pto classes.
OSWEC の WEC-Sim の入力ファイル（wecSimInputFile.m）は初期化し，シミュレーション，船体，制約，PTO クラスのプロパティを規定する．

2%% Simulation Datasimu = simulationClass();simu.simMechanicsFile = 'OSWEC.slx';
simu.startTime = 0;
simu.rampTime = 100;
simu.endTime=400;
simu.dt = 0.01;
simu.CITime = 30;% Initialize simulationClass% Specify Simulink Model File
% Simulation Start Time [s]% Wave Ramp Time [s]% Simulation End Time [s]% Simulation Time-Step [s]% Specify CI Time [s]%% Wave Information% Regular Waves
waves = waveClass('regular');% Initialize waveClass and Specify Type
2.5;
% Wave Height [m]waves.T = 8;
% Wave Period [s]waves.H =%% Body Data
% Flapbody(1) = bodyClass('hydroData/oswec.h5');% Initialize bodyClass for Flap and Specify *.h5 databody(1).geometryFile = 'geometry/flap.stl';% Geometry Filebody(1).mass = 127000;% User-Defined mass [kg]body(1).momOfInertia = [1.85e6 1.85e6 1.85e6]; % Moment of Inertia [kg-m^2]% Basebody(2) = bodyClass('hydroData/oswec.h5');% Initialize bodyClass for Basebody(2).geometryFile = 'geometry/base.stl';% Geometry Filebody(2).mass = 'fixed';% Creates Fixed Body%% PTO and Constraint Parameters% Fixedconstraint(1)= constraintClass('Constraint1');
constraint(1).loc = [0 0 -10];% Rotational PTO
pto(1) = ptoClass('PTO1');
pto(1).k = 0;
pto(1).c = 0;
pto(1).loc = [0 0 -8.9];% Initialize constraintClass for Constraint1% Constraint Location [m]% Initialize ptoClass for PTO1
% PTO Stiffness [Nm/rad]% PTO Damping [Nsm/rad]% PTO Location [m]3Simulink Model Simulink モデル
In addition to an input file, all WEC-Sim runs require a Simulink model file (*.slx).
入力ファイルに加え，すべての WEC-Sim シミュレーションは Simulink モデルファイル (* .slx)を必要とする．
An example Simulink model file for the OSWEC is shown below.
たとえば，OSWEC の Simulink モデルファイルを以下に示す．
For more information about the OSWEC, and how to build WEC-Sim Simulink models, refer to theTutorials section.
OSWEC の詳細，WEC-Sim の Simulink モデルの構築方法は Tutorial 章を参照のこと

Hydrodynamic Data
流体力データThe WEC-Sim code also requires a hydrodynamic data from a BEM solution in the form of a *.h5file.
WEC-Sim のコードは BEM ソルバの流体力データが*.h5 ファイルの形で必要である．
This *.h5 hydrodynamic data file can be generated using the BEMIO pre-processor.
この *.h5 流体力データファイルは BEMIO プリプロセッサを使用して生成する
BEMIO (Boundary Element Method Input/Output) is a code developed by the WEC-Sim team toprocess BEM output files from WAMIT, NEMOH, and AQWA into a data structure than can beread by WEC-Sim.
BEMIO（境界要素法の入力/出力）は WEC-Sim のチームによって開発されたコードである．
WAMIT，NEMOH，AQWA の BEM 出力ファイルを WEC-Sim で読み取ることができるよう処理する
For more information about the BEMIO pre-processor, refer to the BEMIO section.
BEMIO 前処理の詳細は，BEMIO の章を参照のこと
Geometry Fileジオメトリファイル（形状ファイル）
The WEC-Sim code also requires a geometry file in the form of a *.stl file.
WEC-Sim のコードは*.stl 形式のジオメトリファイルが必要である．
This *.stl file is used by the WEC-Sim code to generate the Simscape Explorer visualization, and by
non-linear hydrodynamics to determine the instantaneous wetted surface at each time step.
4

WEC-Sim コードは*.stl ファイルを使用して Simscape Explorer の視覚化を生成する
また，非線形流体力コードは各時間ステップの瞬時没水表面を決定する
When running WEC-Sim with linear hydrodynamics, the *.stl is only used for visualization.
線形流体力で WEC-Sim を実行する場合，*.stl を可視化のみに使用する
However, when running WEC-Sim with non-linear hydrodynamics, the quality of the *.stl mesh is
critical, refer to the Non-Linear Hydrodynamics section for more information.
しかし，非線形流体力で WEC-Sim を実行する場合，*.stl メッシュの品質が重要である.
Non-Linear Hydrodynamics 章を参照のこと
Running WEC-SimWEC-Sim 実行
This section provides a description of the steps to run the WEC-Sim code, refer to the WEC-Sim
workflow diagram while following the steps to run WEC-Sim.
この章は WEC-Sim のコードの実行手順の説明する．
WEC-Sim を実行するため，手順に従いながら WEC-Sim ワークフロー図を参照のこと
Step 1: WEC-Sim Pre-Processing
ステップ 1：WEC-Sim の前処理
In the pre-processing step, users need to create the WEC geometry, run a BEM code to calculate
the hydrodynamic coefficients, and convert the hydrodynamic coefficients into the *.h5 format for
WEC-Sim to read:
前処理ステップでは，WEC ジオメトリを作成し，流体力係数を計算するため BEM コードを実行する．得られた流体力係数を WEC-Sim が読込めるよう *.h5 フォーマットに変換する
WEC Geometry: Create 3D models of the WEC geometry and generate a meshes for each body.
WEC ジオメトリ：WEC ジオメトリの 3D モデルを作成し，各船体のメッシュを生成する．
Export the WEC geometry file to a *.stl format.
WEC ジオメトリファイルを*.stl フォーマットにエクスポートする．
*.stl files are used to visualize the WEC response in Simscape Explorer, and they are used for NonLinear Hydrodynamics.
*.stl ファイルは Simscape エクスプローラで WEC 応答の可視化に使用される．
また，非線形流体力計算に使用される
Hydrodynamic Data: WEC-Sim requires frequency-domain hydrodynamic coefficients (e.g. addedmass, radiation damping, and wave excitation) in the form of a *.h5 file.
流体力データ：WEC-Sim は 周波数領域の流体力係数（付加質量，放射減衰，波強制力）を*.h5
ファイルの形で必要とする．
The hydrodynamic coefficients for each body may be generated using a boundary element method(BEM) code and parsed into a *.h5 data structure using BEMIO.
各船体の流体力係数は，境界要素法（BEM）コードで生成され，BEMIO で *.h5 データ構造に変換される．
BEMIO was developed by the WEC-Sim team to parse BEM solutions from WAMIT, NEMOH andAQWA into the format required by WEC-Sim.
BEMIO は WEC-Sim のチームによって開発され，WAMIT，NEMOH，AQWA の BEM 出力をWEC-SIM で必要な形式に変換する．
Note
注意
WEC-Sim requires that all hydrodynamic coefficients must be given at the center of gravity for eachbody.
WEC-Sim は，流体力係数が各船体の重心に与えることを要求する．
If WAMIT is used, the center of gravity for each body must be at the origin of the body coordinate5system (XBODY).
WAMIT の場合，各体の重心は船体座標系（XBODY）の必要がある
More details on WAMIT setup are given in the WAMIT User Manual.
WAMIT 設定の詳細は，WAMIT ユーザーマニュアルに記載される
Users are able to specify their own hydrodynamic coefficients by creating their own *.h5 file withcustomized hydrodynamic coefficients following *.h5 format created by BEMIO.
ユーザーは，カスタマイズされた流体力係数で，独自の流体力係数を指定できる．
BEMIO によって作成された *.h5 形式に従う独自の *.h5 ファイルを作成する．
Step 2: Build WEC-Sim Simulink Modelステップ 2：WEC-Sim Simulink モデルの構築
In this step, users build their WEC-Sim Simulink model (*.slx) using the WEC-Sim Librarydeveloped in Simulink/Simscape.
このステップでは，Simulink/Simscape の WEC-Sim のライブラリを使用して，WEC-Sim のSimulink モデル(*.slx)を構築する
The *.slx Simulink model file must be located in the $CASE directory.
*.slx モデルファイルは，$CASE ディレクトリに置く
The figure below shows an example WEC-Sim Simulink model for the OSWEC tutorial.
以下の図は，OSWEC チュートリアルの Simulink モデルを示す

Step 3: Write WEC-Sim Input File
ステップ 3：WEC-Sim 入力ファイルの作成
The WEC-Sim input file must be located in the $CASE directory, and named wecSimInputFile.m.
WEC-Sim の入力ファイルは，wecSimInputFile.m と名付け$CASE ディレクトリに置く
The figure below shows an example of a WEC-Sim input file.
以下の図は，WEC-Sim の入力ファイルの例を示す
The input file specifies the simulation settings, body mass properties, wave conditions, joints, andmooring.
入力ファイルは，シミュレーション設定，船体質量特性，波の条件，ジョイント，係留を指定する．
Additionally, the WEC-Sim input file must specify the location of the WEC-Sim Simulink model(*.slx) file, the geometry file(s) *.stl, and the hydrodynamic data file (*.stl) .
6

また，WEC-Sim の入力ファイルは，WEC-Sim の Simulink モデル(*.slx)，ジオメトリファイル(*.STL)，流体力データファイル(*.h5)の場所を記述する

Step 4: Execute WEC-Sim
ステップ 4：WEC-Sim の実行
Lastly, execute the WEC-Sim code by typing wecSim into the MATLAB Command Window.
MATLAB コマンドウィンドウに wecSim を入力して，WEC-Sim を実行する．
The WEC-Sim source code is located in the $Source directory, but wecSim must be executed fromthe $CASE directory.
WEC-Sim のソースコードは$Source にあるが，wecSim は $CASE で実行する
Note
注意
WEC-Sim simulations should always be executed from the MATLAB Command Window, not fromthe Simulink/SimMechanics model.
WEC-Sim シミュレーションは常に MATLAB コマンドウィンドウで実行する．
Simulink/SimMechanics モデルで実行しない．

7