関数TF_check_parameters マニュアル

(The documentation of function TF_check_parameters)
Last Update: 2022/8/31


◆機能・用途(Purpose)

パラメータ一式をチェックする。 但し地下構造と観測波形の読み込み後でないとチェックできない パラメータを除く。
Check the parameters, except for those which cannot be checked before reading the subsurface structure and observed waveform.

◆形式(Format)

#include "FDM_1D_vertical_sub/parameters.h"
inline void TF_check_parameters
(const struct TF_flag flag,const struct TF_parameters parameters)


◆引数(Arguments)

flag 関数TF_initialize_flag, TF_read_parametersを用いて 値を設定したフラグ一式。
Flags set by functions TF_initialize_flag and TF_read_parameters.
parameters 関数TF_read_parametersを用いて値を設定したパラメータ一式。
Parameters set by function TF_read_parameters.


◆チェックの内容(List of checks)

以下の要件を満たさない場合はエラーとなる。
An error is issued if the following requirements are not met.
パラメータ
Parameter 		チェックの内容
List of checks
structure_file_format
  • (指定された場合) 正しい値(「stratified」または「linear」)になっているか?
    (When specified) whether the value is correct (“stratified” or “linear”).
structure_file
  • 指定されたか?
    Whether specified.
station_z
  • 指定されたか?
    Whether specified.
inputfile
  • 指定されたか?
    Whether specified.
  • 拡張子が「.sac」「.seq1」「.seq2」「.bseq」 のいずれかになっているか?
    Whether the extension is one of “.sac”, “.seq1”, “.seq2”, or “.bseq”.
outputfile
  • 指定されたか?
    Whether specified.
  • 拡張子が「.seq1」「.seq2」「.bseq」 のいずれかになっているか?
    Whether the extension is one of “.seq1”, “.seq2”, or “.bseq”.
outputfile_station
  • (指定された場合) 拡張子が「.seq1」「.seq2」「.bseq」 のいずれかになっているか?
    (When specified) whether the extension is one of “.seq1”, “.seq2”, or “.bseq”.


◆補足(Additional remarks)

パラメータdz, dt, dt_snapshot, tmaxtのチェックは別の関数において行われる。
Checks for parameters dz, dt, dt_snapshot, and tmax are conducted by other functions.