mod_ocean_phy_driver.f90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
module mod_ocean_phy_driver
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_debug
  use scale_grid_index

  use scale_const, only: &
     i_sw  => const_i_sw, &
     i_lw  => const_i_lw
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: ocean_phy_driver_setup
  public :: ocean_phy_driver_resume
  public :: ocean_phy_driver

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine ocean_phy_driver_setup
    use scale_ocean_phy, only: &
       ocean_phy_setup
    use scale_ocean_sfc, only: &
       ocean_sfc_setup
    use mod_ocean_admin, only: &
       ocean_type, &
       ocean_sw
    implicit none
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[DRIVER] / Categ[OCEAN PHY] / Origin[SCALE-RM]'

    if ( ocean_sw ) then

       ! setup library component
       call ocean_phy_setup( ocean_type )
       call ocean_sfc_setup( ocean_type )

    else
       if( io_l ) write(io_fid_log,*) '*** this component is never called.'
    endif

    return
  end subroutine ocean_phy_driver_setup

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_driver_resume
    use mod_admin_restart, only: &
       restart_run
    use mod_ocean_admin, only: &
       ocean_sw
    implicit none

    if ( ocean_sw ) then

       if ( .NOT. restart_run ) then ! tentative
          ! run once (only for the diagnostic value)
          call prof_rapstart('OCN_Physics', 1)
          call ocean_phy_driver( update_flag = .true. )
          call prof_rapend  ('OCN_Physics', 1)
       end if

    end if

    return
  end subroutine ocean_phy_driver_resume

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_driver( update_flag )
    use scale_atmos_hydrometeor, only: &
       hydrometeor_lhv => atmos_hydrometeor_lhv
    use scale_time, only: &
       dt => time_dtsec_ocean
    use scale_rm_statistics, only: &
       statistics_checktotal, &
       stat_total
    use scale_history, only: &
       hist_in
    use scale_grid_real, only: &
       real_z1
    use scale_roughness, only: &
       roughness
    use scale_ocean_phy, only: &
       ocean_phy
    use scale_ocean_sfc, only: &
       ocean_sfc,              &
       ocean_sfc_simplealbedo
    use mod_ocean_vars, only: &
       ocean_temp,         &
       ocean_sfc_temp,     &
       ocean_sfc_albedo,   &
       ocean_sfc_z0m,      &
       ocean_sfc_z0h,      &
       ocean_sfc_z0e,      &
       ocean_temp_t,       &
       ocean_sfc_temp_t,   &
       ocean_sfc_albedo_t, &
       ocean_sfc_z0m_t,    &
       ocean_sfc_z0h_t,    &
       ocean_sfc_z0e_t,    &
       ocean_sflx_mw,      &
       ocean_sflx_mu,      &
       ocean_sflx_mv,      &
       ocean_sflx_sh,      &
       ocean_sflx_lh,      &
       ocean_sflx_wh,      &
       ocean_sflx_evap,    &
       ocean_u10,          &
       ocean_v10,          &
       ocean_t2,           &
       ocean_q2,           &
       atmos_temp,         &
       atmos_pres,         &
       atmos_w,            &
       atmos_u,            &
       atmos_v,            &
       atmos_dens,         &
       atmos_qv,           &
       atmos_pbl,          &
       atmos_sfc_pres,     &
       atmos_sflx_lw,      &
       atmos_sflx_sw,      &
       atmos_cossza,       &
       atmos_sflx_prec
    implicit none

    logical, intent(in) :: update_flag

    real(RP) :: lhv(ia,ja) ! latent heat of vaporization [J/kg]
    real(RP) :: total      ! dummy

    integer  :: i, j
    !---------------------------------------------------------------------------

    if ( update_flag ) then

       call roughness( ocean_sfc_z0m_t(:,:), & ! [OUT]
                       ocean_sfc_z0h_t(:,:), & ! [OUT]
                       ocean_sfc_z0e_t(:,:), & ! [OUT]
                       ocean_sfc_z0m(:,:), & ! [IN]
                       ocean_sfc_z0h(:,:), & ! [IN]
                       ocean_sfc_z0e(:,:), & ! [IN]
                       atmos_u(:,:), & ! [IN]
                       atmos_v(:,:), & ! [IN]
                       real_z1(:,:), & ! [IN]
                       dt                    ) ! [IN]

       call ocean_sfc_simplealbedo( ocean_sfc_albedo_t(:,:,:), & ! [OUT]
                                    ocean_sfc_albedo(:,:,:), & ! [IN]
                                    atmos_cossza(:,:),   & ! [IN]
                                    dt                         ) ! [IN]

       call ocean_sfc( ocean_sfc_temp_t(:,:),      & ! [OUT]
                       ocean_sflx_mw(:,:),      & ! [OUT]
                       ocean_sflx_mu(:,:),      & ! [OUT]
                       ocean_sflx_mv(:,:),      & ! [OUT]
                       ocean_sflx_sh(:,:),      & ! [OUT]
                       ocean_sflx_lh(:,:),      & ! [OUT]
                       ocean_sflx_wh(:,:),      & ! [OUT]
                       ocean_u10(:,:),      & ! [OUT]
                       ocean_v10(:,:),      & ! [OUT]
                       ocean_t2(:,:),      & ! [OUT]
                       ocean_q2(:,:),      & ! [OUT]
                       atmos_temp(:,:),      & ! [IN]
                       atmos_pres(:,:),      & ! [IN]
                       atmos_w(:,:),      & ! [IN]
                       atmos_u(:,:),      & ! [IN]
                       atmos_v(:,:),      & ! [IN]
                       atmos_dens(:,:),      & ! [IN]
                       atmos_qv(:,:),      & ! [IN]
                       real_z1(:,:),      & ! [IN]
                       atmos_pbl(:,:),      & ! [IN]
                       atmos_sfc_pres(:,:),      & ! [IN]
                       atmos_sflx_lw(:,:),      & ! [IN]
                       atmos_sflx_sw(:,:),      & ! [IN]
                       ocean_temp(:,:),      & ! [IN]
                       ocean_sfc_temp(:,:),      & ! [IN]
                       ocean_sfc_albedo(:,:,i_lw), & ! [IN]
                       ocean_sfc_albedo(:,:,i_sw), & ! [IN]
                       ocean_sfc_z0m(:,:),      & ! [IN]
                       ocean_sfc_z0h(:,:),      & ! [IN]
                       ocean_sfc_z0e(:,:),      & ! [IN]
                       dt                          ) ! [IN]


       call hydrometeor_lhv( lhv(:,:), atmos_temp(:,:) )

