関数TF_read_parameters マニュアル

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


◆機能・用途(Purpose)

コマンドライン引数からパラメータ一式を読み込む。
Read parameters from command-line arguments.

◆形式(Format)

#include "FDM_1D_vertical_sub/parameters.h"
inline struct TF_parameters TF_read_parameters
(int ARGC,char ∗ARGV[],struct TF_flag ∗flag)


◆引数(Arguments)

ARGC コマンドライン引数の個数。 関数mainの第1引数をそのまま与える。
The number of command-line arguments. Directly use the 1st argument of function main.
ARGV コマンドライン引数のリスト。 関数mainの第2引数をそのまま与える。
List of command-line arguments. Directly use the 2nd argument of function main.
flag 関数TF_initialize_flagを用いて初期化(全メンバを0に設定)を行った フラグ一式を与える。 コマンドライン引数で指定したパラメータについては 対応するメンバの値が関数内で1に変更される。
Give the flags initialized (setting all the members to 0) by function TF_initialize_flag. Within the function, the values of members corresponding to parameters specified by command-line arguments are changed to 1.


◆戻り値(Return value)

コマンドライン引数で指定したパラメータ値を格納した構造体。 戻り値のメンバの値は以下のようになる。
A structure composed of the parameter values specified by command-line arguments. The values of members of the return value are as follows.
戻り値のメンバ
Member of the return value 		値
Value
structure_file_format コマンドライン引数で「--structure_file_format」 オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--structure_file_format”; if this option was not specified, no value is set.
structure_file コマンドライン引数で「--structure_file」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--structure_file”; if this option was not specified, no value is set.
station_z コマンドライン引数で「--station_z」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--station_z”; if this option was not specified, no value is set.
inputfile コマンドライン引数で「--inputfile」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--inputfile”; if this option was not specified, no value is set.
outputfile コマンドライン引数で「--outputfile」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--outputfile”; if this option was not specified, no value is set.
outputfile_station コマンドライン引数で「--outputfile_station」 オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--outputfile_station”; if this option was not specified, no value is set.
outputdir_snapshot コマンドライン引数で「--outputdir_snapshot」 オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--outputdir_snapshot”; if this option was not specified, no value is set.
dz コマンドライン引数で「--dz」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--dz”; if this option was not specified, no value is set.
dt コマンドライン引数で「--dt」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--dt”; if this option was not specified, no value is set.
dt_snapshot コマンドライン引数で「--dt_snapshot」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--dt_snapshot”; if this option was not specified, no value is set.
tmax コマンドライン引数で「--tmax」オプションを指定した場合はその値。 このオプションを指定しなかった場合は値は設定されない。
The value specified by a command-line option “--tmax”; if this option was not specified, no value is set.
structure_linear 設定されない。
No value is set.
h 設定されない。
No value is set.
Nz 設定されない。
No value is set.


◆補足(Additional remarks)

「--パラメータ名=パラメータ値」以外の形式のコマンドライン引数に遭遇した場合や 未定義のパラメータが指定された場合はエラーとなる。 この関数で行われるのはこのチェックのみであり、 指定必須のパラメータが指定されたか否かや値が適切か否かのチェックは 別の関数の役目となる。
An error is issued if a command-line argument of a form other than “--parameter name=parameter value” format, or an undefined parameter is specified. Only these points are checked by this function; checks for whether unomittable parameters are specified and whether proper parameter values are given are conducted by other functions.