関数tws_set_source マニュアル

(The documentation of function tws_set_source)
Last Update: 2022/2/24


◆機能・用途(Purpose)

地震波動ソースの設定ファイルを読み込み、 チェックと修正を行ってstruct tws_source型構造体に保存する。
Read a configuration file for seismic wave sources, check, modify, and store the results into a struct tws_source-type structure.

◆形式(Format)

#include <tws/source.h>
inline struct tws_source ∗tws_set_source
(const int Nsource,const char ∗source_file,void ∗parameters,
 const char ∗type_material)


◆引数(Arguments)

Nsource ソースの個数。
The number of sources.
source_file 読み込む地震波動ソースの設定ファイル名。
The name of the configuration file for seismic wave sources to read.
parameters waterPMLコマンドから呼び出す場合は パラメータ一式を保存しているstruct waterPML_parameters型構造体のアドレス。 その他のコマンドから呼び出す場合はNULL。
The address of the struct waterPML_parameters-type structure that keeps the parameters if this function is called from waterPML command; NULL otherwise.
type_material waterPMLコマンド内から呼び出す場合は 格子点の媒質の種類を表す配列(type[is_material])。 その他のコマンドから呼び出す場合はNULL。
An array which represents the types of materials of grid nodes (type[is_material]) if this function is called from waterPML command; NULL otherwise.


◆戻り値(Return value)

引数source_fileで指定したファイルから読み込んだ設定を代入した配列。 Nsource個の配列要素から成り、各配列要素には1つのソースに関する設定が代入される。 角度は全て関数内でrad単位に修正される。
An array which represents the configurations read from the file specified by argument source_file. The array is composed of Nsource components, and each array component refers to the configurations of one source. All the angles are corrected to radian unit in the function.

◆使用例(Example)

int Nsource=tws_count_source("source.ini");
struct waterPML_parameters parameters;
char ∗∗type;
struct tws_source source= tws_set_source(Nsource,"source.ini",&parameters,type);