spml/ee_module レファレンスマニュアル

spml/ee_module モジュールは周期境界条件の下での 2 次元矩形領域の 流体運動をスペクトル法により数値計算するための Fortran90 関数を提供する. 内部で ISPACK/N2PACK の Fortran77 サブルーチンを呼んでいる. スペクトルデータおよび格子点データの格納方法については ISPACK/N2PACK のマニュアルを参照されたい.

目次

• サブルーチン・関数・変数一覧(機能別)
• 関数・変数の名前と型について
  • 命名法
  • 各データの種類の説明
• サブルーチンの説明
• 変数の説明
• 各関数の説明

サブルーチン・関数一覧(機能別)

関数・変数の名前と型について

命名法

• 関数名の先頭 (ee_, xy_, x_, y_) は, 返す値の形を示している.
  ee_ : スペクトルデータ, xy_ : 2 次元格子点データ, x_ : X 方向 1 次元格子点データ, y_ : Y 方向 1 次元格子点データ.

• 関数名の間の文字列(Dx, Dy, Lapla, LaplaInv, Jacobian)は, その関数の作用を表している.

• 関数名の最後 (_ee_ee,_ee,_xy, _x, _y) は, 入力変数の形スペクトルデータおよび格子点データであることを示している.
  _ee : スペクトルデータ, _ee_ee : 2 つのスペクトルデータ, _xy : 2 次元格子点データ, _x : X 方向 1 次元格子点データ, _y : Y 方向 1 次元格子点データ.

各データの種類の説明

• xy : 2 次元格子点データ.
  変数の種類と次元は real(8), dimension(0:jm-1,0:im-1). im, jm はそれぞれ X, Y 座標の格子点数であり, サブルーチン ee_initial にてあらかじめ設定しておく. 第 1 次元が Y 座標の格子点位置番号, 第 2 次元が X 座標の格子点位置番号である (X, Y の順ではない)ことに注意.

• ee : スペクトルデータ.
  変数の種類と次元は real(8), dimension(-lm:lm,-km:km). km, lm はそれぞれ X, Y 方向の最大波数であり, サブルーチン ee_initial にてあらかじめ設定しておく. スペクトルデータの格納のされ方については...

• x, y : X, Y 方向 1 次元格子点データ.
  変数の種類と次元はそれぞれ real(8), dimension(0:im-1) および real(8), dimension(0:jm-1).

• ee_ で始まる関数が返す値はスペクトルデータに同じ.

• xy_ で始まる関数が返す値は 2 次元格子点データに同じ.

• x_, y_ で始まる関数が返す値は 1 次元格子点データに同じ.

• スペクトルデータに対する微分等の作用とは, 対応する格子点データに微分などを作用させたデータを スペクトル変換したものことである.

サブルーチンの説明

subroutine ee_initial(i,j,k,l,xmin,xmax,ymin,ymax)

1. 機能 : スペクトル変換の格子点数, 波数, 領域の大きさを設定する.
2. 引数の説明

       integer,intent(in) :: i, j             ! 格子点の設定(X,Y)
       integer,intent(in) :: k, l             ! 切断波数の設定(X,Y)
       real(8),intent(in) :: xmin, xmax       ! X 座標の範囲
       real(8),intent(in) :: ymin, ymax       ! Y 座標の範囲
       

3. 備考
   他の関数や変数を呼ぶ前に, 最初にこのサブルーチンを呼んで初期設定を しなければならない.

変数の説明

x_X, y_Y

1. 説明 : 格子点座標(X,Y)を格納した 1 次元配列.
2. 変数の型
   

         real(8), dimension(0:im-1) :: x_X
         real(8), dimension(0:jm-1) :: y_Y
       

3. 備考
   

x_X_Weigtht, y_Y_Weight

1. 説明 : 重み座標を格納した 1 次元配列.
2. 変数の型
   

         real(8), dimension(0:im-1) :: x_X_Weigtht
         real(8), dimension(0:jm-1) :: y_Y_Weigtht
       

3. 備考
   x_X_Weight, y_Y_Weight にはそれぞれ X, Y 方向の格子点の 間隔が格納してある.

xy_X, xy_Y

1. 説明 : 各格子点(i,j)の位置の X, Y 座標を格納した格子データ.
2. 変数の型
   

         real(8), dimension(0:jm-1,0:im-1) :: xy_X, xy_Y
       

3. 備考
   

各関数の説明

function xy_ee(ee)

1. 機能 : スペクトルデータから格子データへ変換する.
2. 変数の型
   

         real(8), dimension(0:jm-1,0:im-1)             :: xy_ee
         real(8), dimension(-lm:lm,-km:km), intent(in) :: ee
       

