関数TF_initialize_stg マニュアル

(The documentation of function TF_initialize_stg)
Last Update: 2023/8/7


◆機能・用途(Purpose)

struct grid型構造体stgのメンバNg, Nvの値の設定と メンバindexの動的メモリの確保を行う。
Set the values of members Ng and Nv and allocate dynamic memory for member index of a struct grid-type structure stg.

◆形式(Format)

#include "waterPML_sub/setstg.h"
inline struct grid TF_initialize_stg
(const struct waterPML_parameters parameters)


◆引数(Arguments)

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


◆戻り値(Return value)

メンバNg, Nv, indexの値を以下のように設定した構造体。
A structure whose members Ng, Nv, and index were set as below.
メンバ
Member 		値
Value
Ng parameters.NN[0]∗parameters.NN[1]∗parameters.NN[2]

これは計算領域における 半格子点の総数を表す。
This value represents the total number of half-grid nodes in the computational volume.
Nv stg_Nv_no_f +parameters.Nsource∗3

これは地震波動ソースを含めて 変数番号 が取りうる値の総数である。
This is the total number of the possible values of an index of variable including the seismic wave source.
index Ng×Nvの2次元配列として動的メモリの確保のみを行う (配列要素の値は設定しない)。
Allocate the dynamic memory for a 2-D array of Ng×Nv without setting the values for the array components.