関数TF_set_mu_index マニュアル

(The documentation of function TF_set_mu_index)
Last Update: 2023/12/12


◆機能・用途(Purpose)

ラメ定数\(\mu\)の代入先の配列を用意し、その配列要素番号 ( 方法3-2) が半格子点の通し番号 ( 方法2) から得られるように struct grid型構造体stgのメンバindexの値を設定する。
Allocate dynamic memory for an array to represent the Lame constant \(\mu\), and define its array index ( 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.

◆形式(Format)

#include "waterPML_sub/setstg.h"
inline double ∗TF_set_mu_index (char ∗const ∗type,struct grid stg)


◆引数(Arguments)

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.
stg 関数 TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index によって値を設定した構造体。 関数内でメンバindexのラメ定数\(\mu\)に対応する配列要素の 設定が行われる。
A structure whose values have been given by functions TF_initialize_stg, TF_set_rho_index, and TF_set_lambda_index. The values of array components of member index corresponding to the Lame constant \(\mu\) are determined in this function.


◆戻り値(Return value)

ラメ定数\(\mu\)の代入先の配列。 \(\mu\)が定義される半格子点の個数分だけの要素を持つ。 この関数では動的メモリの確保のみを行い、各配列要素の値は設定しない。
An array for the Lame constant \(\mu\); the number of components equals to the number of half-grid nodes of the definition points of \(\mu\). This function only allocates dynamic memories for the array, without setting the values of array components.