3. 備考
   

function ee_xy(xy)

1. 機能 : 格子データからスペクトルデータへ変換する.
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)              :: ee_xy
         real(8), dimension(0:jm-1,0:im-1), intent(in)  :: xy
       

3. 備考
   

function ee_Lapla_ee(ee)

1. 機能 : 入力スペクトルデータにラプラシアンを作用する.
   
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)              :: ee_Lapla_ee
         real(8), dimension(-lm:lm,-km:km), intent(in)  :: ee
       

3. 備考
   スペクトルデータのラプラシアンとは, 対応する格子点データにラプラシアンを作用させたデータのスペクトル変換のことである.

function ee_LaplaInv_ee(ee)

1. 機能 : 入力スペクトルデータに逆ラプラシアンを作用する.
   
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)             :: ee_LaplaInv_ee
         real(8), dimension(-lm:lm,-km:km), intent(in) :: ee
       

3. 備考
   スペクトルデータの逆ラプラシアンとは, 対応する格子点データに逆ラプラシアンを作用させたデータのスペクトル変換のことである.

function ee_Dx_ee(ee)

1. 機能 : 入力スペクトルデータに X 微分を作用する.
   
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)              :: ee_Dx_ee
         real(8), dimension(-lm:lm,-km:km), intent(in)  :: ee
       

3. 備考
   スペクトルデータの X 微分とは, 対応する格子点データに X 微分を作用させたデータのスペクトル変換のことである.

function ee_Dy_ee(ee)

1. 機能 : 入力スペクトルデータに Y 微分を作用する.
   
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)              :: ee_Dy_ee
         real(8), dimension(-lm:lm,-km:km), intent(in)  :: ee
       

3. 備考
   スペクトルデータの Y 微分とは, 対応する格子点データに Y 微分を作用させたデータのスペクトル変換のことである.

function ee_Jacobian_ee_ee(ee_a,ee_b)

1. 機能 : 2 つのスペクトルデータからヤコビアンを計算する.
   
2. 変数の型
   

         real(8), dimension(-lm:lm,-km:km)              :: ee_Jacobian_ee_ee
         real(8), dimension(-lm:lm,-km:km), intent(in)  :: ee_a, ee_b
       

3. 備考
   2 つのスペクトルデータのヤコビアンとは, 対応する 2 つの格子点データのヤコビアンのスペクトル変換のことである.

function IntXY_xy(xy), function AvrXY_xy(xy)

1. 機能 : 2 次元格子点データの全領域積分および平均.
   
2. 変数の型
   

         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8)                             :: IntXY_xy    ! 積分値
   
         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8)                             :: AvrXY_xy    ! 平均値
       

3. 備考
   

function y_IntX_xy(xy), function y_AvrX_xy(xy)

1. 機能 : 2 次元格子点データの X 方向積分および平均.
   
2. 変数の型
   

         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8), dimension(0:jm-1)          :: y_IntX_xy   ! 1 次元(Y)格子点
   
         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8), dimension(0:jm-1)          :: y_AvrX_xy   ! 1 次元(Y)格子点
       

3. 備考
   

function IntX_x(x), function AvrX_x(x)

1. 機能 : 1 次元(X)格子点データの X 方向積分および平均.
   
2. 変数の型
   

         real(8), dimension(0:im-1)   :: x          ! 1 次元格子点
         real(8)                      :: IntX_x     ! 積分値
   
         real(8), dimension(0:im-1)   :: x          ! 1 次元格子点
         real(8)                      :: AvrX_x     ! 平均値
       

3. 備考
   

function x_IntXY_xy(xy), function x_AvrXY_xy(xy)

1. 機能 : 2 次元格子点データの Y 方向域積分および平均.
   
2. 変数の型
   

         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8), dimension(0:im-1)          :: x_IntY_xy   ! 1 次元(X)格子点
   
         real(8), dimension(0:jm-1,0:im-1)   :: xy          ! 2 次元格子点
         real(8), dimension(0:im-1)          :: x_AvrY_xy   ! 1 次元(X)格子点
       

3. 備考
   

function IntXY_y(y), function AvrXY_y(y)

1. 機能 : 1 次元(Y)格子点データの Y 方向域積分および平均.
   
2. 変数の型
   

         real(8), dimension(0:jm-1)   :: y          ! 1 次元格子点
         real(8)                      :: IntY_y     ! 積分値
   
         real(8), dimension(0:jm-1)   :: y          ! 1 次元格子点
         real(8)                      :: AvrY_y     ! 平均値
       

3. 備考