scale_ocean_phy_roughness.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module scale_ocean_phy_roughness
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: ocean_phy_roughness_setup
  public :: ocean_phy_roughness_const_setup
  public :: ocean_phy_roughness_seaice_setup
  public :: ocean_phy_roughness_const
  public :: ocean_phy_roughness_seaice

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  real(RP), public :: ocean_phy_roughness_visck      = 1.5e-5_rp ! kinematic viscosity [m2/s]
  real(RP), public :: ocean_phy_roughness_ustar_min  = 1.0e-3_rp ! minimum friction velocity [m/s]
  real(RP), public :: ocean_phy_roughness_z0m_min    = 1.0e-5_rp ! minimum roughness length for momentum [m]
  real(RP), public :: ocean_phy_roughness_z0h_min    = 1.0e-5_rp ! minimum roughness length for heat     [m]
  real(RP), public :: ocean_phy_roughness_z0e_min    = 1.0e-5_rp ! minimum roughness length for moisture [m]

  real(RP), public :: ocean_phy_roughness_z0m        = 1.0e-5_rp ! constant roughness length for momentum [m]
  real(RP), public :: ocean_phy_roughness_z0h        = 1.0e-5_rp ! constant roughness length for heat     [m]
  real(RP), public :: ocean_phy_roughness_z0e        = 1.0e-5_rp ! constant roughness length for moisture [m]

  real(RP), public :: ocean_phy_roughness_seaice_z0m = 2.0e-2_rp ! seaice roughness length for momentum [m]
  real(RP), public :: ocean_phy_roughness_seaice_z0h = 2.0e-3_rp ! seaice roughness length for heat     [m]
  real(RP), public :: ocean_phy_roughness_seaice_z0e = 2.0e-3_rp ! seaice roughness length for moisture [m]

  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine ocean_phy_roughness_setup
    use scale_prc, only: &
       prc_abort
    implicit none

    namelist / param_ocean_phy_roughness / &
       ocean_phy_roughness_visck,     &
       ocean_phy_roughness_ustar_min, &
       ocean_phy_roughness_z0m_min,   &
       ocean_phy_roughness_z0h_min,   &
       ocean_phy_roughness_z0e_min

    integer :: ierr
    !---------------------------------------------------------------------------

    log_newline
    log_info("OCEAN_PHY_ROUGHNESS_setup",*) 'Setup'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean_phy_roughness,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("OCEAN_PHY_ROUGHNESS_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("OCEAN_PHY_ROUGHNESS_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_PHY_ROUGHNESS. Check!'
       call prc_abort
    endif
    log_nml(param_ocean_phy_roughness)

    return
  end subroutine ocean_phy_roughness_setup

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_roughness_const_setup
    use scale_prc, only: &
       prc_abort
    implicit none

    namelist / param_ocean_phy_roughness_const / &
       ocean_phy_roughness_z0m, &
       ocean_phy_roughness_z0h, &
       ocean_phy_roughness_z0e

    integer :: ierr
    !---------------------------------------------------------------------------

    log_newline
    log_info("OCEAN_PHY_ROUGHNESS_const_setup",*) 'Setup'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean_phy_roughness_const,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("OCEAN_PHY_ROUGHNESS_const_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("OCEAN_PHY_ROUGHNESS_const_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_PHY_ROUGHNESS_const. Check!'
       call prc_abort
    endif
    log_nml(param_ocean_phy_roughness_const)

    return
  end subroutine ocean_phy_roughness_const_setup

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_roughness_seaice_setup
    use scale_prc, only: &
       prc_abort
    implicit none

    namelist / param_ocean_phy_roughness_seaice / &
       ocean_phy_roughness_seaice_z0m, &
       ocean_phy_roughness_seaice_z0h, &
       ocean_phy_roughness_seaice_z0e

    integer :: ierr
    !---------------------------------------------------------------------------

    log_newline
    log_info("OCEAN_PHY_ROUGHNESS_seaice_setup",*) 'Setup'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean_phy_roughness_seaice,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("OCEAN_PHY_ROUGHNESS_seaice_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("OCEAN_PHY_ROUGHNESS_seaice_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_PHY_ROUGHNESS_seaice. Check!'
       call prc_abort
    endif
    log_nml(param_ocean_phy_roughness_seaice)

    return
  end subroutine ocean_phy_roughness_seaice_setup

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_roughness_const( &
       OIA, OIS, OIE, &
       OJA, OJS, OJE, &
       Z0M, Z0H, Z0E  )
    implicit none

    integer,  intent(in)  :: OIA, OIS, OIE
    integer,  intent(in)  :: OJA, OJS, OJE
    real(RP), intent(out) :: Z0M(oia,oja) ! roughness length for momentum [m]
    real(RP), intent(out) :: Z0H(oia,oja) ! roughness length for heat [m]
    real(RP), intent(out) :: Z0E(oia,oja) ! roughness length for vapor [m]

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

    do j = ojs, oje
    do i = ois, oie
       z0m(i,j) = max( ocean_phy_roughness_z0m, ocean_phy_roughness_z0m_min )
       z0h(i,j) = max( ocean_phy_roughness_z0h, ocean_phy_roughness_z0h_min )
       z0e(i,j) = max( ocean_phy_roughness_z0e, ocean_phy_roughness_z0e_min )
    enddo
    enddo

    return
  end subroutine ocean_phy_roughness_const

  !-----------------------------------------------------------------------------
  subroutine ocean_phy_roughness_seaice( &
       OIA, OIS, OIE, &
       OJA, OJS, OJE, &
       Z0M, Z0H, Z0E  )
    implicit none

    integer,  intent(in)  :: OIA, OIS, OIE
    integer,  intent(in)  :: OJA, OJS, OJE
    real(RP), intent(out) :: Z0M(oia,oja) ! roughness length for momentum [m]
    real(RP), intent(out) :: Z0H(oia,oja) ! roughness length for heat [m]
    real(RP), intent(out) :: Z0E(oia,oja) ! roughness length for vapor [m]

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

    do j = ojs, oje
    do i = ois, oie
       z0m(i,j) = max( ocean_phy_roughness_seaice_z0m, ocean_phy_roughness_z0m_min )
       z0h(i,j) = max( ocean_phy_roughness_seaice_z0h, ocean_phy_roughness_z0h_min )
       z0e(i,j) = max( ocean_phy_roughness_seaice_z0e, ocean_phy_roughness_z0e_min )
    enddo
    enddo

    return
  end subroutine ocean_phy_roughness_seaice

end module scale_ocean_phy_roughness