supercritical_initialization.F90

!> The "super critical" configuration
module supercritical_initialization

! This file is part of MOM6. See LICENSE.md for the license.

use mom_dyn_horgrid,    only : dyn_horgrid_type
use mom_error_handler,  only : mom_mesg, mom_error, fatal, is_root_pe
use mom_file_parser,    only : get_param, log_version, param_file_type
use mom_grid,           only : ocean_grid_type
use mom_open_boundary,  only : ocean_obc_type, obc_none, obc_simple, obc_segment_type
use mom_verticalgrid,   only : verticalgrid_type
use mom_time_manager,   only : time_type, time_type_to_real

implicit none ; private

#include <MOM_memory.h>

public supercritical_set_obc_data

! This include declares and sets the variable "version".
#include "version_variable.h"

contains

!> This subroutine sets the properties of flow at open boundary conditions.
subroutine supercritical_set_obc_data(OBC, G, param_file)
  type(ocean_obc_type),   pointer    :: obc  !< This open boundary condition type specifies
                                             !! whether, where, and what open boundary
                                             !! conditions are used.
  type(ocean_grid_type),  intent(in) :: g    !< The ocean's grid structure.
  type(param_file_type),  intent(in) :: param_file !< Parameter file structure
  ! Local variables
  character(len=40)  :: mdl = "supercritical_set_OBC_data" ! This subroutine's name.
  real :: zonal_flow ! Inflow speed [L T-1 ~> m s-1]
  integer :: i, j, k, l
  integer :: isd, ied, jsd, jed, isdb, iedb, jsdb, jedb
  type(obc_segment_type), pointer :: segment => null() ! pointer to segment type list

  if (.not.associated(obc)) call mom_error(fatal, 'supercritical_initialization.F90: '// &
        'supercritical_set_OBC_data() was called but OBC type was not initialized!')

  call get_param(param_file, mdl, "SUPERCRITICAL_ZONAL_FLOW", zonal_flow, &
                 "Constant zonal flow imposed at upstream open boundary.", &
                 units="m/s", default=8.57, scale=g%US%m_s_to_L_T)

  do l=1, obc%number_of_segments
    segment => obc%segment(l)
    if (.not. segment%on_pe) cycle
    if (segment%gradient) cycle
    if (segment%oblique .and. .not. segment%nudged .and. .not. segment%Flather) cycle

    if (segment%is_E_or_W) then
      jsd = segment%HI%jsd ; jed = segment%HI%jed
      isdb = segment%HI%IsdB ; iedb = segment%HI%IedB
      do k=1,g%ke
        do j=jsd,jed ; do i=isdb,iedb
          if (segment%specified .or. segment%nudged) then
            segment%normal_vel(i,j,k) = zonal_flow
          endif
          if (segment%specified) then
            segment%normal_trans(i,j,k) = zonal_flow * g%dyCu(i,j)
          endif
        enddo ; enddo
      enddo
      do j=jsd,jed ; do i=isdb,iedb
        segment%normal_vel_bt(i,j) = zonal_flow
      enddo ; enddo
    else
      isd = segment%HI%isd ; ied = segment%HI%ied
      jsdb = segment%HI%JsdB ; jedb = segment%HI%JedB
      do j=jsdb,jedb ; do i=isd,ied
        segment%normal_vel_bt(i,j) = 0.0
      enddo ; enddo
    endif
  enddo

end subroutine supercritical_set_obc_data

!> \namespace supercritical_initialization
!!
!! The module configures the model for the "supercritical" experiment.
!! https://marine.rutgers.edu/po/index.php?model=test-problems&title=supercritical
end module supercritical_initialization