circle_obcs_initialization Module Reference

Detailed Description

Configures the model for the "circle_obcs" experiment which tests Open Boundary Conditions radiating an SSH anomaly.

Functions/Subroutines
subroutine, public	circle_obcs_initialize_thickness (h, G, GV, param_file, just_read_params)
	This subroutine initializes layer thicknesses for the circle_obcs experiment. More...

Function/Subroutine Documentation

circle_obcs_initialize_thickness()

subroutine, public circle_obcs_initialization::circle_obcs_initialize_thickness	(	real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke), intent(out)	h,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(param_file_type), intent(in)	param_file,
		logical, intent(in), optional	just_read_params
	)

This subroutine initializes layer thicknesses for the circle_obcs experiment.

Parameters

[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[out]	h	The thickness that is being initialized [H ~> m or kg m-2].
[in]	param_file	A structure indicating the open file to parse for model parameter values.
[in]	just_read_params	If present and true, this call will only read parameters without changing h.

Definition at line 32 of file circle_obcs_initialization.F90.

  type(ocean_grid_type),   intent(in)  :: G   !< The ocean's grid structure.
  type(verticalGrid_type), intent(in)  :: GV  !< The ocean's vertical grid structure.
  real, dimension(SZI_(G),SZJ_(G), SZK_(GV)), &
                           intent(out) :: h           !< The thickness that is being initialized [H ~> m or kg m-2].
  type(param_file_type),   intent(in)  :: param_file  !< A structure indicating the open file
                                                      !! to parse for model parameter values.
  logical,       optional, intent(in)  :: just_read_params !< If present and true, this call will
                                                      !! only read parameters without changing h.
 
  real :: e0(SZK_(GV)+1)   ! The resting interface heights, in depth units [Z ~> m], usually
                           ! negative because it is positive upward.
  real :: eta1D(SZK_(GV)+1)! Interface height relative to the sea surface
                           ! positive upward, in depth units [Z ~> m].
  real :: IC_amp           ! The amplitude of the initial height displacement [H ~> m or kg m-2].
  real :: diskrad, rad, xCenter, xRadius, lonC, latC, xOffset
  logical :: just_read
  ! This include declares and sets the variable "version".
# include "version_variable.h"
  character(len=40)  :: mdl = "circle_obcs_initialization"   ! This module's name.
  integer :: i, j, k, is, ie, js, je, nz
 
  is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = g%ke
 
  just_read = .false. ; if (present(just_read_params)) just_read = just_read_params
 
  if (.not.just_read) &
    call mom_mesg("  circle_obcs_initialization.F90, circle_obcs_initialize_thickness: setting thickness", 5)
 
  if (.not.just_read) call log_version(param_file, mdl, version, "")
  ! Parameters read by cartesian grid initialization
  call get_param(param_file, mdl, "DISK_RADIUS", diskrad, &
                 "The radius of the initially elevated disk in the "//&
                 "circle_obcs test case.", units=g%x_axis_units, &
                 fail_if_missing=.not.just_read, do_not_log=just_read)
  call get_param(param_file, mdl, "DISK_X_OFFSET", xoffset, &
                 "The x-offset of the initially elevated disk in the "//&
                 "circle_obcs test case.", units=g%x_axis_units, &
                 default = 0.0, do_not_log=just_read)
  call get_param(param_file, mdl, "DISK_IC_AMPLITUDE", ic_amp, &
                 "Initial amplitude of interface height displacements "//&
                 "in the circle_obcs test case.", &
                 units='m', default=5.0, scale=gv%m_to_H, do_not_log=just_read)
 
  if (just_read) return ! All run-time parameters have been read, so return.
 
  do k=1,nz
    e0(k) = -g%max_depth * real(k-1) / real(nz)
  enddo
 
  ! Uniform thicknesses for base state
  do j=js,je ; do i=is,ie                        !
    eta1d(nz+1) = -g%bathyT(i,j)
    do k=nz,1,-1
      eta1d(k) = e0(k)
      if (eta1d(k) < (eta1d(k+1) + gv%Angstrom_Z)) then
        eta1d(k) = eta1d(k+1) + gv%Angstrom_Z
        h(i,j,k) = gv%Angstrom_H
      else
        h(i,j,k) = gv%Z_to_H * (eta1d(k) - eta1d(k+1))
      endif
    enddo
  enddo ; enddo
 
  ! Perturb base state by circular anomaly in center
  k=nz
  latc = g%south_lat + 0.5*g%len_lat
  lonc = g%west_lon + 0.5*g%len_lon + xoffset
  do j=js,je ; do i=is,ie
    rad = sqrt((g%geoLonT(i,j)-lonc)**2+(g%geoLatT(i,j)-latc)**2)/(diskrad)
    ! if (rad <= 6.*diskrad) h(i,j,k) = h(i,j,k)+10.0*exp( -0.5*( rad**2 ) )
    rad = min( rad, 1. ) ! Flatten outside radius of diskrad
    rad = rad*(2.*asin(1.)) ! Map 0-1 to 0-pi
    if (nz==1) then
      ! The model is barotropic
      h(i,j,k) = h(i,j,k) + ic_amp * 0.5*(1.+cos(rad)) ! cosine bell
    else
      ! The model is baroclinic
      do k = 1, nz
        h(i,j,k) = h(i,j,k) - 0.5*(1.+cos(rad)) * ic_amp * real( 2*k-nz )
      enddo
    endif
  enddo ; enddo
 

References mom_error_handler::mom_mesg().

Referenced by mom_state_initialization::mom_initialize_state().

Here is the call graph for this function:

Here is the caller graph for this function: