!-- !---------------------------------------------------------------------- ! Copyright (c) 2016 Shin-ichi Takehiro. All rights reserved. !---------------------------------------------------------------------- !表題 ua_mpi_module_svpack ! ! spml/ua_mpi_module_svpack モジュールは球面上での 2 次元流体運動を ! 球面調和函数を用いたスペクトル法によって数値計算するための ! Fortran90 関数を提供する. ! ! 球面上の 1 層モデル用 w_module_svpack モジュールを多層モデル用に ! 拡張したものであり, 同時に複数個のスペクトルデータ, 格子点データに ! 対する変換が行える. ! ! ua_module_svpack は実際には基本変換, 微分計算, 積分・平均計算, ! スペクトル解析をそれぞれ担っている下部モジュール ua_base_module_sjpack, ! ua_deriv_module_svpack, wa_integral_module_svpack, ! wa_spectrum_module_svpack および 1 層用のモジュール w_module からなっている. ! ! 内部で ISPACK2 の SVPACK の Fortran77 サブルーチンを呼んでいる. ! スペクトルデータおよび格子点データの格納方法や変換の詳しい計算法に ! ついては ISPACK2/SVPACK のマニュアルを参照されたい. ! ! 関数, サブルーチンの名前と機能は wa_module のものと同じである. ! したがって use 文を wa_module から wa_module_svpack に ! 変更するだけで SVPACK の機能が使えるようになる. ! ! ただし l_nm, nm_l の使い方には注意されたい. wa_module の l_nm, nm_l は ! wa_Initial で初期化しなくとも用いることができる(結果が切断波数に依らない)が, ! wa_module_svpack のものは初期化したのちにしか使うことができない. ! !履歴 2009/09/06 竹広真一 wa_deriv_module より SVPACK 用に改造 ! 2009/09/20 竹広真一 使用上の注意を追加 ! 2013/02/12 竹広真一 w_StreamPotential2Vector, w_Vector2VorDiv, ! wa_StreamPotential2Vector, wa_Vector2VorDiv 導入 ! 2013/02/14 竹広真一 w_VectorCosLat2VorDiv, wa_VectorCosLat2VorDiv 導入 ! 2013/02/23 竹広真一 wa_Finalize 導入 ! 2016/04/21 竹広真一 svpack 用に改造 ! ! !++ module ua_mpi_module_svpack ! != ua_mpi_module_svpack ! ! Authors:: Shin-ichi Takehiro, Youhei SASAKI ! Version:: $Id$ ! Copyright&License:: See COPYRIGHT[link:../COPYRIGHT] ! !== 概要 ! ! spml/ua_mpi_module_svpack モジュールは球面上での 2 次元流体運動を ! 球面調和函数を用いたスペクトル法によって数値計算するための ! Fortran90 関数を提供する. ! ! 球面上の 1 層モデル用 w_module_svpack モジュールを多層モデル用に ! 拡張したものであり, 同時に複数個のスペクトルデータ, 格子点データに ! 対する変換が行える. ! ! ua_module_svpack は実際には基本変換, 微分計算, 積分・平均計算, ! スペクトル解析をそれぞれ担っている下部モジュール wa_base_module_sjpack, ! wa_deriv_module_svpack, wa_integral_module_svpack, ! wa_spectrum_module_svpack および 1 層用のモジュール w_module からなっている. ! ! 内部で ISPACK の SVPACK の Fortran77 サブルーチンを呼んでいる. ! スペクトルデータおよび格子点データの格納方法や変換の詳しい計算法に ! ついては ISPACK/SVPACK のマニュアルを参照されたい. ! ! 関数, サブルーチンの名前と機能は wa_module のものと同じである. ! したがって use 文を wa_module から wa_module_svpack に ! 変更するだけで SVPACK の機能が使えるようになる. ! ! ただし l_nm, nm_l の使い方には注意されたい. wa_module の l_nm, nm_l は ! wa_Initial で初期化しなくとも用いることができる(結果が切断波数に依らない)が, ! wa_module_svpack のものは初期化したのちにしか使うことができない. ! !=== 命名法 ! ! * 関数名の先頭 (ua_, nma_, na_, xyb_, xa_, ya_, w_, xy_, x_, y_, a_) は, ! 返す値の形を示している. ! wa_ :: 水平スペクトルデータの並んだ 2 次元配列(スペクトルデータの ! 並びは SNPACK/ISPACK に従ったもの) ! nma_ :: スペクトルデータの並んだ 3 次元配列 (スペクトルデータの並びは ! 全波数 n, 帯状波数 m で指定される 2 次元配列) ! na_ :: スペクトルデータの並んだ 2 次元配列 (スペクトルデータの並びは ! 全波数 n で指定される 1 次元配列) ! xya_ :: 2 次元格子点データの並んだ 3 次元配列 ! xa_ :: 経度方向 1 次元格子点データの並んだ 2 次元配列 ! ya_ :: 緯度方向 1 次元格子点データの並んだ 2 次元配列 ! ! * 関数名の間の文字列(DLon, GradLat, GradLat, DivLon, DivLat, Lapla, ! LaplaInv, Jacobian)は, その関数の作用を表している. ! ! * 関数名の最後 (_wa_wa, _wa, _xya, _xa, _ya, _w_w, _w, _xy, _x, _y) は, ! 入力変数の形スペクトルデータおよび格子点データであることを示している. ! _wa :: スペクトルデータの並んだ 2 次元配列 ! _wa_wa :: 2 つのスペクトルデータの並んだ 2 次元配列 ! _xya :: 2 次元格子点データの並んだ 3 次元配列 ! _xa :: 経度方向 1 次元格子点データの並んだ 2 次元配列 ! _ya :: 緯度方向 1 次元格子点データの並んだ 2 次元配列 ! !=== 各データの種類の説明 ! ! * xya : 2 次元格子点データの並んだ 3 次元配列. ! * 変数の種類と次元は real(8), dimension(0:im-1,1:jm,:). ! * im, jm はそれぞれ経度, 緯度座標の格子点数であり, サブルーチン ! wa_Initial にてあらかじめ設定しておく. ! * 扱う第 3 次元の大きさの最大値を wa_Initial で設定しておく. ! ! * wa : スペクトルデータの並んだ 2 次元配列. ! * 変数の種類と次元は real(8), dimension((nm+1)*(nm+1),:). ! * nm は球面調和函数の最大全波数であり, サブルーチン wa_Initial にて ! あらかじめ設定しておく. ! * スペクトルデータの格納のされ方は関数 ! l_nm, nm_l によって調べることができる. ! * 扱う第 3 次元の大きさの最大値を wa_Initial で設定しておく. ! ! * xa, ya : 経度, 緯度方向 1 次元格子点データ. ! * 変数の種類と次元はそれぞれ real(8), dimension(0:im-1,:) ! および real(8), dimension(1:jm,:). ! ! * nma : スペクトルデータの並んだ 3 次元配列. ! * 変数の種類と次元は real(8), dimension(0:nm,-nm:nm,:). ! * 第 1 次元が水平全波数, 第 2 次元が帯状波数を表す. ! * nm は球面調和函数の最大全波数であり, ! サブルーチン wa_Initial にてあらかじめ設定しておく. ! ! * na : スペクトルデータの並んだ 2 次元配列. ! * 変数の種類と次元は real(8), dimension(0:nm,:). ! * 第 1 次元が水平全波数を表す.nm は球面調和函数の最大全波数であり, ! サブルーチン wa_Initial にてあらかじめ設定しておく. ! ! * wa_ で始まる関数が返す値はスペクトルデータの並んだ 2 次元配列に同じ. ! ! * nma_ で始まる関数が返す値はスペクトルデータの並んだ 3 次元配列に同じ. ! ! * na_ で始まる関数が返す値はスペクトルデータの並んだ 2 次元配列に同じ. ! ! * xya_ で始まる関数が返す値は 2 次元格子点データの並んだ 3 次元配列に ! 同じ. ! ! * xa_, ya_ で始まる関数が返す値は 1 次元格子点データの並んだ 2 次元 ! 配列に同じ. ! ! * スペクトルデータに対する微分等の作用とは, 対応する格子点データに ! 微分などを作用させたデータをスペクトル変換したものことである. ! ! !== 変数・手続き群の要約 ! !==== 初期化 ! ! wa_Initial :: スペクトル変換の格子点数, 波数, 領域の大きさ, ! :: および同時に計算するデータの個数の最大値設定 ! !==== 終了処理 ! ! wa_Finalize :: モジュールの終了処理(割り付け配列の解放)をおこなう. ! !==== 座標変数 ! ! x_Lon, y_Lat :: 格子点座標(緯度, 経度座標)を格納した 1 次元配列 ! x_Lon_Weight, y_Lat_Weight :: 重み座標を格納した 1 次元配列 ! xy_Lon, xy_Lat :: 格子点データの経度・緯度座標(X,Y) ! (格子点データ型 2 次元配列) ! !==== 基本変換 ! ! xya_wa, xy_w :: スペクトルデータから格子データへの変換(多層, 1 層用) ! wa_xya, w_xy :: 格子データからスペクトルデータへの変換(多層, 1 層用) ! l_nm, nm_l :: スペクトルデータの格納位置と全波数・帯状波数の変換 ! w_StreamPotential2Vector :: 流線ポテンシャルから速度場計算 ! w_Vector2VorDiv :: 速度場から渦度発散を計算 ! w_VectorCosLat2VorDiv :: 速度場から渦度発散を計算 ! wa_StreamPotential2Vector :: 流線ポテンシャルから速度場計算 ! wa_Vector2VorDiv :: 速度場から渦度発散を計算 ! wa_VectorCosLat2VorDiv :: 速度場から渦度発散を計算 ! !==== 微分 ! ! wa_Lapla_wa, w_Lapla_w :: スペクトルデータにラプラシアンを ! 作用させる(多層, 1 層用) ! rn :: スペクトルデータのラプラシアンを ! 計算するための係数 ! irm :: 経度微分演算用配列(未定義) ! wa_LaplaInv_wa, w_LaplaInv_w :: スペクトルデータにラプラシアンの逆変換を ! 作用させる(多層, 1 層用) ! wa_DLon_wa, w_DLon_w :: スペクトルデータに ! 経度微分∂/∂λを作用させる(多層, 1 層用) ! xya_GradLon_wa, xy_GradLon_w :: スペクトルデータに ! 勾配型経度微分 1/cosφ・∂/∂λ を ! 作用させる(多層, 1 層用) ! xya_GradLat_wa, xy_GradLat_w :: スペクトルデータに ! 勾配型緯度微分 ∂/∂φ を ! 作用させる(多層, 1 層用) ! wa_DivLon_xya, w_DivLon_xy :: 格子データに ! 発散型経度微分 1/cosφ・∂/∂λを ! 作用させる(多層, 1 層用) ! wa_DivLat_xya, w_DivLat_xy :: 格子データに ! 発散型緯度微分 1/cosφ・∂(g cosφ)/∂φを ! 作用させる (多層, 1 層用) ! wa_Div_xya_xya, w_Div_xy_xy :: ベクトル成分である 2 つの格子データに ! 発散を作用させる(多層, 1 層用) ! wa_Jacobian_wa_wa,w_Jacobian_w_w :: 2つのスペクトルデータからヤコビアンを ! 計算する(多層, 1 層用) ! !==== 微分(λ,μ=sinφ 座標) ! ! xya_GradLambda_wa, xy_GradLambda_w :: スペクトルデータに ! 勾配型経度微分∂/∂λを作用させる ! (多層, 1 層用) ! xya_GradMu_wa, xy_GradMu_w :: スペクトルデータに ! 勾配型緯度微分(1-μ^2)∂/∂μ ! を作用させる ! (多層, 1 層用) ! wa_DivLambda_xya,w_DivLambda_xy :: 格子データに発散型経度微分 ! 1 /(1-μ^2)・∂/∂λを作用させる ! (多層, 1 層用) ! ! wa_DivMu_xya,w_DivMu_xy :: 格子データに発散型緯度微分 ! ∂/∂μを作用させる(多層, 1 層用) ! !==== 補間計算 ! ! a_Interpolate_wa, Interpolate_w :: スペクトルデータから ! 任意の点の関数値を計算する. ! !==== 積分・平均 ! ! a_IntLonLat_xya, a_AvrLonLat_xya :: 2 次元格子点データの ! 全領域積分および平均(多層用) ! IntLonLat_xy, AvrLonLat_xy :: 2 次元格子点データの ! 全領域積分および平均(1 層用) ! ya_IntLon_xya, ya_AvrLon_xya :: 2 次元格子点データの ! 経度方向積分および平均(多層用) ! y_IntLon_xy, y_AvrLon_xy :: 2 次元格子点データの ! 経度方向積分および平均(1 層用) ! a_IntLon_xa, a_AvrLon_xa :: 1 次元(X)格子点データの ! 経度方向積分および平均(多層用) ! IntLon_x, AvrLon_x :: 1 次元(X)格子点データの ! 経度方向積分および平均(1 層用) ! xa_IntLat_xya, x_AvrLat_xy :: 2 次元格子点データの ! 緯度方向積分および平均(多層用) ! x_IntLat_xy, x_AvrLat_xy :: 2 次元格子点データの ! 緯度方向積分および平均(1 層用) ! a_IntLat_ya, a_AvrLat_ya :: 1 次元(Y)格子点データの ! 緯度方向積分および平均(多層用) ! IntLat_y, AvrLat_y :: 1 次元(Y)格子点データの ! 緯度方向積分および平均(1 層用) ! !==== スペクトル解析 ! ! nma_EnergyFromStreamfunc_wa,nm_EnergyFromStreamfunc_w :: ! 流線関数からエネルギースペクトルを計算する ! (水平全波数 n, 帯状波数 m 空間)(多層, 1 層用) ! ! na_EnergyFromStreamfunc_wa,n_EnergyFromStreamfunc_w :: ! 流線関数からエネルギースペクトルを計算する ! (水平全波数 n 空間) (多層, 1 層用) ! ! nma_EnstrophyFromStreamfunc_wa,nm_EnstrophyFromStreamfunc_w :: ! 流線関数からエンストロフィースペクトルを計算する ! (水平全波数 n, 帯状波数 m 空間)(多層, 1 層用) ! ! na_EnstrophyFromStreamfunc_wa,n_EnstrophyFromStreamfunc_w :: ! 流線関数からエンストロフィースペクトルを計算する(水平全波数 n 空間) ! (多層, 1 層用) ! ! w_spectrum_VMiss :: 欠損値 ! ! use dc_message, only : MessageNotify use w_module_svpack, only : w_Initial, w_Finalize, x_Lon, y_Lat, & x_Lon_Weight, y_Lat_Weight, xy_Lon, xy_Lat, xy_w, w_xy, & w_StreamPotential2Vector, w_Vector2VorDiv, w_VectorCosLat2VorDiv, & w_Lapla_w, w_LaplaInv_w, w_DLon_w, xy_GradLon_w, xy_GradLat_w, & w_DivLon_xy, w_DivLat_xy, w_Div_xy_xy, w_Jacobian_w_w, & xy_GradLambda_w, xy_GradMu_w, w_DivLambda_xy, w_DivMu_xy, & IntLonLat_xy, y_IntLon_xy, IntLon_x, x_IntLat_xy, IntLat_y, & AvrLonLat_xy, y_AvrLon_xy, AvrLon_x, x_AvrLat_xy, AvrLat_y, & Interpolate_u => Interpolate_w, & nm_EnergyFromStreamfunc_u => nm_EnergyFromStreamfunc_w, & n_EnergyFromStreamfunc_u => n_EnergyFromStreamfunc_w, & nm_EnstrophyFromStreamfunc_u => nm_EnstrophyFromStreamfunc_w,& n_EnstrophyFromStreamfunc_u => n_EnstrophyFromStreamfunc_w, & u_spectrum_VMiss => w_spectrum_VMiss ! use wa_base_module_svpack ! use wa_deriv_module_svpack use ua_base_mpi_module_svpack use ua_deriv_mpi_module_svpack use wa_integral_module_svpack use wa_interpolate_mpi_module_supack, only : & a_Interpolate_ua => a_Interpolate_wa use wa_spectrum_mpi_module_supack, only : & nma_EnergyFromStreamfunc_ua => nma_EnergyFromStreamfunc_wa, & na_EnergyFromStreamfunc_ua => na_EnergyFromStreamfunc_wa, & nma_EnstrophyFromStreamfunc_ua => nma_EnstrophyFromStreamfunc_wa, & na_EnstrophyFromStreamfunc_ua => na_EnstrophyFromStreamfunc_wa, & ua_spectrum_VMiss => wa_spectrum_VMiss implicit none private public ua_mpi_Initial ! 初期化 public ua_mpi_Finalize ! 終了処理 public nc, kc, k1, k2, kp_kl public x_Lon, y_Lat ! 格子座標 public x_Lon_Weight, y_Lat_Weight ! 格子座標重み public xy_Lon, xy_Lat ! 格子座標(im,jm) public xy_w, w_xy, l_nm, nm_l ! 変換関数 public w_StreamPotential2Vector ! 流線ポテンシャルから速度場計算 public w_Vector2VorDiv ! 速度場から渦度発散を計算 public w_VectorCosLat2VorDiv ! 速度場から渦度発散を計算 public xyb_ua, ua_xyb ! 変換関数 public wb_ua, ua_wb ! 変換関数 public ua_StreamPotential2VectorMPI ! 流線ポテンシャルから速度場計算 public ua_Vector2VorDivMPI ! 速度場から渦度発散を計算 public ua_VectorCosLat2VorDivMPI ! 速度場から渦度発散を計算 public rn ! ラプラシアンの係数配列 public w_Lapla_w, w_LaplaInv_w ! ラプラシアンと逆演算 public w_DLon_w ! 経度微分 public xy_GradLon_w, xy_GradLat_w ! 勾配型微分 public w_DivLon_xy, w_DivLat_xy ! 発散型微分 public w_Div_xy_xy ! 発散型微分 public w_Jacobian_w_w ! ヤコビアン public xy_GradLambda_w, xy_GradMu_w ! 勾配型微分(λ,μ座標) public w_DivLambda_xy, w_DivMu_xy ! 発散型微分(λ,μ座標) public ua_Lapla_ua, ua_LaplaInv_ua ! ラプラシアンと逆演算 public ua_DLon_ua ! 経度微分 public xyb_GradLon_ua, xyb_GradLat_ua ! 勾配型微分 public ua_DivLon_xyb, ua_DivLat_xyb ! 発散型微分 public ua_Div_xyb_xyb ! 発散型微分 public ua_JacobianMPI_ua_ua ! ヤコビアン public xyb_GradLambda_ua, xyb_GradMu_ua ! 勾配型微分(λ,μ座標) public ua_DivLambda_xyb, ua_DivMu_xyb ! 発散型微分(λ,μ座標) public a_Interpolate_ua, Interpolate_u ! 補間関数 public IntLonLat_xy ! 緯度経度積分 public y_IntLon_xy, IntLon_x ! 経度積分 public x_IntLat_xy, IntLat_y ! 緯度積分 public AvrLonLat_xy ! 緯度経度平均 public y_AvrLon_xy, AvrLon_x ! 経度平均 public x_AvrLat_xy, AvrLat_y ! 緯度平均 public a_IntLonLat_xya ! 緯度経度積分 public ya_IntLon_xya, a_IntLon_xa ! 経度積分 public xa_IntLat_xya, a_IntLat_ya ! 緯度積分 public a_AvrLonLat_xya ! 緯度経度平均 public ya_AvrLon_xya, a_AvrLon_xa ! 経度平均 public xa_AvrLat_xya, a_AvrLat_ya ! 緯度平均 public nma_EnergyFromStreamfunc_ua ! エネルギースペクトル ! (水平全波数 n, 帯状波数 m 空間) public na_EnergyFromStreamfunc_ua ! エネルギースペクトル ! (水平全波数 n 空間) public nma_EnstrophyFromStreamfunc_ua ! エンストロフィースペクトル ! (水平全波数 n, 帯状波数 m 空間) public na_EnstrophyFromStreamfunc_ua ! エンストロフィースペクトル ! (水平全波数 n 空間) public ua_spectrum_VMiss ! 欠損値 public nm_EnergyFromStreamfunc_u ! エネルギースペクトル ! (水平全波数 n, 帯状波数 m 空間) public n_EnergyFromStreamfunc_u ! エネルギースペクトル ! (水平全波数 n 空間) public nm_EnstrophyFromStreamfunc_u ! エンストロフィースペクトル ! (水平全波数 n, 帯状波数 m 空間) public n_EnstrophyFromStreamfunc_u ! エンストロフィースペクトル ! (水平全波数 n 空間) public u_spectrum_VMiss ! 欠損値 contains subroutine ua_mpi_Initial(n_in,i_in,j_in,k_in,np_in) ! ! スペクトル変換の格子点数, 波数, 最大データ数(層数)および ! OPENMP 使用時の最大スレッド数を設定する. ! ! 他の関数を呼ぶ前に, 最初にこのサブルーチンを呼んで初期設定を ! しなければならない. ! ! SNPACK 用 wa_initial との互換性のために引数 k_in が用意されているが, ! このパラメターによって同時に処理できる変数の数(層数)を制限される事はない. ! ! np_in に 1 より大きな値を指定すれば ISPACK の球面調和函数変換 ! OPENMP 並列計算ルーチンが用いられる. 並列計算を実行するには, ! 実行時に環境変数 OMP_NUM_THREADS を np_in 以下の数字に設定する等の ! システムに応じた準備が必要となる. ! ! np_in に 1 より大きな値を指定しなければ並列計算ルーチンは呼ばれない. ! integer,intent(in) :: i_in ! 格子点数(東西) integer,intent(in) :: j_in ! 格子点数(南北) integer,intent(in) :: n_in ! 切断波数 integer,intent(in) :: k_in ! 最大データ数(層数) integer,intent(in), optional :: np_in ! OPENMP での最大スレッド数 if ( present(np_in) ) then call MessageNotify('M','ua_mpi_Initial','Optional argument np is dummy') else call w_Initial(n_in,i_in,j_in) endif call ua_base_mpi_Initial(n_in,i_in,j_in,k_in) call ua_deriv_mpi_Initial call MessageNotify('M','ua_initial', & 'ua_module_svpack (2016/08/15) is initialized') end subroutine ua_mpi_Initial !--------------- 終了処理 ----------------- subroutine ua_mpi_Finalize ! ! モジュールの終了処理(割り付け配列の解放)をおこなう. ! ! 解像度を変更する際にはこのサブルーチンを呼んで終了処理を ! おこなったのちに再度 ua_mpi_Initial で初期設定しなければ ! ならない. ! call w_Finalize call ua_base_mpi_Finalize call ua_deriv_mpi_Finalize call MessageNotify('M','ua_mpi_Finalize', & 'ua_mpi_module_svpack (2016/08/15) is finalized') end subroutine ua_mpi_Finalize end module ua_mpi_module_svpack