関数get_initialized_3d_data_direct マニュアル

(The documentation of function get_initialized_3d_data_direct)
Last Update: 2022/10/18


◆機能・用途(Purpose)

初期化されたstruct _3d_data型構造体を作成する。 格子点配置を数値で与えるバージョン。
Create an initialized struct _3d_data-type structure, by specifying the grid node configuration by numerical values.

◆形式(Format)

#include <3d_data/initialize.h>
inline struct _3d_data get_initialized_3d_data_direct
(const int Nx,const int Ny,const int Nz,
 const double x0_,const double y0_,const double z0_,
 const double dx_,const double dy_,const double dz_)


◆引数(Arguments)

Nx \(x\)方向の格子点数(\(N_x\))。
The number of grid nodes along the \(x\)-direction (\(N_x\)).
Ny \(y\)方向の格子点数(\(N_y\))。
The number of grid nodes along the \(y\)-direction (\(N_y\)).
Nz \(z\)方向の格子点数(\(N_z\))。
The number of grid nodes along the \(z\)-direction (\(N_z\)).
x0_ \(x\)方向のデータ定義範囲の下端(\(x_0\))。
The lower bound of the data definition range along the \(x\)-direction (\(x_0\)).
y0_ \(y\)方向のデータ定義範囲の下端(\(y_0\))。
The lower bound of the data definition range along the \(y\)-direction (\(y_0\)).
z0_ \(z\)方向のデータ定義範囲の下端(\(z_0\))。
The lower bound of the data definition range along the \(z\)-direction (\(z_0\)).
dx_ \(x\)方向の格子点間隔(\(\Delta x\))。
The grid interval along the \(x\)-direction (\(\Delta x\)).
dy_ \(y\)方向の格子点間隔(\(\Delta y\))。
The grid interval along the \(y\)-direction (\(\Delta y\)).
dz_ \(z\)方向の格子点間隔(\(\Delta z\))。
The grid interval along the \(z\)-direction (\(\Delta z\)).


◆戻り値(Return value)

\(x\), \(y\), \(z\)方向の格子点数を\(N_x\), \(N_y\), \(N_z\)、 データ定義範囲の下端を\(x_0\), \(y_0\), \(z_0\)、 格子点間隔を\(x\), \(y\), \(z\) とする空の(値が未設定の)3次元データを表す構造体。 戻り値の各メンバの値は以下のようになる。
A structure which represents an empty 3-D data (i.e., a 3-D data with values not set) defined on \(N_x\times N_y\times N_z\) grid nodes at \((\Delta x, \Delta y, \Delta z)\) grid intervals starting from \((x_0, y_0, z_0)\). The values of members of the return value are as follows.
戻り値のメンバ
Member of the return value 		値
Value
N[0] 引数Nxの値(\(N_x\))。
The value of argument Nx (\(N_x\)).
N[1] 引数Nyの値(\(N_y\))。
The value of argument Ny (\(N_y\)).
N[2] 引数Nzの値(\(N_z\))。
The value of argument Nz (\(N_z\)).
x0[0] 引数x0_の値(\(x_0\))。
The value of argument x0_ (\(x_0\)).
x0[1] 引数y0_の値(\(y_0\))。
The value of argument y0_ (\(y_0\)).
x0[2] 引数z0_の値(\(z_0\))。
The value of argument z0_ (\(z_0\)).
dx[0] 引数dx_の値(\(\Delta x\))。
The value of argument dx_ (\(\Delta x\)).
dx[1] 引数dy_の値(\(\Delta y\))。
The value of argument dy_ (\(\Delta y\)).
dx[2] 引数dz_の値(\(\Delta z\))。
The value of argument dz_ (\(\Delta z\)).
xmax[0] \(x_0+(N_x-1)\Delta x\)
xmax[1] \(y_0+(N_y-1)\Delta y\)
xmax[2] \(z_0+(N_z-1)\Delta z\)
index[i][j][k] (\(i=0,1,\cdots,N_x-1\); \(j=0,1,\cdots,N_y-1\); \(k=0,1,\cdots,N_z-1\)) \(iN_yN_z+jN_z+k\)
value 値の設定されていない1次元配列(要素数:\(N_xN_yN_z\))。
A 1-D array whose values are not set; the array size is \(N_xN_yN_z\).
checked[0] ′y′


◆使用例(Example)

struct _3d_data data =get_initialized_3d_data_direct(2,3,4,0.1,-1.0,12.3,0.2,0.5,0.3);