関数TF_judge_subdomain マニュアル

(The documentation of function TF_judge_subdomain)
Last Update: 2024/2/9


◆機能・用途(Purpose)

物理領域内の各格子セル中心点が 地下構造の設定に登場する各小領域の内部か否かを判定する。
Identify whether the center of each grid cell in the physical volume is inside or outside of each subdomain in the configuration of a subsurface structure.

◆形式(Format)

#include "waterPML_sub/set_structure.h"
inline _Bool ∗∗TF_judge_subdomain
(const struct waterPML_parameters parameters,
 const struct TF_subdomains subdomainList,
 truct TF_section ∗∗const ∗section_list)


◆引数(Arguments)

parameters 関数TF_set_parameters によってメンバの値の設定を済ませた構造体。
A structure whose members were set by function TF_set_parameters.
subdomainList 関数TF_read_subdomains, TF_correct_subdomains を用いて読み込んだ小領域のリスト。
A list of subdomains obtained by functions TF_read_subdomains and TF_correct_subdomains.
section_list 関数TF_get_section_z を用いて作成した小領域境界面の\(z\)座標のリスト。
A list of the \(z\)-coordinates of the boundary planes of subdomains created by function TF_get_section_z.


◆戻り値(Return value)

判定結果を並べた2次元配列。 配列の第1引数は小領域の番号、第2引数は格子セルの番号(※)とし、 igc番目の格子セルの中心点がisd番目の小領域の内部の点であれば 戻り値の[isd][igc]成分がtrue、外部の点であればfalseとなる。
A 2-D array composed of the result of identification. The 1st argument of the array represents an index of a subdomain, and the 2nd does an index of a grid cell (∗). The [isd][igc] component of the return value is true if the center of igcth grid cell is inside the isdth subdomain, and false if it is outside the subdomain.
※格子セルの番号は物理領域内の全ての格子セルに対して一意的に割り当てた連続番号であり、 半格子点の通し番号 と考え方は同じである。 但し、半格子点ではなく格子セルに対して割り当てた番号となる。
∗ The index of a grid cell is a consecutive number that is uniquely assigned to all grid cells in the physical volume. It is similar to a consecutive index of half-grid nodes except that the numbers are assigned to grid cells instead of half-grid nodes.