関数TF_autoset_parameters マニュアル

(The documentation of function TF_autoset_parameters)
Last Update: 2021/7/8


◆機能・用途(Purpose)

省略されたパラメータの自動設定および 未チェックのパラメータのチェックを行う。
Conduct automatic settings of omitted parameters and checks of all the un-checked parameters.

◆形式(Format)

#include "parameters.h"
inline void TF_autoset_parameters
(const struct TF_flag flag,const struct TF_subsurface_structure structure,
 const struct sequence waveform,struct TF_parameters *parameters)


◆引数(Arguments)

flag 関数TF_initialize_flag, TF_read_parametersを用いて 値を設定したフラグ一式。
Flags set by functions TF_initialize_flag and TF_read_parameters.
structure 関数TF_read_subsurface_structureを用いて読み込んだ地下構造。
A subsurface structure read using function TF_read_subsurface_structure.
waveform 関数TF_read_waveformを用いて読み込んだ観測波形。
An observed waveform read using function TF_read_waveform.
parameters 関数TF_read_parametersを用いて設定、 関数TF_check_parametersを用いてチェックしたパラメータ一式 を表す構造体のアドレスを与える。 この関数内で追加の設定とチェックが行われる。
Give the address of the structure which represents parameters set by function TF_read_parameters and checked by function TF_check_parameters. Within this function, additional parameters are set and additional checks are conducted.


◆動作(Behaviour)

引数parametersが表す構造体の各メンバに対して 関数内で以下の設定とチェックが行われる。
For each member of the structure pointed by argument parameters, this function performs the following settings and checks.
メンバ名
Member name 		設定
Settings 		チェック
Checks
structure_linear
  • パラメータstructure_file_formatの省略時:
    When the parameter structure_file_format was omitted:
     false

  • structure_file_format=stratifiedの場合:
    When structure_file_format=stratified:
     false

  • structure_file_format=linearの場合:
    When structure_file_format=stratified:
     true

  
station_z  
  • 地表面(structure.z[0])よりも標高が低いか?
    Whether the elevation is below the ground surface represented by structure.z[0].

  • structure_file_format=linearの場合:
    When structure_file_format=linear:
    地下構造の定義域内に収まっているか?
    Whether the station altitude is within the definition range of the subsurface structure.

h structure.z[0]-(∗parameters).station_z  
dz パラメータdzの省略時:
When the parameter dz was omitted:
読み込んだ速度構造(引数structure)、波形の時間刻み(引数waveform)、 地表面と観測点の標高差(上記のメンバh) に基づいてパラメータdzのデフォルト値が計算・設定される。
The default value of parameter dz is calculated and set, referring to the velocity structure (argument structure), the time stepping of the waveform (argument waveform), and the elevation difference between the ground surface and the station (member h given above). 		パラメータdzの指定時:
When the parameter dz was specified:
  • dz\(>0\)であるか?
    Whether dz\(>0\).

  • 観測点を速度定義点とした場合に地表が応力定義点となるか? すなわち地表と観測点の標高差をdzで割ると整数\(+1/2\)になるか?
    Whether the ground surface is a stress definition point when the station is set as a velocity definition point, i.e., whether dividing the elevation difference between the ground surface and station divided by dz is an integer \(+1/2\).

Nz 上記のメンバhとdzを元に\(z\)方向の格子点数が計算・設定される。
The number of grid nodes in the \(z\)-direction is calculated and set based on the members h and dz given above. 		 
dt パラメータdtの省略時:
When the parameter dt was omitted:
読み込んだ速度構造(引数structure)、波形の時間刻み(引数waveform)、 上記のメンバdzの値に基づいて パラメータdtのデフォルト値が計算・設定される。
The default value of parameter dt is calculated and set, referring to the velocity structure (argument structure), the time stepping of the waveform (argument waveform), and the value of member dz given above. 		パラメータdtの指定時:
When the parameter dt was specified:
  • dt\(>0\)であるか?
    Whether dt\(>0\).

  • 速度構造(引数structure)とメンバdzの値から決まる最大値 の範囲内に収まっているか?
    Whether the value is less than the maximum possible value determined by the velocity structure (argument structure) and the value of member dz.

  • 観測波形(引数waveform)の時間刻みの整数分の1になっているか?
    Whether the value is a divisor of the time stepping of the observed waveform (argument waveform).

dt_snapshot パラメータoutputdir_snapshotの未指定時:
When the parameter outputdir_snapshot was not specified:
何もしない。
Do nothing.

パラメータoutputdir_snapshotの指定時:
When the parameter outputdir_snapshot was specified:
パラメータdt_snapshotの省略時:
When the parameter dt_snapshot was omitted:
観測波形(引数waveform)の時間刻みが代入される。
The value is set as the sampling interval of the observed waveform given by argument waveform. 		パラメータdt_snapshotの指定時:
When the parameter dt_snapshot was specified:
  • dt_snapshot\(>0\)であるか?
    Whether dt_snapshot\(>0\).

  • dt_snapshotはパラメータdtの整数倍になっているか?
    Whether dt_snapshot is an integer multiple of parameter dt.

tmax パラメータtmaxの省略時:
When the parameter tmax was omitted:
観測波形(引数waveform)の長さが代入される。
The value is set as the length of the observed waveform given by argument waveform. 		パラメータtmaxの指定時:
When the parameter tmax was specified:
  • メンバdtの値以上になっているか?
    Whether the value is greater than or equal to that of member dt.

  • 観測波形(引数waveform)の長さ以下になっているか?
    Whether the value is less than or equal to the length of the observed waveform given by argument waveform.

Nt 上記のメンバtmax, dtを元に計算の時間ステップ数が計算・設定される。 時刻\(t=0\)を含めたステップ数となる。 パラメータtmaxがdtで割り切れない場合には切り上げる (tmaxよりも長く計算する)。
The number of time steps is calculated and set based on the members tmax and dt given above. Time \(t=0\) is included into the count of the number of steps. If the parameter tmax cannot be divided by dt, Nt is rounded to the greater value so that the actual time length of the calculation is longer than the value of tmax. 		 
snapshot_output_interval パラメータoutputdir_snapshotの指定時:
When the parameter outputdir_snapshot was specified:
パラメータの比snapshot_dt/dtが このメンバの値として計算・設定される。
The ratio of parameters snapshot_dt/dt is calculated and set as the value of this member. 		 
snapshot_time_digits パラメータoutputdir_snapshotの指定時:
When the parameter outputdir_snapshot was specified:
パラメータsnapshot_dtの小数点以下の桁数が このメンバの値として計算・設定される。
The number of decimal digits of parameter snapshot_dt is calculated and set as the value of this member.