module ocean / dynamics / slab More...

Functions/Subroutines
subroutine, public	ocean_dyn_slab_setup (DEPTH)
	Setup. More...

subroutine, public	ocean_dyn_slab (OKMAX, OKS, OKE, OIA, OIS, OIE, OJA, OJS, OJE, OCEAN_TEMP_t, OCEAN_SFLX_G, OCEAN_SFLX_water, calc_flag, dt, NOWDAYSEC, OCEAN_TEMP, MASS_SUPL, ENGI_SUPL)
	Slab ocean model. More...

Detailed Description

module ocean / dynamics / slab

Description: ocean slab model

Author: Team SCALE

NAMELIST

PARAM_OCEAN_DYN_SLAB

name	type	default value	comment
OCEAN_DYN_SLAB_NUDGING	logical	.false.	SST Nudging is used?
OCEAN_DYN_SLAB_NUDGING_TAU	real(DP)	0.0_DP	Relaxation time
OCEAN_DYN_SLAB_NUDGING_TAU_UNIT	character(len=H_SHORT)	"SEC"
OCEAN_DYN_SLAB_NUDGING_BASENAME	character(len=H_LONG)	''
OCEAN_DYN_SLAB_NUDGING_BASENAME_ADD_NUM	logical	.false.
OCEAN_DYN_SLAB_NUDGING_NUMBER_OF_FILES	integer	1
OCEAN_DYN_SLAB_NUDGING_ENABLE_PERIODIC_YEAR	logical	.false.
OCEAN_DYN_SLAB_NUDGING_ENABLE_PERIODIC_MONTH	logical	.false.
OCEAN_DYN_SLAB_NUDGING_ENABLE_PERIODIC_DAY	logical	.false.
OCEAN_DYN_SLAB_NUDGING_STEP_FIXED	integer	0
OCEAN_DYN_SLAB_NUDGING_DEFVAL	real(RP)		= UNDEF
OCEAN_DYN_SLAB_NUDGING_CHECK_COORDINATES	logical	.true.
OCEAN_DYN_SLAB_NUDGING_STEP_LIMIT	integer	0
OCEAN_DYN_SLAB_DEPTH	real(RP)	-1.0_RP

History Output: No history output

Function/Subroutine Documentation

◆ ocean_dyn_slab_setup()

subroutine, public scale_ocean_dyn_slab::ocean_dyn_slab_setup ( real(rp), intent(in) DEPTH )

Setup.

