!= phy_lscond モジュールのテストプログラム
!
!= Test program for "phy_lscond"
!
! Authors::   Yukiko YAMADA, Yasuhiro MORIKAWA
! Version::   $Id: phy_lscond_test.f90,v 1.3 2008-02-28 05:21:55 morikawa Exp $
! Tag Name::  $Name: dcpam4-20080427 $
! Copyright:: Copyright (C) GFD Dennou Club, 2007. All rights reserved.
! License::   See COPYRIGHT[link:../../../COPYRIGHT]
!
! <b>Note that Japanese and English are described in parallel.</b>
!
! phy_lscond モジュールの動作テストを行うためのプログラムです.
! このプログラムがコンパイルできること, および実行時に
! プログラムが正常終了することを確認してください.
!
! This program checks the operation of "phy_lscond" module.
! Confirm compilation and execution of this program.
!

program phy_lscond_test
  use phy_lscond, only: PHYLSC, Create, Close, &
    & PutLine, initialized, LScaleCond
  use constants, only: CONST, Create, Get
  use dc_test, only: AssertEqual, AssertGreaterThan, AssertLessThan
  use dc_types, only: DP, STRING
  use dc_string, only: StoA, PutLine
  use dc_args, only: ARGS, Open, HelpMsg, Option, Debug, Help, Strict, Close
  implicit none

  !---------------------------------------------------------
  !  実験の表題, モデルの名称, 所属機関名
  !  Title of a experiment, name of model, sub-organ
  !---------------------------------------------------------
  character(*), parameter:: title = &
    & 'phy_lscond_test $Name: dcpam4-20080427 $ :: ' // &
    & 'Test program of "phy_lscond" module'
  character(*), parameter:: source = &
    & 'dcpam4 ' // &
    & '(See http://www.gfd-dennou.org/library/dcpam)'
  character(*), parameter:: institution = &
    & 'GFD Dennou Club (See http://www.gfd-dennou.org)'

  !-------------------------------------------------------------------
  !  格子点数・最大全波数
  !  Grid points and maximum truncated wavenumber
  !-------------------------------------------------------------------
  integer:: imax = 32         ! 経度格子点数. 
                              ! Number of grid points in longitude
  integer:: jmax = 16         ! 緯度格子点数. 
                              ! Number of grid points in latitude
  integer:: kmax = 12         ! 鉛直層数. 
                              ! Number of vertical level

  !-----------------------------------------------------------------
  !  物理定数等の設定
  !  Configure physical constants etc.
  !-----------------------------------------------------------------
  type(CONST):: const_earth
  real(DP):: Grav      ! $ g $ .      重力加速度.     Gravitational acceleration
  real(DP):: Cp        ! $ C_p $ .    大気定圧比熱.   Specific heat of air at constant pressure
  real(DP):: EL        ! $ L $ .      水の凝結の潜熱. Latent heat of condensation of water vapor
  real(DP):: RVap      ! $ R_v $ .    水蒸気気体定数. Gas constant of water vapor
  real(DP):: EpsV      ! $ \epsilon_v $ .        水蒸気分子量比. Molecular weight ratio of water vapor
  real(DP):: ES0       ! $ e^{*} $ (273K) .      0 ℃での飽和蒸気圧. Saturated vapor pressure at 0 degrees C
  real(DP):: DelTime    ! $ \Delta t $ . タイムステップ. Time step

  !---------------------------------------------------------
  !  物理量
  !  Physical values
  !---------------------------------------------------------
  real(DP), allocatable:: xyz_Temp (:,:,:)
                              ! $ T $ .     温度. Temperature
  real(DP), allocatable:: xyz_QVap (:,:,:)
                              ! $ q $ .     比湿. Specific humidity
  real(DP), allocatable:: xyz_Press (:,:,:)
                              ! $ P_s $ . 地表面気圧 (整数レベル). 
                              ! Surface pressure (full level)
  real(DP), allocatable:: xyr_Press (:,:,:)
                              ! $ P_s $ . 地表面気圧 (半整数レベル). 
                              ! Surface pressure (half level)
  real(DP), allocatable:: xy_LscRain (:,:)
                              ! 大規模凝結スキームによる降水量. 
                              ! Precipitation by large scale condensation scheme
  real(DP), allocatable:: xyz_DLscTempDt (:,:,:)
                              ! 大規模凝結スキームによる温度変化率. 
                              ! Temperature tendency by large scale condensation scheme
  real(DP), allocatable:: xyz_DLscQVapDt (:,:,:)
                              ! 大規模凝結スキームによる比湿変化率. 
                              ! Specific humidity tendency by large scale condensation scheme

  !---------------------------------------------------------
  !  作業変数
  !  Work variables
  !---------------------------------------------------------
  type(ARGS):: arg            ! コマンドライン引数. 
                              ! Command line arguments
  logical:: OPT_namelist      ! -N, --namelist オプションの有無. 
                              ! Existence of '-N', '--namelist' option
  character(STRING):: VAL_namelist
                              ! -N, --namelist オプションの値. 
                              ! Value of '-N', '--namelist' option
  type(PHYLSC):: phy_lsc00, phy_lsc01, phy_lsc02, phy_lsc03
  logical:: err
  character(*), parameter:: subname = 'phy_lscond_test'
