Class | intavr_operate |
In: |
shared/intavr_operate.f90
|
Note that Japanese and English are described in parallel.
積分で用いる座標重みを考慮した積分や平均操作のための関数を提供します. SPMODEL ライブラリ の w_integral_module.f90 を参考に作成しました.
Functions for integral or average operation with weight for integration are provided This program is created referring to "w_integral_module.f90" in SPMODEL library
Create : | INTAVROPR 型変数の初期設定 |
Close : | INTAVROPR 型変数の終了処理 |
PutLine : | INTAVROPR 型変数に格納されている情報の印字 |
initialized : | INTAVROPR 型変数が初期設定されているか否か |
IntLonLat_xy : | 緯度経度積分 |
y_IntLon_xy, IntLon_x : | 経度積分 |
x_IntLat_xy, IntLat_y : | 緯度積分 |
AvrLonLat_xy : | 緯度経度平均 |
y_AvrLon_xy, AvrLon_x : | 経度平均 |
x_AvrLat_xy, AvrLat_y : | 緯度平均 |
——————— : | ——————— |
Create : | Constructor of "INTAVROPR" |
Close : | Deconstructor of "INTAVROPR" |
PutLine : | Print information of "INTAVROPR" |
initialized : | Check initialization of "INTAVROPR" |
y_IntLon_xy, IntLon_x : | Meridional integral |
x_IntLat_xy, IntLat_y : | Zonal integral |
AvrLonLat_xy : | Zonal and meridional average |
y_AvrLon_xy, AvrLon_x : | Meridional average |
x_AvrLat_xy, AvrLat_y : | Zonal average |
始めに, INTAVROPR 型の変数を定義し, Create で初期設定を行います. その後, 積分や平均操作のための関数を利用してください. INTAVROPR 型の変数の終了処理には Close を用いてください.
First, initialize "INTAVROPR" by "Create". Then, use functions for integral and average. In order to terminate "INTAVROPR", use "Close".
Derived_Types | [] | INTAVROPR |
Function : | |
AvrLat_y : | real(DP) |
y_Data(0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
1 次元緯度格子点データの緯度方向平均(1 層用).
実際には格子点データ各点毎に y_Lat_Weight を掛けた 総和を計算し, y_Lat_Weight の総和で割ることで 平均している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Meridonal mean of 1-dimensional (latitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "y_Lat_Weight" and deviding by the sum total of "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function AvrLat_y( y_Data, intavr_opr ) ! ! 1 次元緯度格子点データの緯度方向平均(1 層用). ! ! 実際には格子点データ各点毎に y_Lat_Weight を掛けた ! 総和を計算し, y_Lat_Weight の総和で割ることで ! 平均している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Meridonal mean of 1-dimensional (latitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "y_Lat_Weight" ! and deviding by the sum total of "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: y_Data (0:intavr_opr%jmax-1) real(DP):: AvrLat_y !----------------------------------- ! 作業変数 ! Work variables real(DP):: y_Lat_Weight(0:intavr_opr%jmax-1) ! 緯度積分用座標重み. ! Weight for integration in latitude !!$ character(*), parameter:: subname = 'AvrLat_y' continue y_Lat_Weight = intavr_opr % y_Lat_Weight AvrLat_y = IntLat_y( y_Data, intavr_opr ) / sum( y_Lat_Weight ) end function AvrLat_y
Function : | |||||
AvrLonLat_xy : | real(DP)
| ||||
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) | ||||
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの全領域平均(1 層用).
実際には格子点データ各点毎に x_Lon_Weight, y_Lat_Weight を掛けた 総和を計算し, x_Lon_Weight * y_Lat_Weight の総和で割ることで 平均している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Global mean of 2-dimensional (latitude and longitude) grid data.
Practically, the mean grid data is calculated by multiplying in each grid "x_Lon_Weight" and "y_Lat_Weight" and deviding by the sum total of "x_Lon_Weight" * "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function AvrLonLat_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの全領域平均(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight, y_Lat_Weight を掛けた ! 総和を計算し, x_Lon_Weight * y_Lat_Weight の総和で割ることで ! 平均している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Global mean of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the mean grid data is calculated ! by multiplying in each grid "x_Lon_Weight" and "y_Lat_Weight" ! and deviding by the sum total of "x_Lon_Weight" * "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: AvrLonLat_xy !!$ character(*), parameter:: subname = 'AvrLonLat_xy' continue AvrLonLat_xy = AvrLon_x( x_AvrLat_xy( xy_Data, intavr_opr ), intavr_opr ) end function AvrLonLat_xy
Function : | |
AvrLon_x : | real(DP) |
x_Data(0:intavr_opr%imax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
1 次元経度格子点データの経度方向平均(1 層用).
実際には格子点データ各点毎に x_Lon_Weight を掛けた 総和を計算し, x_Lon_Weight の総和で割ることで 平均している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Zonal mean of 1-dimensional (longitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "x_Lon_Weight" and deviding by the sum total of "x_Lon_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function AvrLon_x( x_Data, intavr_opr ) ! ! 1 次元経度格子点データの経度方向平均(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight を掛けた ! 総和を計算し, x_Lon_Weight の総和で割ることで ! 平均している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Zonal mean of 1-dimensional (longitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "x_Lon_Weight" ! and deviding by the sum total of "x_Lon_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: x_Data (0:intavr_opr%imax-1) real(DP):: AvrLon_x !----------------------------------- ! 作業変数 ! Work variables real(DP):: x_Lon_Weight(0:intavr_opr%imax-1) ! 経度積分用座標重み. ! Weight for integration in longitude !!$ character(*), parameter:: subname = 'AvrLon_x' continue x_Lon_Weight = intavr_opr % x_Lon_Weight AvrLon_x = IntLon_x( x_Data, intavr_opr ) / sum( x_Lon_Weight ) end function AvrLon_x
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(inout) | ||
err : | logical, intent(out), optional
|
INTAVROPR 型の変数の終了処理を行います. なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Deconstructor of "INTAVROPR". Note that if intavr_opr is not initialized by "Create" yet, error is occurred.
Alias for IntAvrOperateClose
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(inout) | ||
imax : | integer, intent(in)
| ||
jmax : | integer, intent(in)
| ||
PI : | real(DP), intent(in)
| ||
x_Lon_Weight(0:imax-1) : | real(DP), intent(in), optional
| ||
y_Lat_Weight(0:jmax-1) : | real(DP), intent(in), optional
| ||
nmlfile : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
INTAVROPR 型の変数の初期設定を行います. 他のサブルーチンを使用する前に必ずこのサブルーチンによって INTAVROPR 型の変数を初期設定してください.
x_Lon_Weight, y_Lat_Weight には, それぞれ 経度方向, 緯度方向の積分のための座標重みを与えます. x_Lon_Weight の総和は 2 $ \pi $ , y_Lat_Weight の総和は 2 となることを想定しています.
なお, 与えられた intavr_opr が既に初期設定されている場合, プログラムはエラーを発生させます.
Constructor of "INTAVROPR". Initialize intavr_opr by this subroutine, before other procedures are used,
Give weight for integration in longitude to x_Lon_Weight, weight for integration in latitude to y_Lat_Weight. It is expected that the summation of x_Lon_Weight is 2 $ \pi $ , and y_Lat_Weight is 2.
Note that if intavr_opr is already initialized by this procedure, error is occurred.
Alias for IntAvrOperateCreate
Derived Type : | |||
initialized = .false. : | logical
| ||
imax : | integer
| ||
jmax : | integer
| ||
x_Lon_Weight(:) =>null() : | real(DP), pointer
| ||
y_Lat_Weight(:) =>null() : | real(DP), pointer
| ||
PI : | real(DP)
|
まず, Create で "INTAVROPR" 型の変数を初期設定して下さい. 初期設定された "INTAVROPR" 型の変数を再度利用する際には, Close によって終了処理を行ってください.
Initialize "INTAVROPR" variable by "Create" before usage. If you reuse "INTAVROPR" variable again for another application, terminate by "Close".
Function : | |
IntLat_y : | real(DP) |
y_Data(0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
1 次元緯度格子点データの緯度方向積分(1 層用).
実際には格子点データ各点毎に y_Lat_Weight を掛けた 総和を計算している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Meridonal integration of 1-dimensional (latitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function IntLat_y( y_Data, intavr_opr ) ! ! 1 次元緯度格子点データの緯度方向積分(1 層用). ! ! 実際には格子点データ各点毎に y_Lat_Weight を掛けた ! 総和を計算している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Meridonal integration of 1-dimensional (latitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: y_Data (0:intavr_opr%jmax-1) real(DP):: IntLat_y !----------------------------------- ! 作業変数 ! Work variables real(DP):: y_Lat_Weight(0:intavr_opr%jmax-1) ! 緯度積分用座標重み. ! Weight for integration in latitude !!$ character(*), parameter:: subname = 'IntLat_y' continue y_Lat_Weight = intavr_opr % y_Lat_Weight IntLat_y = sum( y_Data * y_Lat_Weight ) end function IntLat_y
Function : | |||||
IntLonLat_xy : | real(DP)
| ||||
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) | ||||
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの全領域積分(1 層用).
実際には格子点データ各点毎に x_Lon_Weight, y_Lat_Weight を掛けた 総和を計算している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Global integration of 2-dimensional (latitude and longitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "x_Lon_Weight" and "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function IntLonLat_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの全領域積分(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight, y_Lat_Weight を掛けた ! 総和を計算している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Global integration of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "x_Lon_Weight" and "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: IntLonLat_xy !!$ character(*), parameter:: subname = 'IntLonLat_xy' continue IntLonLat_xy = IntLon_x( x_IntLat_xy( xy_Data, intavr_opr ), intavr_opr ) end function IntLonLat_xy
Function : | |
IntLon_x : | real(DP) |
x_Data(0:intavr_opr%imax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
1 次元経度格子点データの経度方向積分(1 層用).
実際には格子点データ各点毎に x_Lon_Weight を掛けた 総和を計算している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Zonal integration of 1-dimensional (longitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "x_Lon_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function IntLon_x( x_Data, intavr_opr ) ! ! 1 次元経度格子点データの経度方向積分(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight を掛けた ! 総和を計算している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Zonal integration of 1-dimensional (longitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "x_Lon_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: x_Data (0:intavr_opr%imax-1) real(DP):: IntLon_x !----------------------------------- ! 作業変数 ! Work variables real(DP):: x_Lon_Weight(0:intavr_opr%imax-1) ! 経度積分用座標重み. ! Weight for integration in longitude !!$ character(*), parameter:: subname = 'IntLon_x' continue x_Lon_Weight = intavr_opr % x_Lon_Weight IntLon_x = sum( x_Data * x_Lon_Weight ) end function IntLon_x
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(in) | ||
unit : | integer, intent(in), optional
| ||
indent : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 intavr_opr に設定されている情報を印字します. デフォルトではメッセージは標準出力に出力されます. unit に装置番号を指定することで, 出力先を変更することが可能です.
Print information of intavr_opr. By default messages are output to standard output. Unit number for output can be changed by unit argument.
Alias for IntAvrOperatePutLine
Function : | |
result : | logical |
intavr_opr : | type(INTAVROPR), intent(in) |
intavr_opr が初期設定されている場合には .true. が, 初期設定されていない場合には .false. が返ります.
If intavr_opr is initialized, .true. is returned. If intavr_opr is not initialized, .false. is returned.
Alias for IntAvrOperateInitialized
Function : | |
x_AvrLat_xy(0:intavr_opr%imax-1) : | real(DP) |
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの緯度方向平均(1 層用).
実際には格子点データ各点毎に y_Lat_Weight を掛けた 総和を計算し, y_Lat_Weight の総和で割ることで 平均している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Meridional mean of 2-dimensional (latitude and longitude) grid data.
Practically, the mean grid data is calculated by multiplying in each grid "y_Lat_Weight" and deviding by the sum total of "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function x_AvrLat_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの緯度方向平均(1 層用). ! ! 実際には格子点データ各点毎に y_Lat_Weight を掛けた ! 総和を計算し, y_Lat_Weight の総和で割ることで ! 平均している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Meridional mean of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the mean grid data is calculated ! by multiplying in each grid "y_Lat_Weight" ! and deviding by the sum total of "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: x_AvrLat_xy (0:intavr_opr%imax-1) !----------------------------------- ! 作業変数 ! Work variables real(DP):: y_Lat_Weight(0:intavr_opr%jmax-1) ! 緯度積分用座標重み. ! Weight for integration in latitude !!$ character(*), parameter:: subname = 'x_AvrLat_xy' continue y_Lat_Weight = intavr_opr % y_Lat_Weight x_AvrLat_xy = x_IntLat_xy ( xy_Data, intavr_opr ) / sum( y_Lat_Weight ) end function x_AvrLat_xy
Function : | |
x_IntLat_xy(0:intavr_opr%imax-1) : | real(DP) |
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの緯度方向積分(1 層用).
実際には格子点データ各点毎に y_Lat_Weight を掛けた 総和を計算している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Meridional integration of 2-dimensional (latitude and longitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "y_Lat_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function x_IntLat_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの緯度方向積分(1 層用). ! ! 実際には格子点データ各点毎に y_Lat_Weight を掛けた ! 総和を計算している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Meridional integration of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "y_Lat_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: x_IntLat_xy (0:intavr_opr%imax-1) !----------------------------------- ! 作業変数 ! Work variables real(DP):: y_Lat_Weight(0:intavr_opr%jmax-1) ! 緯度積分用座標重み. ! Weight for integration in latitude integer:: jmax ! 緯度格子点数. ! Number of grid points in latitude integer:: j ! DO ループ用作業変数 ! Work variables for DO loop !!$ character(*), parameter:: subname = 'x_IntLat_xy' continue jmax = intavr_opr % jmax y_Lat_Weight = intavr_opr % y_Lat_Weight x_IntLat_xy = 0.0_DP do j = 0, jmax - 1 x_IntLat_xy = x_IntLat_xy + xy_Data (:,j) * y_Lat_Weight(j) enddo end function x_IntLat_xy
Function : | |
y_AvrLon_xy(0:intavr_opr%jmax-1) : | real(DP) |
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの経度方向平均(1 層用).
実際には格子点データ各点毎に x_Lon_Weight を掛けた 総和を計算し, x_Lon_Weight の総和で割ることで 平均している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Zonal mean of 2-dimensional (latitude and longitude) grid data.
Practically, the mean grid data is calculated by multiplying in each grid "x_Lon_Weight" and deviding by the sum total of "x_Lon_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function y_AvrLon_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの経度方向平均(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight を掛けた ! 総和を計算し, x_Lon_Weight の総和で割ることで ! 平均している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Zonal mean of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the mean grid data is calculated ! by multiplying in each grid "x_Lon_Weight" ! and deviding by the sum total of "x_Lon_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: y_AvrLon_xy (0:intavr_opr%jmax-1) !----------------------------------- ! 作業変数 ! Work variables real(DP):: x_Lon_Weight(0:intavr_opr%imax-1) ! 経度積分用座標重み. ! Weight for integration in longitude !!$ character(*), parameter:: subname = 'y_AvrLon_xy' continue x_Lon_Weight = intavr_opr % x_Lon_Weight y_AvrLon_xy = y_IntLon_xy( xy_Data, intavr_opr) / sum( x_Lon_Weight ) end function y_AvrLon_xy
Function : | |
y_IntLon_xy(0:intavr_opr%jmax-1) : | real(DP) |
xy_Data(0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) : | real(DP), intent(in) |
intavr_opr : | type(INTAVROPR), intent(in) |
2 次元緯度経度格子点データの経度方向積分(1 層用).
実際には格子点データ各点毎に x_Lon_Weight を掛けた 総和を計算している.
なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Zonal integration of 2-dimensional (latitude and longitude) grid data.
Practically, the sum total of grid data is calculated by multiplying in each grid "x_Lon_Weight".
If intavr_opr is not initialized by "Create" yet, error is occurred.
function y_IntLon_xy( xy_Data, intavr_opr ) ! ! 2 次元緯度経度格子点データの経度方向積分(1 層用). ! ! 実際には格子点データ各点毎に x_Lon_Weight を掛けた ! 総和を計算している. ! ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Zonal integration of 2-dimensional (latitude and longitude) ! grid data. ! ! Practically, the sum total of grid data is calculated ! by multiplying in each grid "x_Lon_Weight". ! ! If *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_types, only: DP implicit none type(INTAVROPR), intent(in):: intavr_opr real(DP), intent(in):: xy_Data (0:intavr_opr%imax-1, 0:intavr_opr%jmax-1) real(DP):: y_IntLon_xy (0:intavr_opr%jmax-1) !----------------------------------- ! 作業変数 ! Work variables integer:: imax ! 経度格子点数. ! Number of grid points in longitude real(DP):: x_Lon_Weight(0:intavr_opr%imax-1) ! 経度積分用座標重み. ! Weight for integration in longitude integer:: i ! DO ループ用作業変数 ! Work variables for DO loop !!$ character(*), parameter:: subname = 'y_IntLon_xy' continue imax = intavr_opr % imax x_Lon_Weight = intavr_opr % x_Lon_Weight y_IntLon_xy = 0.0_DP do i = 0, imax - 1 y_IntLon_xy = y_IntLon_xy + xy_Data (i,:) * x_Lon_Weight(i) enddo end function y_IntLon_xy
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(inout) | ||
err : | logical, intent(out), optional
|
INTAVROPR 型の変数の終了処理を行います. なお, 与えられた intavr_opr が Create によって初期設定 されていない場合, プログラムはエラーを発生させます.
Deconstructor of "INTAVROPR". Note that if intavr_opr is not initialized by "Create" yet, error is occurred.
subroutine IntAvrOperateClose( intavr_opr, err ) ! ! INTAVROPR 型の変数の終了処理を行います. ! なお, 与えられた *intavr_opr* が Create によって初期設定 ! されていない場合, プログラムはエラーを発生させます. ! ! Deconstructor of "INTAVROPR". ! Note that if *intavr_opr* is not initialized by "Create" yet, ! error is occurred. ! use dc_trace, only: BeginSub, EndSub use dc_string, only: PutLine, Printf use dc_types, only: DP, STRING, TOKEN, STDOUT use dc_error, only: StoreError, DC_NOERR, DC_ENOTINIT implicit none type(INTAVROPR), intent(inout):: intavr_opr logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. !----------------------------------- ! 作業変数 ! Work variables integer:: stat character(STRING):: cause_c character(*), parameter:: subname = 'IntAvrOperateClose' continue call BeginSub( subname ) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if ( .not. intavr_opr % initialized ) then stat = DC_ENOTINIT cause_c = 'INTAVROPR' goto 999 end if !----------------------------------------------------------------- ! "INTAVROPR" の設定の消去 ! Clear the settings for "INTAVROPR" !----------------------------------------------------------------- deallocate( intavr_opr % x_Lon_Weight ) deallocate( intavr_opr % y_Lat_Weight ) !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- intavr_opr % initialized = .false. 999 continue call StoreError( stat, subname, err, cause_c ) call EndSub( subname ) end subroutine IntAvrOperateClose
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(inout) | ||
imax : | integer, intent(in)
| ||
jmax : | integer, intent(in)
| ||
PI : | real(DP), intent(in)
| ||
x_Lon_Weight(0:imax-1) : | real(DP), intent(in), optional
| ||
y_Lat_Weight(0:jmax-1) : | real(DP), intent(in), optional
| ||
nmlfile : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
INTAVROPR 型の変数の初期設定を行います. 他のサブルーチンを使用する前に必ずこのサブルーチンによって INTAVROPR 型の変数を初期設定してください.
x_Lon_Weight, y_Lat_Weight には, それぞれ 経度方向, 緯度方向の積分のための座標重みを与えます. x_Lon_Weight の総和は 2 $ \pi $ , y_Lat_Weight の総和は 2 となることを想定しています.
なお, 与えられた intavr_opr が既に初期設定されている場合, プログラムはエラーを発生させます.
Constructor of "INTAVROPR". Initialize intavr_opr by this subroutine, before other procedures are used,
Give weight for integration in longitude to x_Lon_Weight, weight for integration in latitude to y_Lat_Weight. It is expected that the summation of x_Lon_Weight is 2 $ \pi $ , and y_Lat_Weight is 2.
Note that if intavr_opr is already initialized by this procedure, error is occurred.
subroutine IntAvrOperateCreate( intavr_opr, imax, jmax, PI, x_Lon_Weight, y_Lat_Weight, nmlfile, err ) ! ! INTAVROPR 型の変数の初期設定を行います. ! 他のサブルーチンを使用する前に必ずこのサブルーチンによって ! INTAVROPR 型の変数を初期設定してください. ! ! *x_Lon_Weight*, *y_Lat_Weight* には, それぞれ ! 経度方向, 緯度方向の積分のための座標重みを与えます. ! *x_Lon_Weight* の総和は 2 $ \pi $ , ! *y_Lat_Weight* の総和は 2 となることを想定しています. ! ! なお, 与えられた *intavr_opr* が既に初期設定されている場合, ! プログラムはエラーを発生させます. ! ! ! ! Constructor of "INTAVROPR". ! Initialize *intavr_opr* by this subroutine, ! before other procedures are used, ! ! Give weight for integration in longitude to *x_Lon_Weight*, ! weight for integration in latitude to *y_Lat_Weight*. ! It is expected that the summation of *x_Lon_Weight* is 2 $ \pi $ , ! and *y_Lat_Weight* is 2. ! ! Note that if *intavr_opr* is already initialized ! by this procedure, error is occurred. ! ! ! use dc_trace, only: BeginSub, EndSub use dc_string, only: PutLine, Printf use dc_types, only: DP, STRING, TOKEN, STDOUT use dc_present, only: present_and_not_empty, present_and_true use dc_message, only: MessageNotify use dc_error, only: StoreError, DC_NOERR, DC_EALREADYINIT, DC_EARGLACK, DC_ENEGATIVE, DC_ENOFILEREAD implicit none type(INTAVROPR), intent(inout):: intavr_opr integer, intent(in):: imax ! 経度格子点数. ! Number of grid points in longitude integer, intent(in):: jmax ! 緯度格子点数. ! Number of grid points in latitude real(DP), intent(in):: PI ! $ \pi $ . 円周率. Circular constant real(DP), intent(in), optional:: x_Lon_Weight(0:imax-1) ! 経度積分用座標重み. ! Weight for integration in longitude real(DP), intent(in), optional:: y_Lat_Weight(0:jmax-1) ! 緯度積分用座標重み. ! Weight for integration in latitude character(*), intent(in), optional:: nmlfile ! NAMELIST ファイルの名称. ! この引数に空文字以外を与えた場合, ! 指定されたファイルから ! NAMELIST 変数群を読み込みます. ! ファイルを読み込めない場合にはエラーを ! 生じます. ! ! NAMELIST 変数群の詳細に関しては ! NAMELIST#intavr_operate_nml ! を参照してください. ! ! NAMELIST file name. ! If nonnull character is specified to ! this argument, ! NAMELIST group name is loaded from the ! file. ! If the file can not be read, ! an error occurs. ! ! See "NAMELIST#intavr_operate_nml" ! for details about a NAMELIST group. ! logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. !----------------------------------- ! 作業変数 ! Work variables integer:: stat character(STRING):: cause_c character(*), parameter:: subname = 'IntAvrOperateCreate' continue call BeginSub( subname, version ) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if ( intavr_opr % initialized ) then stat = DC_EALREADYINIT cause_c = 'INTAVROPR' goto 999 end if !----------------------------------------------------------------- ! 引数の正当性のチェック ! Validation of arguments !----------------------------------------------------------------- if (imax < 1) then stat = DC_ENEGATIVE cause_c = 'imax' goto 999 end if if (jmax < 1) then stat = DC_ENEGATIVE cause_c = 'jmax' goto 999 end if !----------------------------------------------------------------- ! 波数・格子点の設定 ! Configure wave number and grid point !----------------------------------------------------------------- intavr_opr % imax = imax intavr_opr % jmax = jmax !----------------------------------------------------------------- ! 円周率の設定 ! Configure PI !----------------------------------------------------------------- intavr_opr % PI = PI !----------------------------------------------------------------- ! 積分用座標重みの設定 ! Configure weight for integration !----------------------------------------------------------------- allocate( intavr_opr % x_Lon_Weight (0:intavr_opr % imax-1) ) allocate( intavr_opr % y_Lat_Weight (0:intavr_opr % jmax-1) ) if ( present(x_Lon_Weight) ) then intavr_opr % x_Lon_Weight = x_Lon_Weight else intavr_opr % x_Lon_Weight = 2.0_DP * PI / imax end if if ( present(y_Lat_Weight) ) then intavr_opr % y_Lat_Weight = y_Lat_Weight else intavr_opr % y_Lat_Weight = 2.0_DP / jmax end if !----------------------------------------------------------------- ! "INTAVROPR" の設定 ! Configure the settings for "INTAVROPR" !----------------------------------------------------------------- !------------------------- ! デフォルト値 ! Default values !!$ intavr_opr % param_r = 0.0_DP !!$ intavr_opr % param_c = 'hogehoge' !------------------------- ! オプショナル引数からの値 ! Values from optional arguments !!$ intavr_opr % param_i = param_i !!$ if ( present(param_r) ) intavr_opr % param_r = param_r !!$ if ( present(param_c) ) intavr_opr % param_c = param_c !------------------------- ! NAMELIST からの値 ! Values from NAMELIST !!$ if ( present_and_not_empty(nmlfile) ) then !!$ call MessageNotify( 'M', subname, & !!$ & 'Loading NAMELIST file "%c" ...', & !!$ & c1=trim(nmlfile) ) !!$ call NmlRead ( nmlfile = nmlfile, & ! (in) !!$ & param_i = intavr_opr % param_i, & ! (inout) !!$ & param_r = intavr_opr % param_r, & ! (inout) !!$ & param_c_ = intavr_opr % param_c, & ! (inout) !!$ & err = err ) ! (out) !!$ if ( present_and_true(err) ) then !!$ call MessageNotify( 'W', subname, & !!$ & '"%c" can not be read.', & !!$ & c1=trim(nmlfile) ) !!$ stat = DC_ENOFILEREAD !!$ cause_c = nmlfile !!$ goto 999 !!$ end if !!$ end if !----------------------------------------------------------------- ! 設定値の正当性のチェック ! Validate setting values !----------------------------------------------------------------- !!$ if ( intavr_opr % param_i < 0 ) then !!$ stat = DC_ENEGATIVE !!$ cause_c = 'param_i' !!$ goto 999 !!$ end if !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- intavr_opr % initialized = .true. 999 continue call StoreError( stat, subname, err, cause_c ) call EndSub( subname ) end subroutine IntAvrOperateCreate
Function : | |
result : | logical |
intavr_opr : | type(INTAVROPR), intent(in) |
intavr_opr が初期設定されている場合には .true. が, 初期設定されていない場合には .false. が返ります.
If intavr_opr is initialized, .true. is returned. If intavr_opr is not initialized, .false. is returned.
logical function IntAvrOperateInitialized( intavr_opr ) result(result) ! ! *intavr_opr* が初期設定されている場合には .true. が, ! 初期設定されていない場合には .false. が返ります. ! ! If *intavr_opr* is initialized, .true. is returned. ! If *intavr_opr* is not initialized, .false. is returned. ! implicit none type(INTAVROPR), intent(in):: intavr_opr continue result = intavr_opr % initialized end function IntAvrOperateInitialized
Subroutine : | |||||||||||
nmlfile : | character(*), intent(in)
| ||||||||||
err : | logical, intent(out), optional
|
NAMELIST ファイル nmlfile から値を入力するための 内部サブルーチンです. Create 内で呼び出されることを 想定しています.
値が NAMELIST ファイル内で指定されていない場合には, 入力された値がそのまま返ります.
なお, nmlfile に空文字が与えられた場合, または 与えられた nmlfile を読み込むことができない場合, プログラムはエラーを発生させます.
This is an internal subroutine to input values from NAMELIST file nmlfile. This subroutine is expected to be called by "Create".
A value not specified in NAMELIST file is returned without change.
If nmlfile is empty, or nmlfile can not be read, error is occurred.
subroutine IntAvrOperateNmlRead( nmlfile, err ) ! ! NAMELIST ファイル *nmlfile* から値を入力するための ! 内部サブルーチンです. Create 内で呼び出されることを ! 想定しています. ! ! 値が NAMELIST ファイル内で指定されていない場合には, ! 入力された値がそのまま返ります. ! ! なお, *nmlfile* に空文字が与えられた場合, または ! 与えられた *nmlfile* を読み込むことができない場合, ! プログラムはエラーを発生させます. ! ! This is an internal subroutine to input values from ! NAMELIST file *nmlfile*. This subroutine is expected to be ! called by "Create". ! ! A value not specified in NAMELIST file is returned ! without change. ! ! If *nmlfile* is empty, or *nmlfile* can not be read, ! error is occurred. ! use dc_trace, only: BeginSub, EndSub use dc_string, only: PutLine, Printf use dc_types, only: DP, STRING, TOKEN, STDOUT use dc_iounit, only: FileOpen use dc_message, only: MessageNotify use dc_present, only: present_and_true use dc_error, only: StoreError, DC_NOERR, DC_ENOFILEREAD implicit none character(*), intent(in):: nmlfile ! NAMELIST ファイルの名称. ! NAMELIST file name !!$ integer, intent(inout):: param_i !!$ real(DP), intent(inout):: param_r !!$ character(*), intent(inout):: param_c_ !!$ character(TOKEN):: param_c logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. !!$ namelist /intavr_operate_nml/ & !!$ & param_i, param_r, param_c ! intavr_operate モジュール用 ! NAMELIST 変数群名. ! ! intavr_operate#Create を使用する際に, ! オプショナル引数 *nmlfile* へ NAMELIST ! ファイル名を指定することで, そのファイルから ! この NAMELIST 変数群を読み込みます. ! ! NAMELIST group name for ! "intavr_operate" module. ! ! If a NAMELIST filename is specified to ! an optional argument *nmlfile* ! when "intavr_operate#Create" is used, ! this NAMELIST group is loaded from ! the file. !----------------------------------- ! 作業変数 ! Work variables integer:: stat character(STRING):: cause_c integer:: unit_nml ! NAMELIST ファイルオープン用装置番号. ! Unit number for NAMELIST file open !!$ integer:: iostat_nml ! NAMELIST 読み込み時の IOSTAT. !!$ ! IOSTAT of NAMELIST read character(*), parameter:: subname = 'IntAvrOperateNmlRead' continue call BeginSub( subname ) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 文字型引数を NAMELIST 変数群へ代入 ! Substitute character arguments to NAMELIST group !----------------------------------------------------------------- !!$ param_c = param_c_ !---------------------------------------------------------------- ! NAMELIST ファイルのオープン ! Open NAMELIST file !---------------------------------------------------------------- call FileOpen( unit = unit_nml, file = nmlfile, mode = 'r', err = err ) ! (out) if ( present_and_true(err) ) then stat = DC_ENOFILEREAD cause_c = nmlfile goto 999 end if !----------------------------------------------------------------- ! NAMELIST 変数群の取得 ! Get NAMELIST group !----------------------------------------------------------------- !!$ read( unit = unit_nml, & ! (in) !!$ & nml = intavr_operate_nml, iostat = iostat_nml ) ! (out) !!$ if ( iostat_nml == 0 ) then !!$ call MessageNotify( 'M', subname, & !!$ & 'NAMELIST group "%c" is loaded from "%c".', & !!$ & c1='intavr_operate_nml', c2=trim(nmlfile) ) !!$ write(STDOUT, nml = intavr_operate_nml) !!$ else !!$ call MessageNotify( 'W', subname, & !!$ & 'NAMELIST group "%c" is not found in "%c" (iostat=%d).', & !!$ & c1='intavr_operate_nml', c2=trim(nmlfile), & !!$ & i=(/iostat_nml/) ) !!$ end if close( unit_nml ) !----------------------------------------------------------------- ! NAMELIST 変数群を文字型引数へ代入 ! Substitute NAMELIST group to character arguments !----------------------------------------------------------------- !!$ param_c_ = param_c !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- 999 continue call StoreError( stat, subname, err, cause_c ) call EndSub( subname ) end subroutine IntAvrOperateNmlRead
Subroutine : | |||
intavr_opr : | type(INTAVROPR), intent(in) | ||
unit : | integer, intent(in), optional
| ||
indent : | character(*), intent(in), optional
| ||
err : | logical, intent(out), optional
|
引数 intavr_opr に設定されている情報を印字します. デフォルトではメッセージは標準出力に出力されます. unit に装置番号を指定することで, 出力先を変更することが可能です.
Print information of intavr_opr. By default messages are output to standard output. Unit number for output can be changed by unit argument.
subroutine IntAvrOperatePutLine( intavr_opr, unit, indent, err ) ! ! 引数 *intavr_opr* に設定されている情報を印字します. ! デフォルトではメッセージは標準出力に出力されます. ! *unit* に装置番号を指定することで, 出力先を変更することが可能です. ! ! Print information of *intavr_opr*. ! By default messages are output to standard output. ! Unit number for output can be changed by *unit* argument. ! use dc_trace, only: BeginSub, EndSub use dc_string, only: PutLine, Printf use dc_types, only: DP, STRING, TOKEN, STDOUT use dc_error, only: StoreError, DC_NOERR, DC_ENOTINIT implicit none type(INTAVROPR), intent(in):: intavr_opr integer, intent(in), optional:: unit ! 出力先の装置番号. ! デフォルトの出力先は標準出力. ! ! Unit number for output. ! Default value is standard output. character(*), intent(in), optional:: indent ! 表示されるメッセージの字下げ. ! ! Indent of displayed messages. logical, intent(out), optional:: err ! 例外処理用フラグ. ! デフォルトでは, この手続き内でエラーが ! 生じた場合, プログラムは強制終了します. ! 引数 *err* が与えられる場合, ! プログラムは強制終了せず, 代わりに ! *err* に .true. が代入されます. ! ! Exception handling flag. ! By default, when error occur in ! this procedure, the program aborts. ! If this *err* argument is given, ! .true. is substituted to *err* and ! the program does not abort. !----------------------------------- ! 作業変数 ! Work variables integer:: stat character(STRING):: cause_c integer:: out_unit integer:: indent_len character(STRING):: indent_str character(*), parameter:: subname = 'IntAvrOperatePutLine' continue call BeginSub( subname ) stat = DC_NOERR cause_c = '' !----------------------------------------------------------------- ! 初期設定のチェック ! Check initialization !----------------------------------------------------------------- if ( present(unit) ) then out_unit = unit else out_unit = STDOUT end if indent_len = 0 indent_str = '' if ( present(indent) ) then if ( len(indent) /= 0 ) then indent_len = len(indent) indent_str(1:indent_len) = indent end if end if !----------------------------------------------------------------- ! "INTAVROPR" の設定の印字 ! Print the settings for "INTAVROPR" !----------------------------------------------------------------- if ( intavr_opr % initialized ) then call Printf(out_unit, indent_str(1:indent_len) // '#<INTAVROPR:: @initialized=%y', l=(/intavr_opr % initialized/)) call Printf(out_unit, indent_str(1:indent_len) // ' @imax=%d @jmax=%d', i=(/intavr_opr % imax, intavr_opr % jmax/) ) call Printf(out_unit, indent_str(1:indent_len) // ' @PI=%f', d=(/intavr_opr % PI/) ) call PutLine( intavr_opr % x_Lon_Weight, unit = out_unit, lbounds = lbound(intavr_opr % x_Lon_Weight), ubounds = ubound(intavr_opr % x_Lon_Weight), indent = indent_str(1:indent_len) // ' @x_Lon_Weight=' ) call PutLine( intavr_opr % y_Lat_Weight, unit = out_unit, lbounds = lbound(intavr_opr % y_Lat_Weight), ubounds = ubound(intavr_opr % y_Lat_Weight), indent = indent_str(1:indent_len) // ' @y_Lat_Weight=' ) call Printf(out_unit, indent_str(1:indent_len) // '>' ) else call Printf(out_unit, indent_str(1:indent_len) // '#<INTAVROPR:: @initialized=%y>', l=(/intavr_opr % initialized/)) end if !----------------------------------------------------------------- ! 終了処理, 例外処理 ! Termination and Exception handling !----------------------------------------------------------------- 999 continue call StoreError( stat, subname, err, cause_c ) call EndSub( subname ) end subroutine IntAvrOperatePutLine
Subroutine : | |||||||||||
nmlfile : | character(*), intent(in)
| ||||||||||
err : | logical, intent(out), optional
|
NAMELIST ファイル nmlfile から値を入力するための 内部サブルーチンです. Create 内で呼び出されることを 想定しています.
値が NAMELIST ファイル内で指定されていない場合には, 入力された値がそのまま返ります.
なお, nmlfile に空文字が与えられた場合, または 与えられた nmlfile を読み込むことができない場合, プログラムはエラーを発生させます.
This is an internal subroutine to input values from NAMELIST file nmlfile. This subroutine is expected to be called by "Create".
A value not specified in NAMELIST file is returned without change.
If nmlfile is empty, or nmlfile can not be read, error is occurred.
Alias for IntAvrOperateNmlRead
Constant : | |
version = ’$Name: dcpam4-20071012 $’ // ’$Id: intavr_operate.f90,v 1.6 2007/09/21 13:38:05 morikawa Exp $’ : | character(*), parameter |