関数TF_initialize_surface マニュアル

(The documentation of function TF_initialize_surface)
Last Update: 2023/12/12


◆機能・用途(Purpose)

struct TF_surface型構造体 のメモリ確保と初期化を行う。
Allocate dynamic memory for a struct TF_surface-type structure and initialize it.

◆形式(Format)

#include "waterPML_sub/topography.h"
inline struct TF_surface TF_initialize_surface
(const struct waterPML_parameters parameters)


◆引数(Arguments)

parameters 関数TF_set_parameters によってメンバの値の設定を済ませた構造体。
A structure whose members were set by function TF_set_parameters.


◆戻り値(Return value)

以下のメンバを持つ構造体。
A structure composed of the following members.
メンバ
Member 		値
Value
N[0] パラメータNxの値(\(N_x\))。
The value of parameter Nx (\(N_x\)).
N[1] パラメータNyの値(\(N_y\))。
The value of parameter Ny (\(N_y\)).
x0[0] \(x_0+\Delta x/2\)であり、 物理領域内の格子セル中心点の中で最小の\(x\)座標を表す。
\(x_0+\Delta x/2\), which represents the minimum \(x\)-coordinate among the centers of grid cells in the physical volume.
x0[1] \(y_0+\Delta y/2\)であり、 物理領域内の格子セル中心点の中で最小の\(y\)座標を表す。
\(y_0+\Delta y/2\), which represents the minimum \(y\)-coordinate among the centers of grid cells in the physical volume.
dx[0] パラメータdxの値(\(\Delta x\))。
The value of parameter dx (\(\Delta x\)).
dx[1] パラメータdyの値(\(\Delta y\))。
The value of parameter dy (\(\Delta y\)).
elevation \(N_x\times N_y\)の2次元配列として動的メモリを確保する。 配列要素の値は設定しない。
A dynamic memory for \(N_x\times N_y\) 2-D array is allocated, but the values of array components are not set in this function.
n2 \(N_x\times N_x\)の2次元配列として動的メモリを確保し、 全ての配列要素の値を\(-1\)にする。
A dynamic memory for \(N_x\times N_y\) 2-D array is allocated, and \(-1\) is set for the values of all array components.