関数TF_set_and_initialize_V マニュアル

(The documentation of function TF_set_and_initialize_V)
Last Update: 2024/2/20


◆機能・用途(Purpose)

速度場の代入先の配列を用意し、その配列要素番号 ( 方法3-2) が半格子点の通し番号 ( 方法2) から得られるように struct grid型構造体stgのメンバindexの値を設定する。 また、速度場の初期値を設定する。
Allocate dynamic memory for an array to represent the velocity field, and define its array index ( method 3-2) for each consecutive index of a half-grid node ( method 2) by setting the values of member index of a struct grid-type structure stg. Set the initial values of the velocity field.

◆形式(Format)

#include "waterPML_sub/setstg.h"
inline double ∗∗∗TF_set_and_initialize_V
(const struct waterPML_parameters parameters,
 char ∗const ∗type,struct grid stg)


◆引数(Arguments)

parameters 関数 TF_set_parameters, TF_read_stations, TF_count_snapshot によってメンバの値の設定を済ませた構造体。
A structure whose members were set by functions TF_set_parameters, TF_read_stations, and TF_count_snapshot.
type 関数TF_set_type, TF_set_material_type によって値を設定した 2次元配列type。
A 2-D array type whose values have been set by functions TF_set_type and TF_set_material_type.
stg 関数 TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index, TF_set_mu_index, TF_set_alpha_index, TF_set_c, TF_set_f, TF_read_stations によって値を設定した構造体。 関数内でメンバindexの速度場に対応する配列要素の 設定が行われる。
A structure whose values have been given by functions TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index, TF_set_mu_index, TF_set_alpha_index, TF_set_c, TF_set_f, and TF_read_stations. The values of array components of member index corresponding to the velocity field are determined in this function.


◆戻り値(Return value)

速度場\(V_i^k(\posx)\)の値を並べた3次元配列。 第1引数は\(i\)、第2引数は\(k\)、第3引数は位置を表す。 配列の値としては初期値\(V_i^k(\posx)=0\)を設定する。 但し、パラメータuse_prevの値をyesにした場合は 前回の計算の最終時刻での値を読み込み、 これを\(V_i^k(\posx)\)の初期値とする。
A 3-D array that represents the velocity field \(V_i^k(\posx)\). The 1st to 3rd arguments of the array are \(i\), \(k\), and the location, respectively. For the values of the array components, \(V_i^k(\posx)=0\) is set as an initial value; however, if the value of parameter use_prev is yes, the velocity field at the last time step in the previous computation is read and used as the initial \(V_i^k(\posx)\) values instead.