関数TF_get_section_z マニュアル

(The documentation of function TF_get_section_z)
Last Update: 2024/2/8


◆機能・用途(Purpose)

物理領域内の各格子セル中心点の\((x,y)\)において、 地下構造の設定に登場する各小領域の境界面の\(z\)座標をリストアップする。
List the \(z\)-coordinates on the boundary planes of each subdomain in the configuration of a subsurface structure at each \((x,y)\) of the centers of grid cells in the physical volume.

◆形式(Format)

#include "waterPML_sub/set_structure.h"
inline struct TF_section ∗∗∗TF_get_section_z
(const struct waterPML_parameters parameters,
 const struct TF_points pointList,const struct TF_planes planeList,
 const struct TF_subdomains subdomainList)


◆引数(Arguments)

parameters 関数TF_set_parameters によってメンバの値の設定を済ませた構造体。
A structure whose members were set by function TF_set_parameters.
pointList 関数TF_read_points を用いて読み込んだ点のリスト。
A list of points obtained by function TF_read_points.
planeList 関数TF_read_planes を用いて読み込んだ面のリスト。
A list of planes obtained by function TF_read_planes.
subdomainList 関数TF_read_subdomains, TF_correct_subdomains を用いて読み込んだ小領域のリスト。
A list of subdomains obtained by functions TF_read_subdomains and TF_correct_subdomains.


◆戻り値(Return value)

物理領域内の各格子セル中心点の\((x,y)\)における、 地下構造の設定に登場する各小領域の境界面の\(z\)座標を並べた3次元配列。 配列の第1引数は小領域番号、 第2引数は\(x\)方向の格子セル番号、 第3引数は\(y\)方向の格子セル番号とする。
A 3-D array composed of the \(z\)-coordinates on the boundary planes of each subdomain in the configuration of a subsurface structure at each \((x,y)\) of the centers of grid cells in the physical volume. The 1st to 3rd arguments of the array are an index of subdomain, an index of grid cells along the \(x\)-direction, and that along the \(y\)-direction, respectively.