external_gwave_initialization Module Reference

Detailed Description

The module configures the model for the "external_gwave" experiment. external_gwave = External Gravity Wave.

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

Function/Subroutine Documentation

external_gwave_initialize_thickness()

subroutine, public external_gwave_initialization::external_gwave_initialize_thickness	(	real, dimension(szi_(g),szj_(g),szk_(g)), intent(out)	h,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		logical, intent(in), optional	just_read_params
	)

This subroutine initializes layer thicknesses for the external_gwave experiment.

Parameters

[in]	g	The ocean's grid structure.
[out]	h	The thickness that is being initialized, in m.
[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 39 of file external_gwave_initialization.F90.

References mom_error_handler::mom_mesg().

Referenced by mom_state_initialization::mom_initialize_state().

  type(ocean_grid_type), intent(in) :: g                      !< The ocean's grid structure.
  real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
                           intent(out) :: h           !< The thickness that is being initialized, in m.
  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_(g))     ! The resting interface heights, in m, usually !
                          ! negative because it is positive upward.      !
  real :: e_pert(szk_(g)) ! Interface height perturbations, positive     !
                          ! upward, in m.                                !
  real :: eta1d(szk_(g)+1)! Interface height relative to the sea surface !
                          ! positive upward, in m.                       !
  real :: ssh_anomaly_height ! Vertical height of ssh anomaly
  real :: ssh_anomaly_width ! Lateral width of anomaly
  logical :: just_read    ! If true, just read parameters but set nothing.
  character(len=40)  :: mdl = "external_gwave_initialize_thickness" ! This subroutine's name.
! This include declares and sets the variable "version".
#include "version_variable.h"
  integer :: i, j, k, is, ie, js, je, nz
  real :: pi, xnondim

  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("  external_gwave_initialization.F90, external_gwave_initialize_thickness: setting thickness", 5)

  if (.not.just_read) call log_version(param_file, mdl, version, "")
  call get_param(param_file, mdl, "SSH_ANOMALY_HEIGHT", ssh_anomaly_height, &
                 "The vertical displacement of the SSH anomaly. ", units="m", &
                 fail_if_missing=.not.just_read, do_not_log=just_read)
  call get_param(param_file, mdl, "SSH_ANOMALY_WIDTH", ssh_anomaly_width, &
                 "The lateral width of the SSH anomaly. ", units="coordinate", &
                 fail_if_missing=.not.just_read, do_not_log=just_read)

  if (just_read) return ! All run-time parameters have been read, so return.

  pi = 4.0*atan(1.0)
  do j=g%jsc,g%jec ; do i=g%isc,g%iec
    xnondim = (g%geoLonT(i,j)-g%west_lon-0.5*g%len_lon) / ssh_anomaly_width
    xnondim = min(1., abs(xnondim))
    eta1d(1) = ssh_anomaly_height * 0.5 * ( 1. + cos(pi*xnondim) ) ! Cosine bell
    do k=2,nz
      eta1d(k) = -g%max_depth & ! Stretch interior interfaces with SSH
              + (eta1d(1)+g%max_depth) * ( real(nz+1-k)/real(nz) ) ! Stratification
    enddo
    eta1d(nz+1) = -g%max_depth ! Force bottom interface to bottom
    do k=1,nz
      h(i,j,k) = eta1d(k) - eta1d(k+1)
    enddo
  enddo ; enddo

Here is the call graph for this function:

Here is the caller graph for this function: