関数waterPML_coordinate2ig マニュアル

(The documentation of function waterPML_coordinate2ig)

Last Update: 2024/2/21

◆機能・用途(Purpose)

座標を半格子点の通し番号に変換する。
Convert a coordinate to a consecutive index of the corresponding half-grid node.

◆形式(Format)

#include <tws/waterPML.h>
inline int waterPML_coordinate2ig
(const double ∗x,const struct waterPML_parameters parameters,
const char ∗place)

◆引数(Arguments)

x	変換したい座標。 $x$ , $y$ , $z$ 座標の3要素から成る配列で与える。 The coordinate to convert, given as an array of 3 components that represent the $x$ -, $y$ -, and $z$ -components.
parameters	waterPMLコマンドで使用するパラメータ一式を格納した構造体。 A structure composed of the parameters used by waterPML command.
place	座標の近似方法。格子セルの中心点で近似する場合は「c」、 2つの格子セルが接する境界で近似する場合は「b」とし、これを $x$ , $y$ , $z$ 方向について並べた 3文字から成る文字列として与える。 An approximation method for the coordinate. Use “c” to approximate the coordinate by the center of a grid cell; “b” to approximate it by the boundary between two grid cells. Deploy these characters for $x$ -, $y$ -, and $z$ -directions to make a string composed of three characters.

◆戻り値(Return value)

引数xで与えた座標を引数placeで指定した場所で近似した位置における半格子点の通し番号。
The consecutive index of the half-grid node at the coordinate given by argument x approximated based on argument place.

◆使用例(Example)

struct waterPML_parameters parameters;
double x[]={12.3,456.7,-8901.2};
int ig=waterPML_coordinate2ig(x,parameters,"ccb");