ISPACK F90/SPPACK レファレンスマニュアル

ISPACK F90/SPPACK モジュールは球面上での 2 次元流体運動を スペクトル法により数値計算するための Fortran90 関数を提供する. 内部で ISPACK の SPPACK と SNPACK の Fortran77 サブルーチンを呼んでいる. スペクトルデータおよび格子点データの格納方法や 変換の詳しい計算法については ISPACK/SNPACK,SPPACK のマニュアルを参照されたい.

モジュール stpack では各関数とも 1 層データ(2 次元), 多層データ(3 次元)どちらも 扱うことができる. 多層データの層数は初期化ルーチンで指定した最大値以下であれば制限がない. 1 層データのみ扱う場合のために stpack_single モジュールも用意してある.

ISPACK F90 版 SPPACK は内部で ISPACK F90 版 SNPACK を使っているので, 使用する際には sppack.f90 だけでなく snpack.f90 も必要になる.

変数・サブルーチン・関数一覧

変数の説明

longitude, latitude

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

         real(8), dimension(im) :: longitude
         real(8), dimension(jm) :: latutude
       

3. 備考
   単位はラジアン.

lon_weight, lat_weight

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

         real(8), dimension(im) :: lon_weight
         real(8), dimension(jm) :: lat_weight
       

3. 備考
   lon_weight には格子点の間隔が格納してある. lat_weight にはガウス重みが格納してある.

gg_lon, gg_lat

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

         real(8), dimension(im,jm) :: gg_lon, gg_lat
       

3. 備考
   単位はラジアン.

サブルーチンの説明

subroutine spinitial(nm,im,jm,km)

1. 機能 : スペクトル変換の格子点数, 波数を設定する(sppack モジュール).
2. 引数の説明

       integer,intent(in)          :: nm          ! 切断全波数
       integer,intent(in)          :: im, jm      ! 格子点数(経度λ, 緯度φ)
       integer,intent(in)          :: km          ! 同時に処理する最大データ数(層の数)
       

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

subroutine spinitial_single(nm,im,jm)

1. 機能 : スペクトル変換の格子点数, 波数を設定する(sppack_single モジュール).
2. 引数の説明

       integer,intent(in)          :: nm              ! 切断全波数
       integer,intent(in)          :: im, jm          ! 格子点数(経度λ, 緯度φ)
       

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

各関数の説明

関数の名前について

• 関数名の先頭 (ep_, gg_) は, 返す値の形を示している.
  ep_ : スペクトルデータ, gg_ : 格子点データ

• 関数名の間の文字列(dlon, lapla, laplainv, jacobian, gradlon, gradlat, divlon, divlat, div)は, その関数の作用を表している.

• 関数名の最後 (_ep,_ep_ep,_gg,_gg_gg) は, 入力変数の形スペクトルデータおよび格子点データであることを示している.
  _ep : スペクトルデータ, _ep_ep : 2 つのスペクトルデータ, _gg : 格子点データ, _gg_gg : 2 つの格子点データ.

凡例

• gg : 格子点データ.
  変数の種類と次元は 1 層データ real(8), dimension(im,jm) あるいは多層データ real(8), dimension(im,jm,*) (ただし stpack_single では 2 次元データのみ). im, jm はそれぞれ経度, 緯度座標の格子点数であり, サブルーチン spinitial あるいは spinitial_single にてあらかじめ設定しておく.

• ep : スペクトルデータ.
  変数の種類と次元は 1 層データ real(8), dimension((nm+1)*(nm+1)) あるいは多層データ real(8), dimension((nm+1)*(nm+1),*) (ただし stpack_single では 2 次元データのみ). nm は球面調和函数の最大全波数であり, サブルーチン spinitial あるいは spinitial_single にてあらかじめ設定しておく. スペクトルデータの格納のされ方は関数 l_nm, nm_l によって 調べることができる.

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

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

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

• 多層データの場合には同時に処理する最大の層の数 (同時に処理する最大データ数)も spinitial で設定しておく. 多層データを各関数に与えた場合, 複数の 2 次元データが同時に処理されることになる. 返される配列の最後の次元の長さは入力のものと同じである.

function l_nm(n,m)

