関数TF_set_parameters マニュアル

(The documentation of function TF_set_parameters)
Last Update: 2024/3/7


◆機能・用途(Purpose)

コマンドライン引数からパラメータを読み込んでチェックを行い、 struct waterPML_parameters型構造体にパラメータの値を保存する。
Read the command-line arguments, check them, and preserve the values of parameters to a struct waterPML_parameters-type structure.

◆形式(Format)

#include "waterPML_sub/set_parameters.h"
inline struct waterPML_parameters TF_set_parameters
(const int ARGC,char ∗const ∗ARGV)


◆引数(Arguments)

ARGC コマンドライン引数の個数(関数mainの第1引数)。
The number of command-line arguments (the 1st argument of function main).
ARGV コマンドライン引数のリスト(関数mainの第2引数)。
A list of command-line arguments (the 2nd argument of function main).


◆戻り値(Return value)

メンバの値を以下のように設定した構造体。
A structure whose members were set as below.
メンバ
Member 		値
Value
N[0] パラメータNxの値(\(N_x\))。
The value of parameter Nx (\(N_x\)).
N[1] パラメータNyの値(\(N_y\))。
The value of parameter Ny (\(N_y\)).
N[2] パラメータNzの値(\(N_z\))。
The value of parameter Nz (\(N_z\)).
Np[0][0] パラメータNpmxの値(\(N_{pml}^{-x}\))。
The value of parameter Npmx (\(N_{pml}^{-x}\)).
Np[0][1] パラメータNpmyの値(\(N_{pml}^{-y}\))。
The value of parameter Npmy (\(N_{pml}^{-y}\)).
Np[0][2] パラメータNpmzの値(\(N_{pml}^{-z}\))。
The value of parameter Npmz (\(N_{pml}^{-z}\)).
Np[1][0] パラメータNppxの値(\(N_{pml}^{+x}\))。
The value of parameter Nppx (\(N_{pml}^{+x}\)).
Np[1][1] パラメータNppyの値(\(N_{pml}^{+y}\))。
The value of parameter Nppy (\(N_{pml}^{+y}\)).
Np[1][2] パラメータNppzの値(\(N_{pml}^{+z}\))。
The value of parameter Nppz (\(N_{pml}^{+z}\)).
NN[0] \(2(N_{pml}^{-x}+N_x+N_{pml}^{+x})+1\)で、計算領域内の 半格子点 の数(\(x\)方向)を表す。
\(2(N_{pml}^{-x}+N_x+N_{pml}^{+x})+1\), which represents the number of half-grid nodes (\(x\)-direction) in the computational volume.
NN[1] \(2(N_{pml}^{-y}+N_y+N_{pml}^{+y})+1\)で、計算領域内の 半格子点 の数(\(y\)方向)を表す。
\(2(N_{pml}^{-y}+N_y+N_{pml}^{+y})+1\), which represents the number of half-grid nodes (\(y\)-direction) in the computational volume.
NN[2] \(2(N_{pml}^{-z}+N_z+N_{pml}^{+z})+1\)で、計算領域内の 半格子点 の数(\(z\)方向)を表す。
\(2(N_{pml}^{-z}+N_z+N_{pml}^{+z})+1\), which represents the number of half-grid nodes (\(z\)-direction) in the computational volume.
x0[0] パラメータx0の値(\(x_0\))。
The value of parameter x0 (\(x_0\)).
x0[1] パラメータy0の値(\(y_0\))。
The value of parameter y0 (\(y_0\)).
x0[2] パラメータz0の値(\(z_0\))。
The value of parameter z0 (\(z_0\)).
dx[0] パラメータdxの値(\(\Delta x\))。
The value of parameter dx (\(\Delta x\)).
dx[1] パラメータdyの値(\(\Delta y\))。
The value of parameter dy (\(\Delta y\)).
dx[2] パラメータdzの値(\(\Delta z\))。
The value of parameter dz (\(\Delta z\)).
dt パラメータdtの値(\(\Delta t\))。
The value of parameter dt (\(\Delta t\)).
tmin パラメータtminの値(\(t_{min}\))。
The value of parameter tmin (\(t_{min}\)).
tmax パラメータtmaxの値(\(t_{max}\))。
The value of parameter tmax (\(t_{max}\)).
itmin \(t_{min}/\Delta t\)で、 時刻\(t_{min}\)に対応する時間ステップ番号を表す。
\(t_{min}/\Delta t\), which represents the time step index corresponding to time \(t_{min}\).
itmax \(t_{max}/\Delta t\)で、 時刻\(t_{max}\)に対応する時間ステップ番号を表す。
\(t_{max}/\Delta t\), which represents the time step index corresponding to time \(t_{max}\).
PML_A パラメータPML_Aの値。
The value of parameter PML_A.
PML_n パラメータPML_nの値。
The value of parameter PML_n.
Ntopo 使用する地形データファイルの個数。 パラメータtopography_filesにおけるカンマ(,)の個数\(+1\) として計算される。 パラメータtopography_filesの省略時は0になる。
The number of topography data files used, calculated as the number of commas (,) in the value of parameter topography_files added by 1. When parameter topography_files was omitted, the value of this member is set to be 0.
topography_files 使用する地形データファイル名のリスト。 パラメータtopography_filesの値をカンマ(,)で区切った 文字列の配列(char型2次元配列)。 パラメータtopography_filesの省略時はこのメンバの値は設定されない。
The list of the names of topography data files used; an array of strings (a char-type 2-D array) created by separating the value of parameter topography_files by commas (,). The value of this member is not set when parameter topography_files was omitted.
topography_file_format パラメータtopography_file_formatの値。
The value of parameter topography_file_format.
refN パラメータrefNの値。
The value of parameter refN.
refE パラメータrefEの値。
The value of parameter refE.
topography_interpolation_method パラメータtopography_interpolation_methodの値。
The value of parameter topography_interpolation_method.
Nlake この関数では設定しない。
 Not set in this function.