continue

  !---------------------------------------------------------
  !  コマンドライン引数の処理
  !  Command line arguments handling
  !---------------------------------------------------------
  call Open( arg )
  call HelpMsg( arg, 'Title', title )
  call HelpMsg( arg, 'Usage', &
    & './phy_lscond_test [Options]' )
  call HelpMsg( arg, 'Source', source )
  call HelpMsg( arg, 'Institution', institution )
  call Option( arg, StoA('-N', '--namelist'), &
    & OPT_namelist, VAL_namelist, help = 'NAMELIST filename' )
  call Debug( arg ) ; call Help( arg ) ; call Strict( arg, severe = .true. )
  call Close( arg )

  !---------------------------------------------------------
  !  物理定数の準備
  !  Prepare physical constants
  !---------------------------------------------------------
  call Create( const_earth ) ! (inout)

  DelTime = 600.0_DP

  call Get( constant = const_earth, &      ! (inout)
    & Grav = Grav, Cp = Cp, &              ! (out)
    & EL = EL, RVap = RVap, &              ! (out)
    & EpsV = EpsV, ES0 = ES0 )             ! (out)

  !---------------------------------------------------------
  !  初期設定テスト
  !  Initialization test
  !---------------------------------------------------------
  call Create( phy_lsc = phy_lsc00,  &         ! (inout)
    & imax = imax, jmax = jmax, kmax = kmax, & ! (in)
    & Grav = Grav, Cp = Cp, &                  ! (in)
    & EL = EL, RVap = RVap, &                  ! (in)
    & EpsV = EpsV, ES0 = ES0, &                ! (in)
    & DelTime = DelTime )
  call AssertEqual( 'initialization test 1', &
    & answer = .true., check = initialized(phy_lsc00) )
  call PutLine( phy_lsc = phy_lsc00 ) ! (in)

  !---------------------------------------------------------
  !  LScaleCond テスト
  !  LScaleCond test
  !---------------------------------------------------------
  allocate( xyz_Temp (0:imax-1, 0:jmax-1, 0:kmax-1) )
  allocate( xyz_QVap (0:imax-1, 0:jmax-1, 0:kmax-1) )
  allocate( xyz_Press (0:imax-1, 0:jmax-1, 0:kmax-1) )
  allocate( xyr_Press (0:imax-1, 0:jmax-1, 0:kmax) )
  allocate( xy_LscRain (0:imax-1, 0:jmax-1) )
  allocate( xyz_DLscTempDt (0:imax-1, 0:jmax-1, 0:kmax-1) )
  allocate( xyz_DLscQVapDt (0:imax-1, 0:jmax-1, 0:kmax-1) )

  xyz_Temp = 273.0_DP
  xyz_QVap = 1.0e-5_DP
  xyz_Press = 1.0e+6_DP
  xyr_Press = 1.0e+6_DP

  call LScaleCond( phy_lsc = phy_lsc00, &             ! (inout)
    & xyz_Temp = xyz_Temp, xyz_QVap = xyz_QVap, &     ! (inout)
    & xyz_Press = xyz_Press, xyr_Press = xyr_Press, & ! (in)
    & xy_Rain = xy_LscRain, &                         ! (out)
    & xyz_DTempDt = xyz_DLscTempDt, &                 ! (out)
    & xyz_DQVapDt = xyz_DLscQVapDt )                  ! (out)

  call PutLine ( xyz_Temp, indent = ' xyz_Temp=')
  call PutLine ( xyz_QVap, indent = ' xyz_QVap=')
  call PutLine ( xy_LscRain, indent = ' xy_LscRain=')
  call PutLine ( xyz_DLscTempDt, indent = ' xyz_DLscTempDt=')
  call PutLine ( xyz_DLscQvapDt, indent = ' xyz_DLscQvapDt=')

  !---------------------------------------------------------
  !  終了処理テスト
  !  Termination test
  !---------------------------------------------------------
  call Close( phy_lsc = phy_lsc00 ) ! (inout)
  call AssertEqual( 'termination test 1', &
    & answer = .false., check = initialized(phy_lsc00) )
  call PutLine( phy_lsc = phy_lsc00 ) ! (in)

  call Close( phy_lsc = phy_lsc02, & ! (inout)
    & err = err )                            ! (out)
  call AssertEqual( 'termination test 2', &
    & answer = .true., check = err )

end program phy_lscond_test
