| Class | w_base_module |
| In: |
libsrc/w_module/w_base_module.f90
|
| Authors: | Shin-ichi Takehiro, Youhei SASAKI |
| Version: | $Id: w_base_module.f90 590 2013-08-19 08:48:21Z uwabami $ |
| Copyright&License: | See COPYRIGHT |
spml/w_base_module モジュールは球面上での 2 次元流体運動を 球面調和函数を用いたスペクトル法によって数値計算するための モジュール w_module の下部モジュールであり, スペクトル法の 基本的な Fortran90 関数を提供する.
内部で ISPACK の SPPACK と SNPACK の Fortran77 サブルーチン を呼んでいる. スペクトルデータおよび格子点データの格納方法 や変換の詳しい計算法については ISPACK/SNPACK,SPPACK のマニ ュアルを参照されたい.
| Function : | |||
| l_nm_array00 : | integer
| ||
| n : | integer, intent(in)
| ||
| m : | integer, intent(in)
|
全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
引数 n,m がともに整数値の場合, 整数値を返す.
function l_nm_array00(n,m)
!
! 全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
!
! 引数 n,m がともに整数値の場合, 整数値を返す.
!
integer :: l_nm_array00
!(out) スペクトルデータの格納位置
integer, intent(in) :: n !(in) 全波数
integer, intent(in) :: m !(in) 帯状波数
call snnm2l(n,m,l_nm_array00)
end function l_nm_array00
| Function : | |||
| l_nm_array01(size(marray)) : | integer
| ||
| n : | integer, intent(in)
| ||
| marray(:) : | integer, intent(in)
|
スペクトルデータの格納位置
全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
第 1 引数 n が整数, 第 2 引数 marray が整数 1 次元配列の場合, marray と同じ大きさの 1 次元整数配列を返す.
function l_nm_array01(n,marray) ! スペクトルデータの格納位置
!
! 全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
!
! 第 1 引数 n が整数, 第 2 引数 marray が整数 1 次元配列の場合,
! marray と同じ大きさの 1 次元整数配列を返す.
!
integer, intent(in) :: n !(in) 全波数
integer, intent(in) :: marray(:) !(in) 帯状波数
integer :: l_nm_array01(size(marray))
!(out) スペクトルデータ位置
integer :: i
do i=1, size(marray)
l_nm_array01(i) = l_nm_array00(n,marray(i))
enddo
end function l_nm_array01
| Function : | |||
| l_nm_array10(size(narray)) : | integer
| ||
| narray(:) : | integer, intent(in)
| ||
| m : | integer, intent(in)
|
全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
第 1 引数 narray が整数 1 次元配列, 第 2 引数 m が整数の場合, narray と同じ大きさの 1 次元整数配列を返す.
function l_nm_array10(narray,m)
!
! 全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
!
! 第 1 引数 narray が整数 1 次元配列, 第 2 引数 m が整数の場合,
! narray と同じ大きさの 1 次元整数配列を返す.
!
integer, intent(in) :: narray(:) !(in) 全波数
integer, intent(in) :: m !(in) 帯状波数
integer :: l_nm_array10(size(narray))
!(out) スペクトルデータ位置
integer :: i
do i=1, size(narray)
l_nm_array10(i) = l_nm_array00(narray(i),m)
enddo
end function l_nm_array10
| Function : | |||
| l_nm_array11(size(narray)) : | integer
| ||
| narray(:) : | integer, intent(in)
| ||
| marray(:) : | integer, intent(in)
|
全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
第 1,2 引数 narray, marray がともに整数 1 次元配列の場合, narray, marray と同じ大きさの 1 次元整数配列を返す. narray, marray は同じ大きさでなければならない.
function l_nm_array11(narray,marray)
!
! 全波数(n)と東西波数(m)からそのスペクトルデータの格納位置を返す.
!
! 第 1,2 引数 narray, marray がともに整数 1 次元配列の場合,
! narray, marray と同じ大きさの 1 次元整数配列を返す.
! narray, marray は同じ大きさでなければならない.
!
integer, intent(in) :: narray(:) !(in) 全波数
integer, intent(in) :: marray(:) !(in) 帯状波数
integer :: l_nm_array11(size(narray))
!(out) スペクトルデータ位置
integer :: i
if ( size(narray) .ne. size(marray) ) then
call MessageNotify('E','l_nm_array11', 'dimensions of input arrays n and m are different.')
endif
do i=1, size(narray)
l_nm_array11(i) = l_nm_array00(narray(i),marray(i))
enddo
end function l_nm_array11
| Function : | |||
| nm_l_int(2) : | integer
| ||
| l : | integer, intent(in)
|
スペクトルデータの格納位置(l)から全波数(n)と東西波数(m)を返す.
引数 l が整数値の場合, 対応する全波数と帯状波数を 長さ 2 の 1 次元整数値を返す. nm_l(1) が全波数, nm_l(2) が帯状波数である.
function nm_l_int(l)
!
! スペクトルデータの格納位置(l)から全波数(n)と東西波数(m)を返す.
!
! 引数 l が整数値の場合, 対応する全波数と帯状波数を
! 長さ 2 の 1 次元整数値を返す.
! nm_l(1) が全波数, nm_l(2) が帯状波数である.
!
integer :: nm_l_int(2) !(out) 全波数, 帯状波数
integer, intent(in) :: l !(in) スペクトルデータの格納位置
call snl2nm(l,nm_l_int(1),nm_l_int(2))
end function nm_l_int
| Function : | |||
| nm_l_array(size(larray),2) : | integer
| ||
| larray(:) : | integer, intent(in)
|
スペクトルデータの格納位置(l)から全波数(n)と東西波数(m)を返す.
引数 larray が整数 1 次元配列の場合, larray に対応する n, m を格納した 2 次元整数配列を返す. nm_l_array(:,1) が全波数, nm_l_array(:,2) が帯状波数である.
function nm_l_array(larray)
!
! スペクトルデータの格納位置(l)から全波数(n)と東西波数(m)を返す.
!
! 引数 larray が整数 1 次元配列の場合,
! larray に対応する n, m を格納した 2 次元整数配列を返す.
! nm_l_array(:,1) が全波数, nm_l_array(:,2) が帯状波数である.
!
integer, intent(in) :: larray(:)
!(out) 全波数, 帯状波数
integer :: nm_l_array(size(larray),2)
!(in) スペクトルデータの格納位置
integer :: i
do i=1, size(larray)
nm_l_array(i,:) = nm_l_int(larray(i))
enddo
end function nm_l_array
| Subroutine : | |||
| w_Psi((nm+1)*(nm+1)) : | real(8), intent(in)
| ||
| w_Chi((nm+1)*(nm+1)) : | real(8), intent(in)
| ||
| xy_U(0:im-1,1:jm) : | real(8), intent(out)
| ||
| xy_V(0:im-1,1:jm) : | real(8), intent(out)
|
流線・ポテンシャル(スペクトルデータ)から速度場(格子データ)に (逆)変換する(1 層用)
スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
u cosφ = ∂χ/∂λ - cosφ∂ψ/∂φ, v cosφ = cosφ∂χ/∂φ + ∂ψ/∂λ
subroutine w_StreamPotential2Vector(w_Psi, w_Chi, xy_U, xy_V)
!
! 流線・ポテンシャル(スペクトルデータ)から速度場(格子データ)に
! (逆)変換する(1 層用)
!
! スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
!
! u cosφ = ∂χ/∂λ - cosφ∂ψ/∂φ,
! v cosφ = cosφ∂χ/∂φ + ∂ψ/∂λ
!
real(8), intent(in) :: w_Psi((nm+1)*(nm+1))
!(in) 流線関数
real(8), intent(in) :: w_Chi((nm+1)*(nm+1))
!(in) 速度ポテンシャル
real(8), intent(out) :: xy_U(0:im-1,1:jm)
!(out) 速度経度成分
real(8), intent(out) :: xy_V(0:im-1,1:jm)
!(out) 速度緯度成分
if ( .not. w_base_initialize ) then
call MessageNotify('E','w_StreamPotential2Vector', 'w_base_module not initialize yet.')
endif
!
! u cosφ = ∂χ/∂λ - cosφ∂ψ/∂φ の計算
!
xy_U = xy_w(w_Chi,ipow=1,iflag=-1) - xy_w(w_Psi,ipow=1,iflag=1)
!
! v cosφ = cosφ∂χ/∂φ + ∂ψ/∂λ の計算
!
xy_V = xy_w(w_Chi,ipow=1,iflag=1) + xy_w(w_Psi,ipow=1,iflag=-1)
end subroutine w_StreamPotential2Vector
| Subroutine : | |||
| xy_U(0:im-1,1:jm) : | real(8), intent(in)
| ||
| xy_V(0:im-1,1:jm) : | real(8), intent(in)
| ||
| w_Vor((nm+1)*(nm+1)) : | real(8), intent(out)
| ||
| w_Div((nm+1)*(nm+1)) : | real(8), intent(out)
|
速度場(格子データ)から渦度・発散(スペクトルデータ)に (正)変換する(1 層用)
スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
subroutine w_Vector2VorDiv(xy_U, xy_V, w_Vor, w_Div)
!
! 速度場(格子データ)から渦度・発散(スペクトルデータ)に
! (正)変換する(1 層用)
!
! スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
!
! ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ
! D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
!
real(8), intent(in) :: xy_U(0:im-1,1:jm)
!(in) 速度経度成分
real(8), intent(in) :: xy_V(0:im-1,1:jm)
!(in) 速度緯度成分
real(8), intent(out) :: w_Vor((nm+1)*(nm+1))
!(out) 流線関数
real(8), intent(out) :: w_Div((nm+1)*(nm+1))
!(out) 速度ポテンシャル
if ( .not. w_base_initialize ) then
call MessageNotify('E','w_Vector2VorDiv', 'w_base_module not initialize yet.')
endif
!
! ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ
!
w_Vor = w_xy(xy_V,ipow=1,iflag=-1) - w_xy(xy_U,ipow=1,iflag=1)
!
! D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
!
w_Div = w_xy(xy_U,ipow=1,iflag=-1) + w_xy(xy_V,ipow=1,iflag=1)
end subroutine w_Vector2VorDiv
| Subroutine : | |||
| xy_UCosLat(0:im-1,1:jm) : | real(8), intent(in)
| ||
| xy_VCosLat(0:im-1,1:jm) : | real(8), intent(in)
| ||
| w_Vor((nm+1)*(nm+1)) : | real(8), intent(out)
| ||
| w_Div((nm+1)*(nm+1)) : | real(8), intent(out)
|
速度場(格子データ)から渦度・発散(スペクトルデータ)に (正)変換する(1 層用)
スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
subroutine w_VectorCosLat2VorDiv(xy_UCosLat, xy_VCosLat, w_Vor, w_Div)
!
! 速度場(格子データ)から渦度・発散(スペクトルデータ)に
! (正)変換する(1 層用)
!
! スペクトル変換を用いず微分を計算するために, 変換回数が 2 回ですむ.
!
! ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ
! D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
!
real(8), intent(in) :: xy_UCosLat(0:im-1,1:jm)
!(in) 速度経度成分 * cos(lat)
real(8), intent(in) :: xy_VCosLat(0:im-1,1:jm)
!(in) 速度緯度成分 * cos(lat)
real(8), intent(out) :: w_Vor((nm+1)*(nm+1))
!(out) 流線関数
real(8), intent(out) :: w_Div((nm+1)*(nm+1))
!(out) 速度ポテンシャル
if ( .not. w_base_initialize ) then
call MessageNotify('E','w_VectorCosLat2VorDiv', 'w_base_module not initialize yet.')
endif
!
! ζ = 1/cosφ∂v/∂λ - 1/cosφ ∂(u cosφ)/∂φ
!
w_Vor = w_xy(xy_VCosLat,ipow=2,iflag=-1) - w_xy(xy_UCosLat,ipow=2,iflag=1)
!
! D = 1/cosφ∂u/∂λ + 1/cosφ ∂(v cosφ)/∂φ
!
w_Div = w_xy(xy_UCosLat,ipow=2,iflag=-1) + w_xy(xy_VCosLat,ipow=2,iflag=1)
end subroutine w_VectorCosLat2VorDiv
| Subroutine : |
モジュールの終了処理(割り付け配列の解放)をおこなう.
実際の使用には上位サブルーチン w_Finalize を用いること.
subroutine w_base_Finalize
!
! モジュールの終了処理(割り付け配列の解放)をおこなう.
!
! 実際の使用には上位サブルーチン w_Finalize を用いること.
!
if ( .not. w_base_initialize ) then
call MessageNotify('W','w_base_Finalize', 'w_base_module not initialized yet')
return
endif
if ( np .gt. 1 ) deallocate(wv)
deallocate(t) ! 変換用配列
deallocate(ip) ! 変換用配列
deallocate(p) ! 変換用配列
deallocate(r) ! 変換用配列
deallocate(ia) ! 変換用配列
deallocate(a) ! 変換用配列
deallocate(y) ! 変換用配列
deallocate(x_Lon) ! 格子点座標格納配列(経度)
deallocate(x_Lon_weight)
deallocate(xy_Lon)
deallocate(y_Lat)
deallocate(y_Lat_Weight) ! 格子点座標格納配列
deallocate(xy_Lat) ! 格子点座標格納配列
w_base_initialize = .false.
call MessageNotify('M','w_base_Finalize', 'w_base_module (2013/02/23) is finalized')
end subroutine w_base_Finalize
| Subroutine : | |||
| n_in : | integer,intent(in)
| ||
| i_in : | integer,intent(in)
| ||
| j_in : | integer,intent(in)
| ||
| np_in : | integer,intent(in), optional
|
スペクトル変換の格子点数, 波数および OPENMP 使用時の 最大スレッド数を設定する.
実際の使用には上位サブルーチン w_Initial を用いること.
subroutine w_base_Initial(n_in,i_in,j_in,np_in)
!
! スペクトル変換の格子点数, 波数および OPENMP 使用時の
! 最大スレッド数を設定する.
!
! 実際の使用には上位サブルーチン w_Initial を用いること.
!
integer,intent(in) :: i_in !(in) 格子点数(東西)
integer,intent(in) :: j_in !(in) 格子点数(南北)
integer,intent(in) :: n_in !(in) 切断全波数
integer,intent(in), optional :: np_in !(in) OPENMP での最大スレッド数
integer :: i, j
im = i_in
jm = j_in
nm = n_in
if ( present(np_in) )then
np = np_in
if ( np .gt. 1 ) then
openmp = .true.
allocate(wv((nm+4)*(nm+3)*np))
call MessageNotify('M','w_base_Initial', 'OpenMP computation was set up.')
else
openmp = .false.
endif
else
openmp = .false.
endif
if ( im/2*2 .eq. im ) then
id = im+1
else
id = im
endif
if ( openmp ) then
jd = jm
else if ( jm/2*2 .eq. jm ) then
jd = jm+1
else
jd = jm
endif
allocate(t(im*2)) ! 変換用配列
allocate(ip(((nm+1)/2+nm+1)*2)) ! 変換用配列
allocate(p(((nm+1)/2+nm+1)*jm)) ! 変換用配列
allocate(r(((nm+1)/2*2+3)*(nm/2+1))) ! 変換用配列
allocate(ia((nm+1)*(nm+1)*4)) ! 変換用配列
allocate(a((nm+1)*(nm+1)*6)) ! 変換用配列
allocate(y(jm/2,4)) ! 変換用配列
if ( openmp ) then
iw=(im+nm+1)*3*jm/2
else
iw=max((nm+4)*(nm+3),jd*3*(nm+1),jd*im)
endif
allocate(x_Lon(0:im-1)) ! 格子点座標格納配列(経度)
allocate(x_Lon_Weight(0:im-1))
allocate(xy_Lon(0:im-1,1:jm))
allocate(y_Lat(1:jm))
allocate(y_Lat_Weight(1:jm)) ! 格子点座標格納配列
allocate(xy_Lat(0:im-1,1:jm)) ! 格子点座標格納配列
call sninit(nm,im,jm,it,t,y,ip,p,r,ia,a)
do i=0,im-1
x_Lon(i) = 2*pi/im*i ! 経度座標
x_Lon_Weight(i) = 2*pi/im ! 経度座標重み
enddo
do j=1,jm/2
y_Lat(jm/2+j) = asin(y(j,1)) ! 緯度座標
y_Lat(jm/2-j+1) = -asin(y(j,1)) ! 緯度座標
y_Lat_Weight(jm/2+j) = 2*y(j,2) ! 緯度重み(Gauss grid)
y_Lat_Weight(jm/2-j+1) = 2*y(j,2) ! 緯度重み(Gauss grid)
enddo
do j=1,jm
xy_Lon(:,j) = x_Lon
enddo
do i=0,im-1
xy_Lat(i,:) = y_Lat
enddo
w_base_initialize = .true.
call MessageNotify('M','w_base_initial', 'w_base_module (2013/02/23) is initialized')
end subroutine w_base_Initial
| Function : | |||
| w_xy((nm+1)*(nm+1)) : | real(8)
| ||
| xy_data(0:im-1,1:jm) : | real(8), intent(in)
| ||
| ipow : | integer, intent(in), optional
| ||
| iflag : | integer, intent(in), optional
|
格子データからスペクトルデータへ(正)変換する(1 層用).
function w_xy(xy_data,ipow,iflag)
!
! 格子データからスペクトルデータへ(正)変換する(1 層用).
!
real(8) :: w_xy((nm+1)*(nm+1))
!(out) スペクトルデータ
real(8), intent(in) :: xy_data(0:im-1,1:jm)
!(in) 格子点データ
integer, intent(in), optional :: ipow
!(in) 変換時に同時に作用させる 1/cosφ の次数. 省略時は 0.
integer, intent(in), optional :: iflag
! 変換の種類
! 0 : 通常の正変換
! -1 : 経度微分を作用させた正変換
! 1 : 緯度微分 1/cosφ・∂(f cos^2φ)/∂φ を作用させた正変換
! 2 : sinφを作用させた正変換
! 省略時は 0.
real(8) :: xy_work(id,jd) ! w_xy,xy_w 変換用配列
real(8) :: q(((nm+1)/2+nm+1)*jm) ! 作業配列
real(8) :: ws(iw),ww(iw) ! 作業用配列
integer, parameter :: ipow_default = 0 ! スイッチデフォルト値
integer, parameter :: iflag_default = 0 ! スイッチデフォルト値
integer ipval, ifval, i, j
logical :: first=.true. ! 初回判定スイッチ
save first
if ( .not. w_base_initialize ) then
call MessageNotify('E','w_xy', 'w_base_module not initialize yet.')
endif
if (present(ipow)) then
ipval = ipow
else
ipval = ipow_default
endif
if (present(iflag)) then
ifval = iflag
else
ifval = iflag_default
endif
do j=1,jm
do i=0,im-1
xy_work(i+1,j)=xy_data(i,j)
enddo
enddo
if ( openmp ) then
if ( first ) then
call MessageNotify('M','w_xy', 'OpenMP routine SNTGOS/SNPACK is used for spherical harmonic transformation.')
endif
call sntgos(nm,im,id,jm,1,xy_work,w_xy, it,t,y,ip,p,r,ia,a,q,ws,ww,wv,ipval,ifval)
else
call sntg2s(nm,im,id,jm,jd,1,xy_work,w_xy, it,t,y,ip,p,r,ia,a,q,ws,ww,ipval,ifval)
endif
first = .false.
end function w_xy
| Function : | |||
| xy_w(0:im-1,1:jm) : | real(8)
| ||
| w_data((nm+1)*(nm+1)) : | real(8), intent(in)
| ||
| ipow : | integer, intent(in), optional
| ||
| iflag : | integer, intent(in), optional
|
スペクトルデータから格子データへ変換する(1 層用).
function xy_w(w_data,ipow,iflag)
!
! スペクトルデータから格子データへ変換する(1 層用).
!
real(8) :: xy_w(0:im-1,1:jm)
!(out) 格子点データ
real(8), intent(in) :: w_data((nm+1)*(nm+1))
!(in) スペクトルデータ
integer, intent(in), optional :: ipow
!(in) 作用させる 1/cosφ の次数. 省略時は 0.
integer, intent(in), optional :: iflag
!(in) 変換の種類
! 0 : 通常の正変換
! -1 : 経度微分を作用させた逆変換
! 1 : 緯度微分 cosφ・∂/∂φ を作用させた逆変換
! 2 : sinφを作用させた逆変換
! 省略時は 0.
!
real(8) :: xy_work(id,jd) ! w_xy,xy_w 変換用配列
real(8) :: q(((nm+1)/2+nm+1)*jm) ! 作業配列
real(8) :: ws(iw),ww(iw) ! 作業用配列
integer, parameter :: ipow_default = 0
integer, parameter :: iflag_default = 0
integer ipval, ifval, i, j
logical :: first=.true. ! 初回判定スイッチ
save first
if ( .not. w_base_initialize ) then
call MessageNotify('E','xy_w', 'w_base_module not initialize yet.')
endif
if (present(ipow)) then
ipval = ipow
else
ipval = ipow_default
endif
if (present(iflag)) then
ifval = iflag
else
ifval = iflag_default
endif
if ( openmp ) then
if ( first ) then
call MessageNotify('M','xy_w', 'OpenMP routine SNTSOG/SNPACK is used for spherical harmonic transformation.')
endif
call sntsog(nm,im,id,jm,1,w_data,xy_work, it,t,y,ip,p,r,ia,a,q,ws,ww,wv,ipval,ifval)
else
call snts2g(nm,im,id,jm,jd,1,w_data,xy_work, it,t,y,ip,p,r,ia,a,q,ws,ww,ipval,ifval)
endif
do j=1,jm
do i=0,im-1
xy_w(i,j) = xy_work(i+1,j)
enddo
enddo
first = .false.
end function xy_w