関数TF_set_alpha_index マニュアル

(The documentation of function TF_set_alpha_index)
Last Update: 2024/2/16


◆機能・用途(Purpose)

\(\alpha^k\)の代入先の配列を用意し、その配列要素番号 ( 方法3-2) が半格子点の通し番号 ( 方法2) から得られるように struct grid型構造体stgのメンバindexの値を設定する。
Allocate dynamic memory for an array to represent \(\alpha^k\), 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.
\(\alpha^k\)については 計算式 — 微分方程式参照。
See Formula — Differential equations for the definition of \(\alpha^k\).

◆形式(Format)

#include "waterPML_sub/setstg.h"
inline double ∗∗TF_set_alpha_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, TF_set_mu_index によって値を設定した構造体。 関数内でメンバindexの\(\alpha^k\)に対応する配列要素の 設定が行われる。
A structure whose values have been given by functions TF_initialize_stg, TF_set_rho_index, TF_set_lambda_index, and TF_set_mu_index. The values of array components of member index corresponding to \(\alpha^k\) are determined in this function.


◆戻り値(Return value)

各\(k\)(\(=0,1,2\))に対する\(\alpha^k\)の代入先の配列を並べた2次元配列。 各\(k\)について、戻り値の配列の第\(k\)成分は \(\alpha^k\)が定義される半格子点の個数分だけの要素を持つ。 この関数では動的メモリの確保のみを行い、各配列要素の値は設定しない。
A 2-D array composed of 1-D sub-arrays for \(\alpha^k\) for each \(k\) (\(=0,1,2\)); the number of 1-D sub-array components for each \(k\) equals to the number of half-grid nodes of the definition points of \(\alpha^k\). This function only allocates dynamic memories for the array, without setting the values of array components.