1. 機能 : 全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
2. 備考
   

function nm_l(l)

1. 機能 : スペクトルデータの格納位置(l)から全波数(n)と東西波数(m)を返す.
2. 備考
   返り値は長さ 2 の整数配列 (n,m).

function gg_ep(ep,ipow,iflag)

1. 機能 : スペクトルデータから格子データへ変換する.
2. 引数の説明
   
   • 整数型オプショナル引数 ipow は, 変換時に同時に作用させる 1/(cosφ)**n の次数を指定する. 省略したときは 0.
   • 整数型オプショナル引数 iflag は変換の種類を指定する.
     0 : 通常の正変換
     1 : 経度微分を作用させた正変換
     -1 : 緯度微分を作用させた正変換
     2 : sinφを作用させた正変換
     省略時は 0.
3. 備考
   

function ep_gg(g,ipow,iflag)

1. 機能 : 格子データからスペクトルデータへ(正)変換する.
2. 引数の説明
   
   • 整数型オプショナル引数 ipow は, 変換時に同時に作用させる 1/(cosφ)**n の次数を指定する. 省略したときは 0.
   • 整数型オプショナル引数 iflag は変換の種類を指定する.
     0 : 通常の正変換
     1 : 経度微分を作用させた正変換
     -1 : 緯度微分を作用させた正変換
     2 : sinφを作用させた正変換
     省略時は 0.
3. 備考
   

function ep_lapla_ep(ep)

1. 機能 : 入力スペクトルデータにラプラシアンを作用する.
   
2. 備考
   スペクトルデータのラプラシアンとは, 対応する格子点データにラプラシアンを作用させたデータのスペクトル変換のことである. ラプラシアンは ▽^2 = 1/cos^2φ・∂^2/∂λ^2 + 1/cosφ・∂/∂φ(cosφ∂/∂φ) と計算される.

function ep_laplainv_ep(ep)

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

function ep_dlon_ep(ep)

1. 機能 : 入力スペクトルデータに経度微分を作用する.
   
2. 備考
   スペクトルデータの経度微分とは, 対応する格子点データに経度微分 ∂/∂λ を 作用させたデータのスペクトル変換のことである.

function ep_jacobian_ep_ep(ep_a,ep_b)

1. 機能 : 2 つのスペクトルデータからヤコビアンを計算する.
   
2. 備考
   2 つのスペクトルデータのヤコビアンとは, 対応する 2 つの格子点データのヤコビアンのスペクトル変換のことである.
   2 つのデータ f, g のヤコビアンは J(f,g) = ∂f/∂λ・∂g/∂μ - ∂g/∂λ・∂f/∂μ = ∂f/∂λ・1/cosφ・∂g/∂φ - ∂g/∂λ・1/cosφ・∂f/∂φ と計算される.

function gg_gradlon_ep(ep)

1. 機能 : スペクトルデータに勾配型経度微分を作用させる.
   
2. 備考
   スペクトルデータに対応する格子点データに 勾配型経度微分 1/cosφ・∂/∂λ を作用させた格子データが返される

function gg_gradlat_ep(ep)

1. 機能 : スペクトルデータに勾配型経度微分を作用させる.
   
2. 備考
   入力スペクトルデータに対応する格子データに 勾配型緯度微分 ∂/∂φ を作用させた格子データが返される

function ep_divlon_gg(gg)

1. 機能 : 格子データに発散型経度微分を作用させる.
   
2. 備考
   入力格子データに発散型経度微分 1/cosφ・∂/∂λ を作用させた スペクトルデータが返される

function ep_divlat_gg(gg)

1. 機能 : 格子データに発散型緯度微分を作用させる.
   
2. 備考
   入力格子データに発散型経度微分 1/cosφ・∂(g cosφ)/∂φ を作用させた スペクトルデータが返される

function ep_div_gg_gg(gg_u,gg_v)

1. 機能 : ベクトル成分である 2 つの格子データに発散を作用させる.
   
2. 備考
   第 1, 2 引数(u,v)がそれぞれベクトルの経度成分と緯度成分を表し, 発散は 1/cosφ・∂u/∂λ + 1/cosφ・∂(v cosφ)/∂φ と計算される.