!OCL XFILL
       do j = js, je
       do i = is, ie
          ocean_sflx_evap(i,j) = ocean_sflx_lh(i,j) / lhv(i,j)
       end do
       end do

       call ocean_phy( ocean_temp_t(:,:), & ! [OUT]
                       ocean_temp(:,:), & ! [IN]
                       ocean_sflx_wh(:,:), & ! [IN]
                       atmos_sflx_prec(:,:), & ! [IN]
                       ocean_sflx_evap(:,:), & ! [IN]
                       dt                    ) ! [IN]

       call hist_in( ocean_temp_t(:,:),      'OCEAN_TEMP_t',     'tendency of OCEAN_TEMP',     'K' )
       call hist_in( ocean_sfc_temp_t(:,:),      'OCEAN_SFC_TEMP_t', 'tendency of OCEAN_SFC_TEMP', 'K' )
       call hist_in( ocean_sfc_albedo_t(:,:,i_lw), 'OCEAN_ALB_LW_t',   'tendency of OCEAN_ALB_LW',   '1' )
       call hist_in( ocean_sfc_albedo_t(:,:,i_sw), 'OCEAN_ALB_SW_t',   'tendency of OCEAN_ALB_SW',   '1' )
       call hist_in( ocean_sfc_z0m_t(:,:),      'OCEAN_SFC_Z0M_t',  'tendency of OCEAN_SFC_Z0M',  'm' )
       call hist_in( ocean_sfc_z0h_t(:,:),      'OCEAN_SFC_Z0H_t',  'tendency of OCEAN_SFC_Z0H',  'm' )
       call hist_in( ocean_sfc_z0e_t(:,:),      'OCEAN_SFC_Z0E_t',  'tendency of OCEAN_SFC_Z0E',  'm' )

    end if

    if ( statistics_checktotal ) then
       call stat_total( total, ocean_temp_t(:,:),      'OCEAN_TEMP_t'     )
       call stat_total( total, ocean_sfc_temp_t(:,:),      'OCEAN_SFC_TEMP_t' )
       call stat_total( total, ocean_sfc_albedo_t(:,:,i_lw), 'OCEAN_ALB_LW_t'   )
       call stat_total( total, ocean_sfc_albedo_t(:,:,i_sw), 'OCEAN_ALB_SW_t'   )
       call stat_total( total, ocean_sfc_z0m_t(:,:),      'OCEAN_SFC_Z0M_t'  )
       call stat_total( total, ocean_sfc_z0h_t(:,:),      'OCEAN_SFC_Z0H_t'  )
       call stat_total( total, ocean_sfc_z0e_t(:,:),      'OCEAN_SFC_Z0E_t'  )
    end if

    return
  end subroutine ocean_phy_driver

end module mod_ocean_phy_driver