関数TF_set_water_surface マニュアル

(The documentation of function TF_set_water_surface)

Last Update: 2023/12/13

◆機能・用途(Purpose)

水域の設定に基づいて水面の標高を表す struct TF_surface型構造体を設定する。
Set a struct TF_surface-type structure to represent the water surface elevations based on the configuration of water-filled regions.

◆形式(Format)

#include "waterPML_sub/water.h"
inline void TF_set_water_surface
(const struct waterPML_parameters parameters,
const struct TF_lake lake,struct TF_surface water_surface)

◆引数(Arguments)

parameters	関数TF_set_parameters によってメンバの値の設定を済ませた構造体。 A structure whose members were set by function TF_set_parameters.
lake	関数TF_read_water_ini によってメンバの値の設定を済ませた構造体。 A structure whose members were set by function TF_read_water_ini.
water_surface	関数TF_initialize_surface によって初期化を済ませた構造体を与える。関数内でメンバelevationの配列要素が設定される。また、水域におけるメンバn2の配列要素としてひとまず0が設定される。 Give a structure that was initialized by function TF_initialize_surface. The array components of member elevation are set in this function. Also, the array components of member n2 for water-filled regions are tentatively set as 0.

◆動作(Behaviour)

引数lakeで与えた水域の設定に基づいて引数water_surfaceで与えた構造体のメンバelevation, n2の配列要素を設定する。
Determine the values of array components of members elevation and n2 of a structure given by argument water_surface based on the configuration of a water-filled region given by argument lake.

◆補足(Additional remarks)

この関数で処理できるのは1つの水域である。複数の水域がある場合は水域の数だけこの関数を呼び出す。
This function processes only one water-filled region. If there are multiple water-filled regions, repeatedly call this function for each region.