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

(Header files exclusively used by waterPML command)
Last Update : 2024/2/22

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.
waterPMLコマンドではそれ以外に、 このプログラム専用のヘッダファイルを用いている。 それらは $YMAEDA_OPENTOOL_DIR/opentws/src/waterPML_sub の下に置いてある。 ymaeda_opentools全体の共通ヘッダファイルと同様に 「特殊なヘッダファイル」と「通常のヘッダファイル」がある。
In addition, waterPML command uses header files exclusively used by this program. These header files are located under $YMAEDA_OPENTOOL_DIR/opentws/src/waterPML_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.
waterPMLコマンド専用の関数や構造体は名前が全て「TF_」から始まる。 これはThis Fileの頭文字を取ったものであり、 ymaeda_opentools全体で共通に使用する関数や構造体との 名前の重複を避けるために付けている。
The names of all functions and structures exclusively used by waterPML 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)

以下はwaterPMLコマンド専用のヘッダファイルのマニュアルである。 ヘッダファイル名は全て $YMAEDA_OPENTOOL_DIR/opentws/src の下での相対パスを表す。 リンクをクリックすると各ヘッダファイルのマニュアルを閲覧できる。
The documentations for header files exclusively used waterPML 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
waterPML_sub/index.h 他のwaterPMLコマンド専用ヘッダファイル一式を インクルードするためのヘッダファイル。
A header file to include all other header files exclusively used by waterPML command.
waterPML_sub/macro.h waterPMLコマンド専用のマクロの定義。
Definitions of macros exclusively used by waterPML command.
waterPML_sub/structure.h waterPMLコマンド専用の構造体の定義。
Definitions of structures exclusively used by waterPML command.
waterPML_sub/prototype.h waterPMLコマンド専用の関数のプロトタイプ。
Prototypes of functions exclusively used by waterPML command.

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

ヘッダファイル名
Header file name 		機能・用途
Purpose
waterPML_sub/calculate_T.h 時刻\(t-\Delta t/2\)での応力場と時刻\(t\)での速度場を用いて 時刻\(t+\Delta t/2\)での応力場を計算する関数。
Functions to compute the stress field at time \(t+\Delta t/2\) given the stress field at time \(t-\Delta t/2\) and the velocity field at time \(t\).
waterPML_sub/calculate_T_omp.h 時刻\(t-\Delta t/2\)での応力場と時刻\(t\)での速度場を用いて 時刻\(t+\Delta t/2\)での応力場を計算する関数 (OpenMP並列化版)。
Functions to compute the stress field at time \(t+\Delta t/2\) given the stress field at time \(t-\Delta t/2\) and the velocity field at time \(t\) (a version for OpenMP parallelization).
waterPML_sub/calculate_V.h 時刻\(t-\Delta t\)での速度場と時刻\(t-\Delta t/2\)での応力場を用いて 時刻\(t\)での速度場を計算する関数。
Functions to compute the velocity field at time \(t\) given the velocity field at time \(t-\Delta t\) and the stress field at time \(t-\Delta t/2\).
waterPML_sub/calculate_V_omp.h 時刻\(t-\Delta t\)での速度場と時刻\(t-\Delta t/2\)での応力場を用いて 時刻\(t\)での速度場を計算する関数 (OpenMP並列化版)。
Functions to compute the velocity field at time \(t\) given the velocity field at time \(t-\Delta t\) and the stress field at time \(t-\Delta t/2\) (a version for OpenMP parallelization).
waterPML_sub/setPML.h PML領域の設定を行う関数。
Functions to configure a PML volume.
waterPML_sub/set_c.h 差分方程式の係数を設定する関数。
Functions to determine the coefficients for difference equations.
waterPML_sub/set_parameters.h パラメータの設定を行う関数。
Functions to set parameters.
waterPML_sub/set_structure.h 地下構造の設定を読み込んで媒質の物性値に反映する関数。
Functions to read the configuration of the subsurface structure and set the material properties correspondingly.
waterPML_sub/set_structure_layer.h 地下構造の設定を読み込んで媒質の物性値に反映する関数(成層構造の場合用)。
Functions to read the configuration of the subsurface structure and set the material properties correspondingly (in case of a stratified medium).
waterPML_sub/setstg.h 食い違い格子の設定を行う関数。
Functions to configure the staggered grid system.
waterPML_sub/snapshot.h スナップショットの出力に関するパラメータを処理する関数。
Functions to process parameters for the output snapshots.
waterPML_sub/source.h 地震波動ソースの設定に基づいて等価体積力の空間分布を設定する関数。
Functions to determine the spatial distribution of an equivalent body force based on the configuration of the seismic wave source.
waterPML_sub/station.h 観測点リストの読み込みと処理を行う関数。
Functions to read and process a station list.
waterPML_sub/topography.h 地形データを読み込んで媒質の設定に反映する関数。
Functions to read topography data and set the material configuration correspondingly.
waterPML_sub/water.h 水域の設定ファイルを読み込んで媒質の設定に反映する関数。
Functions to read the configuration file for water-filled regions and set the material configuration correspondingly.
waterPML_sub/write.h パラメータや計算結果を出力する関数。
Functions to output parameters and computation results.

3. 関数の呼び出し構造

waterPMLコマンドのソースコードにおいて、関数は以下のように呼び出される。 これは関数の索引にもなっており、 関数名をクリックすると直接その関数のマニュアルを閲覧できる。
In the source code of waterPML 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 (waterPML.c)