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

(Header files exclusively used by calculate_radiation_pattern command)
Last Update : 2022/4/4

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

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

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

ヘッダファイル名
Header file name 		機能・用途
Purpose
calculate_radiation_pattern_sub/calculation_common.h 変位振幅の計算を補助する関数(モーメントテンソル、シングルフォース共通)。
Functions to support computations for displacement amplitude (common to moment tensor and single force sources).
calculate_radiation_pattern_sub/calculation_moment_tensor.h モーメントテンソルが作る変位振幅を計算する関数。
Functions to compute the displacement amplitude caused by a moment tensor.
calculate_radiation_pattern_sub/calculation_single_force.h シングルフォースが作る変位振幅を計算する関数。
Functions to compute the displacement amplitude caused by a single force.
calculate_radiation_pattern_sub/set_parameters.h パラメータの設定を行う関数。
Functions to set parameters.

3. 関数の呼び出し構造

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