関数TF_set_f マニュアル

(The documentation of function TF_set_f)
Last Update: 2025/1/6


◆機能・用途(Purpose)

等価体積力の空間分布を設定する。
Determine the spatial distribution of an equivalent body force.

◆形式(Format)

#include "waterPML_sub/source.h"
inline double ∗∗∗TF_set_f
(const struct waterPML_parameters parameters, char ∗const ∗type,
 const struct tws_source ∗source,
 const double ∗lambda,const double ∗mu,
 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 ファイルから読み込んだ地震波動ソースの設定。 関数tws_set_source の戻り値を各ソース要素isについて並べた配列を与える。
The configuration of the seismic wave source read from a file; use an array composed of the return value of function tws_set_source for each source element is.
lambda 関数 TF_set_lambda_index, TF_set_structure_layer, TF_set_structure, TF_reflect_water_property によって値を設定した配列。
An array whose values have been given by functions TF_set_lambda_index, TF_set_structure_layer, TF_set_structure, and TF_reflect_water_property.
mu 関数 TF_set_mu_index, TF_set_structure_layer, TF_set_structure, TF_reflect_water_property によって値を設定した配列。
An array whose values have been given by functions TF_set_mu_index, TF_set_structure_layer, TF_set_structure, and TF_reflect_water_property.
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の場合、 関数内でstruct TF_index_f_compressed型構造体から成る2次元配列として 動的メモリが確保され、値が設定される。 2次元配列の第1引数は地震波動ソースの番号、 第2引数は力の成分番号(\(0=x\), \(1=y\), \(2=z\))である。
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 variable with &. Within the function, dynamic memory for a 2-D array of struct TF_index_f_compressed-type structures is allocated and the values of the array components are set if the value of parameter source_memory is smaller; the 1st argument of the 2-D array is an index of a seismic wave source, and the 2nd argument is an index of force component (\(0=x\), \(1=y\), \(2=z\)).


◆戻り値(Return value)

等価体積力の空間分布\(F_i^{(is)}(\posx)\) (waterPML_sub/source.hのマニュアル参照) を並べた3次元配列。 第1引数は地震波動ソースの番号is、第2引数は力の方向\(i\)、第3引数は位置を表す。
A 3-D array that represents the spatial distribution of the equivalent body force \(F_i^{(is)}(\posx)\); see the documentation of waterPML_sub/source.h. The 1st argument of the array represents in index (is) of the seismic wave source, the 2nd does the force direction (\(i\)), and the 3rd does the location.