関数TF_write_snapshot マニュアル

(The documentation of function TF_write_snapshot)
Last Update: 2024/2/22


◆機能・用途(Purpose)

速度場のスナップショットを出力する。
Output a snapshot of the velocity field.

◆形式(Format)

#include "waterPML_sub/write.h"
inline void TF_write_snapshot
(const struct grid stg,const struct waterPML_parameters parameters,
 const struct TF_snapshot ∗snapshot_init,
 const struct TF_surface solid_surface,
 const struct TF_surface water_surface,
 double ∗∗const ∗V,const double t)


◆引数(Arguments)

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, TF_set_and_initialize_V, TF_set_and_initialize_T によって値を設定した構造体。
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, TF_read_stations, TF_set_and_initialize_V, and TF_set_and_initialize_T.
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.
snapshot_init 出力するスナップショットの設定が格納された構造体から成る配列。 関数TF_read_snapshot_initの戻り値を与える。
An array of structures composed of the configurations of the snapshots to output. Use the return value of function TF_read_snapshot_init.
solid_surface 関数 TF_initialize_surface, TF_set_solid_surface_from_structure, TF_set_solid_surface_from_3d によって設定を済ませた地表面。
The ground surface determined by functions TF_initialize_surface, TF_set_solid_surface_from_structure, and TF_set_solid_surface_from_3d.
water_surface 関数 TF_initialize_surface, TF_set_water_surface, TF_check_and_correct_surface によって設定を済ませた水面。
The water surface determined by functions TF_initialize_surface, TF_set_water_surface, and TF_check_and_correct_surface.
V 波形を出力したい時刻における速度成分\(V_i^k\)を並べた3次元配列。 第1引数は\(i\)、第2引数は\(k\)であり、 第3引数は位置を表す\(V_i^k\)用の 通し番号(位置の表現方法3-2) である。
A 3-D array composed of the velocity components \(V_i^k\) at the time to output. The 1st argument is \(i\), the 2nd is \(k\), and the 3rd is the consecutive index (method 3-2) that represents a location for \(V_i^k\).
t 出力するスナップショットの時刻。 出力ファイル名の一部として用いられる。
The time of the snapshot to output, used as a part of the output file name.


◆動作(Behaviour)

引数Vで与えた速度場\(V_i^k\)の スナップショット を出力する。
Output the snapshot of the velocity field \(V_i^k\) given by argument V.