tidal_bay_initialization Module Reference

Detailed Description

The module configures the model for the "tidal_bay" experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik's class on tides.

Data Types
type	tidal_bay_obc_cs
	Control structure for tidal bay open boundaries. More...

Functions/Subroutines
logical function, public	register_tidal_bay_obc (param_file, CS, OBC_Reg)
	Add tidal bay to OBC registry. More...
subroutine, public	tidal_bay_obc_end (CS)
	Clean up the tidal bay OBC from registry. More...
subroutine, public	tidal_bay_set_obc_data (OBC, CS, G, h, Time)
	This subroutine sets the properties of flow at open boundary conditions. More...

Function/Subroutine Documentation

register_tidal_bay_obc()

logical function, public tidal_bay_initialization::register_tidal_bay_obc	(	type(param_file_type), intent(in)	param_file,
		type(tidal_bay_obc_cs), pointer	CS,
		type(obc_registry_type), pointer	OBC_Reg
	)

Add tidal bay to OBC registry.

Parameters

[in]	param_file	parameter file.
	cs	tidal bay control structure.
	obc_reg	OBC registry.

Definition at line 49 of file tidal_bay_initialization.F90.

References mom_error_handler::mom_error().

  type(param_file_type),    intent(in) :: param_file !< parameter file.
  type(tidal_bay_obc_cs),   pointer    :: cs         !< tidal bay control structure.
  type(obc_registry_type),  pointer    :: obc_reg    !< OBC registry.
  logical                              :: register_tidal_bay_obc
  character(len=32)  :: casename = "tidal bay"       !< This case's name.

  if (associated(cs)) then
    call mom_error(warning, "register_tidal_bay_OBC called with an "// &
                            "associated control structure.")
    return
  endif
  allocate(cs)

  ! Register the tracer for horizontal advection & diffusion.
  call register_obc(casename, param_file, obc_reg)
  register_tidal_bay_obc = .true.

Here is the call graph for this function:

tidal_bay_obc_end()

subroutine, public tidal_bay_initialization::tidal_bay_obc_end

(

type(tidal_bay_obc_cs), pointer

CS

)

Clean up the tidal bay OBC from registry.

Parameters

cs	tidal bay control structure.

Definition at line 70 of file tidal_bay_initialization.F90.

Referenced by mom_boundary_update::obc_register_end().

  type(tidal_bay_obc_cs), pointer    :: cs         !< tidal bay control structure.

  if (associated(cs)) then
    deallocate(cs)
  endif

Here is the caller graph for this function:

tidal_bay_set_obc_data()

subroutine, public tidal_bay_initialization::tidal_bay_set_obc_data	(	type(ocean_obc_type), pointer	OBC,
		type(tidal_bay_obc_cs), pointer	CS,
		type(ocean_grid_type), intent(in)	G,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in)	h,
		type(time_type), intent(in)	Time
	)

This subroutine sets the properties of flow at open boundary conditions.

Parameters

	obc	This open boundary condition type specifies whether, where, and what open boundary conditions are used.
	cs	tidal bay control structure.
[in]	g	The ocean's grid structure.
[in]	h	layer thickness.
[in]	time	model time.

Definition at line 79 of file tidal_bay_initialization.F90.

  type(ocean_obc_type),   pointer    :: obc  !< This open boundary condition type specifies
                                             !! whether, where, and what open boundary
                                             !! conditions are used.
  type(tidal_bay_obc_cs), pointer    :: cs   !< tidal bay control structure.
  type(ocean_grid_type),  intent(in) :: g    !< The ocean's grid structure.
  real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  intent(in) :: h !< layer thickness.
  type(time_type),        intent(in) :: time !< model time.

  ! The following variables are used to set up the transport in the tidal_bay example.
  real :: time_sec, cff
  real :: my_flux, total_area
  real :: pi
  real, allocatable :: my_area(:,:)
  character(len=40)  :: mdl = "tidal_bay_set_OBC_data" ! This subroutine's name.
  integer :: i, j, k, itt, is, ie, js, je, isd, ied, jsd, jed, nz, n
  integer :: isdb, iedb, jsdb, jedb
  type(obc_segment_type), pointer :: segment

  is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = g%ke
  isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed
  isdb = g%IsdB ; iedb = g%IedB ; jsdb = g%JsdB ; jedb = g%JedB

  pi = 4.0*atan(1.0) ;

  if (.not.associated(obc)) return

  allocate(my_area(1:1,js:je))

  time_sec = time_type_to_real(time)
  cff = 0.1*sin(2.0*pi*time_sec/(12.0*3600.0))
  my_area=0.0
  my_flux=0.0
  segment => obc%segment(1)

  do j=segment%HI%jsc,segment%HI%jec ; do i=segment%HI%IscB,segment%HI%IecB
    if (obc%segnum_u(i,j) /= obc_none) then
      do k=1,nz
        my_area(1,j) = my_area(1,j) + h(i,j,k)*g%dyCu(i,j)
      enddo
    endif
  enddo ; enddo
  total_area = reproducing_sum(my_area)
  my_flux = - cs%tide_flow*sin(2.0*pi*time_sec/(12.0*3600.0))

  do n = 1, obc%number_of_segments
    segment => obc%segment(n)

    if (.not. segment%on_pe) cycle

    segment%normal_vel_bt(:,:) = my_flux/total_area
    segment%eta(:,:) = cff

  enddo ! end segment loop