water_file パラメータwater_fileの値。 パラメータwater_fileの省略時は空文字("")となる。
The value of parameter water_file. When this parameter was omitted, an empty string ("") is set.
structure_file パラメータstructure_fileの値。
The value of parameter structure_file.
structure_file_format パラメータstructure_file_formatの値。
The value of parameter structure_file_format.
source_file パラメータsource_fileの値。
The value of parameter source_file.
Nsource 使用する地震波動ソースの個数。 パラメータsource_fileで指定した設定ファイルを使用し、 関数tws_count_sourceにより設定される。
The number of seismic wave sources to be used, determined by function tws_count_source with the configuration file specified by parameter source_file.
use_reciprocity この関数では設定しない。
 Not set in this function.
output_dir パラメータoutput_dirの値。
The value of parameter output_dir.
station_file パラメータstation_fileの値。
The value of parameter station_file.
Nstation この関数では設定しない。
 Not set in this function.
output_dt パラメータoutput_dtの値(\(\Delta t_{waveform}\))。
The value of parameter output_dt (\(\Delta t_{waveform}\)).
output_Nskip \(\Delta t_{waveform}/\Delta t\)で、 計算の時間ステップの何ステップに1回波形を出力するかを表す。
\(\Delta t_{output}/\Delta t\), which represents the time interval of waveform output measured as the number of time steps of the computation.
snapshot_grid パラメータsnapshot_gridの値。 但し「specify:file=ファイル名」の場合には「:」から後を除いて 単に「specify」とする。
The value of parameter snapshot_grid; however, if the value is “specify:file=file name”, then only the part “specify” is copied to this member skipping the part after “:”.
snapshot_file パラメータsnapshot_gridの値が「specify:file=ファイル名」の場合には そのファイル名。 それ以外の場合はこのメンバの値は設定されない。
If the value of parameter snapshot_grid is “specify:file=file name”, then the file name is copied to this member. In the other cases, the value of this member is not set.
Nsnapshot この関数では設定しない。
 Not set in this function.
snapshot_place パラメータsnapshot_placeの値。
The value of parameter snapshot_place.
snapshot_dt パラメータsnapshot_dtの値(\(\Delta t_{snapshot}\))。
The value of parameter snapshot_dt (\(\Delta t_{snapshot}\)).
snapshot_Nskip \(\Delta t_{snapshot}/\Delta t\)で、 計算の時間ステップの何ステップに1回スナップショットを出力するかを表す。
\(\Delta t_{output}/\Delta t\), which represents the time interval of snapshot output measured as the number of time steps of the computation.
output_parameters パラメータoutput_parametersの値。 yesを真(true)に、noを偽(false)に変換する。
The value of parameter output_parameters, converted as yes to true and no to false.
output_stg パラメータoutput_stgの値。 yesを真(true)に、noを偽(false)に変換する。
The value of parameter output_stg, converted as yes to true and no to false.
tilt_output パラメータtilt_outputの値。
The value of parameter tilt_output.
dimension パラメータdimensionの値。
The value of parameter dimension.
save_final パラメータsave_finalの値。 yesを真(true)に、noを偽(false)に変換する。
The value of parameter save_final, converted as yes to true and no to false.
use_prev パラメータuse_prevの値。 yesを真(true)に、noを偽(false)に変換する。
The value of parameter use_prev, converted as yes to true and no to false.