Definition at line 54 of file scale_ocean_dyn_slab.F90.

     use scale_prc, only: &
        prc_abort
     use scale_const, only: &
        undef => const_undef, &
        dwatr => const_dwatr
     use scale_atmos_hydrometeor, only: &
        cv_water
     use scale_calendar, only: &
        calendar_unit2sec
     use scale_file_external_input, only: &
        file_external_input_regist
     implicit none
     real(RP), intent(in) :: DEPTH
  
     real(DP)               :: OCEAN_DYN_SLAB_nudging_tau                   = 0.0_dp  ! Relaxation time
     character(len=H_SHORT) :: OCEAN_DYN_SLAB_nudging_tau_unit              = "SEC"
     character(len=H_LONG)  :: OCEAN_DYN_SLAB_nudging_basename              = ''
     logical                :: OCEAN_DYN_SLAB_nudging_basename_add_num      = .false.
     integer                :: OCEAN_DYN_SLAB_nudging_number_of_files       = 1
     logical                :: OCEAN_DYN_SLAB_nudging_enable_periodic_year  = .false.
     logical                :: OCEAN_DYN_SLAB_nudging_enable_periodic_month = .false.
     logical                :: OCEAN_DYN_SLAB_nudging_enable_periodic_day   = .false.
     integer                :: OCEAN_DYN_SLAB_nudging_step_fixed            = 0
     real(RP)               :: OCEAN_DYN_SLAB_nudging_defval                ! = UNDEF
     logical                :: OCEAN_DYN_SLAB_nudging_check_coordinates     = .true.
     integer                :: OCEAN_DYN_SLAB_nudging_step_limit            = 0
  
     ! obsolete
     real(RP)               :: OCEAN_DYN_SLAB_DEPTH = -1.0_rp
  
     namelist / param_ocean_dyn_slab / &
        ocean_dyn_slab_nudging,                       &
        ocean_dyn_slab_nudging_tau,                   &
        ocean_dyn_slab_nudging_tau_unit,              &
        ocean_dyn_slab_nudging_basename,              &
        ocean_dyn_slab_nudging_basename_add_num,      &
        ocean_dyn_slab_nudging_number_of_files,       &
        ocean_dyn_slab_nudging_enable_periodic_year,  &
        ocean_dyn_slab_nudging_enable_periodic_month, &
        ocean_dyn_slab_nudging_enable_periodic_day,   &
        ocean_dyn_slab_nudging_step_fixed,            &
        ocean_dyn_slab_nudging_defval,                &
        ocean_dyn_slab_nudging_check_coordinates,     &
        ocean_dyn_slab_nudging_step_limit,            &
        ocean_dyn_slab_depth
  
     integer :: ierr
     !---------------------------------------------------------------------------
  
     log_newline
     log_info("OCEAN_DYN_SLAB_setup",*) 'Setup'
  
     ocean_dyn_slab_nudging_defval = undef
  
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_ocean_dyn_slab,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("OCEAN_DYN_SLAB_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("OCEAN_DYN_SLAB_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_DYN_SLAB. Check!'
        call prc_abort
     endif
     log_nml(param_ocean_dyn_slab)
  
     if ( ocean_dyn_slab_depth >= 0.0 ) then
        log_error("OCEAN_DYN_SLAB_setup",*) '"OCEAN_DYN_SLAB_DEPTH" is obsolete. USE "ODZ" of "PARAM_OCEAN_GRID_CARTESC"'
        call prc_abort
     end if
  
     ocean_dyn_slab_heatcapacity = dwatr * cv_water * depth
  
     log_newline
     log_info("OCEAN_DYN_SLAB_setup",*) 'Slab ocean depth [m]         : ', depth
     log_info("OCEAN_DYN_SLAB_setup",*) 'Ocean heat capacity [J/K/m2] : ', ocean_dyn_slab_heatcapacity
  
     if ( ocean_dyn_slab_nudging ) then
        call calendar_unit2sec( ocean_dyn_slab_nudging_tausec, ocean_dyn_slab_nudging_tau, ocean_dyn_slab_nudging_tau_unit )
  
        log_info("OCEAN_DYN_SLAB_setup",*) 'Use nudging for SST : ON'
        log_info("OCEAN_DYN_SLAB_setup",*) 'Relaxation time Tau [sec] : ', ocean_dyn_slab_nudging_tausec
  
        if ( ocean_dyn_slab_nudging_tausec == 0.0_rp ) then
           ocean_dyn_slab_offline_mode = .true.
           log_info("OCEAN_DYN_SLAB_setup",*) 'Tau=0 means that SST is completely replaced by the external data.'
        endif
  
        if ( ocean_dyn_slab_nudging_basename == '' ) then
           log_error("OCEAN_DYN_SLAB_setup",*) 'OCEAN_DYN_SLAB_nudging_basename is necessary !!'
           call prc_abort
        endif
     else
        log_info("OCEAN_DYN_SLAB_setup",*) 'Use nudging for SST : OFF'
     endif
  
     if ( ocean_dyn_slab_nudging ) then
        call file_external_input_regist( ocean_dyn_slab_nudging_basename,              & ! [IN]
                                         ocean_dyn_slab_nudging_basename_add_num,      & ! [IN]
                                         ocean_dyn_slab_nudging_number_of_files,       & ! [IN]
                                         'OCEAN_TEMP',                                 & ! [IN]
                                         'OXY',                                        & ! [IN]
                                         ocean_dyn_slab_nudging_enable_periodic_year,  & ! [IN]
                                         ocean_dyn_slab_nudging_enable_periodic_month, & ! [IN]
                                         ocean_dyn_slab_nudging_enable_periodic_day,   & ! [IN]
                                         ocean_dyn_slab_nudging_step_fixed,            & ! [IN]
                                         ocean_dyn_slab_nudging_defval,                & ! [IN]
                                         check_coordinates = ocean_dyn_slab_nudging_check_coordinates, & ! [IN]
                                         step_limit        = ocean_dyn_slab_nudging_step_limit,        & ! [IN]
                                         allow_missing     = ( .not. ocean_dyn_slab_offline_mode )     ) ! [IN]
     endif
  
     return

References scale_calendar::calendar_unit2sec(), scale_const::const_dwatr, scale_const::const_undef, scale_atmos_hydrometeor::cv_water, scale_io::io_fid_conf, and scale_prc::prc_abort().

Referenced by mod_ocean_driver::ocean_driver_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ocean_dyn_slab()

subroutine, public scale_ocean_dyn_slab::ocean_dyn_slab	(	integer, intent(in)	OKMAX,
		integer, intent(in)	OKS,
		integer, intent(in)	OKE,
		integer, intent(in)	OIA,
		integer, intent(in)	OIS,
		integer, intent(in)	OIE,
		integer, intent(in)	OJA,
		integer, intent(in)	OJS,
		integer, intent(in)	OJE,
		real(rp), dimension (okmax,oia,oja), intent(in)	OCEAN_TEMP_t,
		real(rp), dimension (oia,oja), intent(in)	OCEAN_SFLX_G,
		real(rp), dimension(oia,oja), intent(in)	OCEAN_SFLX_water,
		logical, dimension (oia,oja), intent(in)	calc_flag,
		real(dp), intent(in)	dt,
		real(dp), intent(in)	NOWDAYSEC,
		real(rp), dimension (okmax,oia,oja), intent(inout)	OCEAN_TEMP,
		real(rp), dimension (oia,oja), intent(out)	MASS_SUPL,
		real(rp), dimension (oia,oja), intent(out)	ENGI_SUPL
	)

Slab ocean model.

Definition at line 182 of file scale_ocean_dyn_slab.F90.

     use scale_prc, only: &
        prc_abort
     use scale_const, only: &
        undef => const_undef
     use scale_file_external_input, only: &
        file_external_input_update
     use scale_atmos_hydrometeor, only: &
        cv_water
     implicit none
  
     integer,  intent(in)    :: OKMAX, OKS, OKE
     integer,  intent(in)    :: OIA,   OIS, OIE
     integer,  intent(in)    :: OJA,   OJS, OJE
     real(RP), intent(in)    :: OCEAN_TEMP_t    (OKMAX,OIA,OJA) ! tendency of ocean temperature
     real(RP), intent(in)    :: OCEAN_SFLX_G    (OIA,OJA)       ! heat flux from surface to subsurface (open ocean/sea ice)
     real(RP), intent(in)    :: OCEAN_SFLX_water(OIA,OJA)       ! mass flux from surface to subsurface (open ocean/sea ice)
     logical,  intent(in)    :: calc_flag       (OIA,OJA)       ! to decide calculate or not
     real(DP), intent(in)    :: dt
     real(DP), intent(in)    :: NOWDAYSEC
     real(RP), intent(inout) :: OCEAN_TEMP      (OKMAX,OIA,OJA)
     real(RP), intent(out)   :: MASS_SUPL       (OIA,OJA)
     real(RP), intent(out)   :: ENGI_SUPL       (OIA,OJA)
  
     real(RP) :: OCEAN_TEMP_t_ndg(OKMAX,OIA,OJA)
     real(RP) :: OCEAN_TEMP_ref  (OKMAX,OIA,OJA)
     real(RP) :: rtau
     real(RP) :: dCP
  
     logical  :: error
     integer  :: k, i, j
     !---------------------------------------------------------------------------
     !$acc data copyin (OCEAN_TEMP_t,OCEAN_SFLX_G,OCEAN_SFLX_water,calc_flag) &
     !$acc      copyout(MASS_SUPL,ENGI_SUPL) &
     !$acc      copy(OCEAN_TEMP) &
     !$acc      create (OCEAN_TEMP_t_ndg,OCEAN_TEMP_ref)
  
  
     log_progress(*) 'ocean / dynamics / slab'
  
     if ( ocean_dyn_slab_nudging ) then
  
        call file_external_input_update( 'OCEAN_TEMP', nowdaysec, ocean_temp_ref(:,:,:), error )
  
  
        if ( error ) then
           log_error("OCEAN_DYN_SLAB",*) 'Requested data is not found!'
           call prc_abort
        endif
  
        if ( .not. ocean_dyn_slab_offline_mode ) then
  
           ! if OCEAN_DYN_SLAB_nudging_tau < dt, Nudging acts as quasi-prescribed boundary
           rtau = 1.0_rp / max(ocean_dyn_slab_nudging_tausec,dt)
  
           !$omp parallel do
           !$acc kernels
           do j = ojs, oje
           do i = ois, oie
           do k = oks, oke
              if ( ocean_temp_ref(k,i,j) == undef ) then
                 ocean_temp_t_ndg(k,i,j) = 0.0_rp
              else
                 ocean_temp_t_ndg(k,i,j) = ( ocean_temp_ref(k,i,j) - ocean_temp(k,i,j) ) * rtau
              end if
           enddo
           enddo
           enddo
           !$acc end kernels
  
        end if
  
     else
        !$omp parallel do
        !$acc kernels
        do j = ojs, oje
        do i = ois, oie
        do k = oks, oke
           ocean_temp_t_ndg(k,i,j) = 0.0_rp
        end do
        end do
        end do
        !$acc end kernels
     endif
  
     if ( ocean_dyn_slab_offline_mode ) then
  
        !$omp parallel do
        !$acc kernels
        do j = ojs, oje
        do i = ois, oie
           if ( calc_flag(i,j) ) then
              ocean_temp(oks,i,j) = ocean_temp_ref(oks,i,j)
           endif
           mass_supl(i,j) = 0.0_rp
           engi_supl(i,j) = 0.0_rp
        enddo
        enddo
        !$acc end kernels
  
     else
  
        !$omp parallel do private(dCP)
        !$acc kernels
        do j = ojs, oje
        do i = ois, oie
           if ( calc_flag(i,j) ) then
              ! heat flux from atm/ice at uppermost ocean layer
              dcp = cv_water * ocean_sflx_water(i,j) * dt
              ocean_temp(oks,i,j) = ocean_temp(oks,i,j) &
                                  + ( ocean_sflx_g(i,j) * dt - dcp * ocean_temp(oks,i,j) ) &
                                    / ( ocean_dyn_slab_heatcapacity + dcp ) &
                                  + ocean_temp_t_ndg(oks,i,j) * dt
              do k = oks+1, oke
                 ocean_temp(k,i,j) = ocean_temp(k,i,j) + ocean_temp_t_ndg(k,i,j) * dt
              enddo
              mass_supl(i,j) = - ocean_sflx_water(i,j)
              engi_supl(i,j) = cv_water * mass_supl(i,j) * ocean_temp(oks,i,j)
           else
              mass_supl(i,j) = 0.0_rp
              engi_supl(i,j) = 0.0_rp
           endif
        enddo
        enddo
        !$acc end kernels
  
     endif
     !$acc end data
  
     return

References scale_const::const_undef, scale_atmos_hydrometeor::cv_water, and scale_prc::prc_abort().

Referenced by mod_ocean_driver::ocean_driver_update().