関数TF_set_f_index マニュアル

(The documentation of function TF_set_f_index)
Last Update: 2025/1/7


◆機能・用途(Purpose)

等価体積力の代入先の配列要素番号 ( 方法3-2) が半格子点の通し番号 ( 方法2) から得られるように struct grid型構造体stgのメンバindex あるいは struct TF_index_f_compressed型構造体 の値を設定する。 また、等価体積力を与える半格子点の個数をカウントする。
Define the index of an array to represent the equivalent body force ( method 3-2) for each consecutive index of a half-grid node ( method 2) by setting the values of member index of a struct grid-type structure stg or a struct TF_index_f_compressed-type structure, and count the number of half-grid nodes where the equivalent body force is to be given.
地震波動ソースの設定ファイルには (例えば鉛直シングルフォースと等方モーメントテンソルソースのように) 複数のソース要素が定義される場合がある。 この関数ではそのうちの1つのソース要素について処理を行う。 ソース要素が複数ある場合はその数だけこの関数を繰り返し呼び出す。 また、等価体積力には3成分あるが、 この関数ではそのうちの1つの成分について処理を行うものとし、 力の3成分の設定を完了させるにはこの関数を3度繰り返して呼び出す。
The configuration file for the seismic wave source may have multiple source elements; for example, a vertical single force and an isotropic moment tensor source. This function processes a source element; if there are multiple source elements, this function is called repeatedly for each element. In addition, this function processes only one force component; the function is repeatedly called to complete the settings for the three force components.

◆形式(Format)

#include "waterPML_sub/setstg.h"
inline int TF_set_f_index
(const struct waterPML_parameters parameters, char ∗const ∗type,
 const _Bool ∗source_grid_flag,const int is,const int i,
 struct grid stg,struct TF_index_f_compressed ∗index_f)


◆引数(Arguments)

parameters 関数TF_set_parameters によってメンバの値の設定を済ませた構造体。
A structure whose members were set by function TF_set_parameters.
type 関数TF_set_type, TF_set_material_type によって値を設定した 2次元配列type。
A 2-D array type whose values have been set by functions TF_set_type and TF_set_material_type.
source_grid_flag 各格子セルがノンゼロのソース強度を持つか否かを示すフラグ。 関数TF_calculate_source_intensity を用いて作成した配列を与える。
A flag indicating whether each grid cell has non-zero source intensity. Use an array created by function TF_calculate_source_intensity.
is 処理対象の地震波動ソース要素の番号。
An index of the seismic wave source element to process.
i 処理対象の力の成分番号(\(0=x\), \(1=y\), \(2=z\))。
An index of the force component to process; \(0=x\), \(1=y\), and \(2=z\).
stg 関数 TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index, TF_set_mu_index, TF_set_alpha_index, TF_set_c によって値を設定した構造体。 パラメータsource_memoryの値がconventionalの場合、 関数内でメンバindexの等価体積力に対応する配列要素の 設定が行われる。
A structure whose values have been given by functions TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index, TF_set_mu_index, TF_set_alpha_index, and TF_set_c. The values of array components of member index corresponding to the equivalent body force are determined in this function if the value of parameter source_memory is conventional.
index_f 半格子点の通し番号 と 等価体積力のための通し番号 の関係の保存先。 宣言しただけのstruct TF_index_f_compressed型構造体に&を付けて与える。 パラメータsource_memoryの値がsmallerの場合、 関数内でメンバの値が設定される。
Memory into which the relation between a consecutive index of half-grid nodes and a consecutive index for an equivalent body force is to be preserved. Give an empty struct TF_index_f_compressed-type structure with &. The values of members of the structure are set within the function if the value of parameter source_memory is smaller.


◆戻り値(Return value)

等価体積力を与える半格子点の個数。
The number of half-grid nodes to apply an equivalent body force.