FDM_1D_verticalコマンド専用のヘッダファイル

(Header files exclusively used by FDM_1D_vertical command)
Last Update: 2022/8/31

1. 概要 (Overview)

ymaeda_opentoolsでは全てのプログラムで共通に使用するヘッダファイルを $YMAEDA_OPENTOOL_DIR/include の下に置いており、そのマニュアルは ここにある。
Header files commonly used by all programs of ymaeda_opentools are located under $YMAEDA_OPENTOOL_DIR/include, and the documentations for these header files are available from this link.
FDM_1D_verticalコマンドではそれ以外に、 このプログラム専用のヘッダファイルを用いている。 それらは $YMAEDA_OPENTOOL_DIR/opentws/src/FDM_1D_vertical_sub の下に置いてある。 ymaeda_opentools全体の共通ヘッダファイルと同様に 「特殊なヘッダファイル」と「通常のヘッダファイル」がある。
In addition, FDM_1D_vertical command uses header files exclusively used by this program. These header files are located under $YMAEDA_OPENTOOL_DIR/opentws/src/FDM_1D_vertical_sub. There are two classes of header files, “special” and “normal” ones; this feature is same as header files common to the entire ymaeda_opentools.
FDM_1D_verticalコマンド専用の関数や構造体は名前が全て「TF_」から始まる。 これはThis Fileの頭文字を取ったものであり、 ymaeda_opentools全体で共通に使用する関数や構造体との 名前の重複を避けるために付けている。
The names of all functions and structures exclusively used by FDM_1D_vertical command begin with “TF_”, which means “This File”, to avoid confliction of the names against functions and structures that are used commonly in the entire ymaeda_opentools.

2. 個々のヘッダファイルのマニュアル (Documentations for individual header files)

以下はFDM_1D_verticalコマンド専用のヘッダファイルのマニュアルである。 ヘッダファイル名は全て $YMAEDA_OPENTOOL_DIR/opentws/src の下での相対パスを表す。 リンクをクリックすると各ヘッダファイルのマニュアルを閲覧できる。
The documentations for header files exclusively used by FDM_1D_vertical command are shown below. All header files represent relative paths under $YMAEDA_OPENTOOL_DIR/opentws/src. Documentations for individual header files are available from the links.

◆特殊なヘッダファイル (Special header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
FDM_1D_vertical_sub/index.h 他のFDM_1D_verticalコマンド専用ヘッダファイル一式を インクルードするためのヘッダファイル。
A header file to include all other header files exclusively used by FDM_1D_vertical command.
FDM_1D_vertical_sub/structure.h FDM_1D_verticalコマンド専用の構造体の定義。
Definitions of structures exclusively used by FDM_1D_vertical command.
FDM_1D_vertical_sub/prototype.h FDM_1D_verticalコマンド専用の関数のプロトタイプ。
Prototypes of functions exclusively used by FDM_1D_vertical command.

◆通常のヘッダファイル (Normal header files)

ヘッダファイル名
Header file name 		機能・用途
Purpose
FDM_1D_vertical_sub/array_z.h 標高\(z\)の関数としての物理量を表現する配列を作成する関数。
Functions to create an array to represent a physical quantity as a function of altitude \(z\).
FDM_1D_vertical_sub/parameters.h パラメータの設定とチェックを行う関数。
Functions to set and check parameters.
FDM_1D_vertical_sub/readwrite.h データの読み込みと結果の出力を行う関数。
Functions to read data and write results.
FDM_1D_vertical_sub/subsurface_structure.h 地下構造の設定とチェックを行う関数。
Functions to set and check the subsurface structure.

3. 関数の呼び出し構造

WIHMコマンドのソースコードにおいて、関数は以下のように呼び出される。 これは関数の索引にもなっており、 関数名をクリックすると直接その関数のマニュアルを閲覧できる。
In the source code of WIHM command, functions are called with the tree shown below. This tree can be used for an index of functions; documentations of individual functions are available from the links of the function names.
main (FDM_1D_vertical.c)