The documentation of “tws/waterPML.h”

tws/waterPML.h マニュアル

(The documentation of tws/waterPML.h)

Last Update: 2022/2/24

tws/waterPML.hでは waterPMLコマンド(opentwsサブパッケージ)用の処理を行う関数が定義されている。通常、ymaeda_opentoolsでは特定のコマンドでしか使用しない関数はそのコマンドのソースコード内で定義しているが、 waterPMLコマンドの場合には依存関係により共通ヘッダファイルで定義しなければならない関数がいくつかあり、それらをこのヘッダファイルにまとめてある。
Functions to perform processings for waterPML command (opentws subpackage) are defined in tws/waterPML.h. Normally, in ymaeda_opentools, functions that are used exclusively from a single command are defined in the source codes of the command. However, in case of waterPML command, several functions must be defined in common header files because of dependency. Therefore, functions that are used exclusively by waterPML command but must be defined in common header files are defined in this header file.

このヘッダファイル内で定義されている関数を以下に示す。各関数の詳細は関数名をクリックしてリンク先を参照のこと。
Functions defined in this header file are listed below. For details of individual functions, click the links.

関数名 Function name	機能・用途 Purpose
waterPML_get_absolute_z 【マニュアル未作成】 [The documentation has yet to be created]	地表面からの深さで指定された\(z\)座標を標高に変換する。 Convert a \(z\)-coordinate, specified in the form of the depth from the ground surface, to an elevation.
waterPML_coordinate2ig	座標を半格子点の通し番号に変換する。 Convert a coordinate to a consecutive index of the corresponding half-grid node.
waterPML_diffgrid 【マニュアル未作成】 [The documentation has yet to be created]	ある場所から特定の方向に特定の長さだけ移動した地点における半格子点の通し番号を計算する。 Compute the consecutive index of a half-grid node obtained by moving a specified distance along a specified direction from a specified location.