user_shelf_init Module Reference

Data Types
type	user_ice_shelf_cs

Functions/Subroutines
subroutine, public	user_initialize_shelf_mass (mass_shelf, area_shelf_h, h_shelf, hmask, G, CS, param_file, new_sim)
subroutine, public	user_init_ice_thickness (h_shelf, area_shelf_h, hmask, G, param_file)
subroutine, public	user_update_shelf_mass (mass_shelf, area_shelf_h, h_shelf, hmask, G, CS, Time, new_sim)
subroutine	write_user_log (param_file)

Variables
logical	first_call = .true.

Function/Subroutine Documentation

user_init_ice_thickness()

subroutine, public user_shelf_init::user_init_ice_thickness	(	real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	h_shelf,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	area_shelf_h,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	hmask,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file
	)

Parameters

[in]	g	The ocean's grid structure
[in]	param_file	A structure to parse for run-time parameters

Definition at line 173 of file user_shelf_init.F90.

References user_initialize_shelf_mass().

Referenced by mom_ice_shelf_initialize::initialize_ice_thickness().

  type(ocean_grid_type),            intent(in)  :: g    !< The ocean's grid structure
  real, dimension(SZI_(G),SZJ_(G)), intent(out) :: area_shelf_h, hmask, h_shelf
  type(param_file_type),            intent(in)  :: param_file !< A structure to parse for run-time parameters

  ! This subroutine initializes the ice shelf thickness.  Currently it does so
  ! calling USER_initialize_shelf_mass, but this can be revised as needed.
  real, dimension(SZI_(G),SZJ_(G)) :: mass_shelf
  type(user_ice_shelf_cs), pointer :: cs => null()

  call user_initialize_shelf_mass(mass_shelf, area_shelf_h, h_shelf, hmask, g, cs, param_file, .true.)

Here is the call graph for this function:

Here is the caller graph for this function:

user_initialize_shelf_mass()

subroutine, public user_shelf_init::user_initialize_shelf_mass	(	real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	mass_shelf,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	area_shelf_h,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	h_shelf,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(out)	hmask,
		type(ocean_grid_type), intent(in)	G,
		type(user_ice_shelf_cs), pointer	CS,
		type(param_file_type), intent(in)	param_file,
		logical	new_sim
	)

Parameters

[in]	g	The ocean's grid structure
[in]	param_file	A structure to parse for run-time parameters

Definition at line 115 of file user_shelf_init.F90.

References first_call, user_update_shelf_mass(), and write_user_log().

Referenced by user_init_ice_thickness().

  type(ocean_grid_type),            intent(in)  :: g    !< The ocean's grid structure
  real, dimension(SZI_(G),SZJ_(G)), intent(out) :: mass_shelf, area_shelf_h, hmask, h_shelf
  type(user_ice_shelf_cs),          pointer     :: cs
  type(param_file_type),            intent(in)  :: param_file !< A structure to parse for run-time parameters
  logical                                       :: new_sim

! Arguments: mass_shelf - The mass per unit area averaged over the full ocean
!                         cell, in kg m-2. (Intent out)
!  (out)     area_shelf_h - The area of the ocean cell that is covered by the
!                           rigid ice shelf, in m2.
!  (in)      G          - The ocean's grid structure.
!  (in)      param_file - A structure indicating the open file to parse for
!                         model parameter values.


! just check for cvs
! This subroutine sets up the initial mass and area covered by the ice shelf.
  real :: rho_ocean  ! The ocean's typical density, in kg m-3.
  real :: max_draft  ! The maximum ocean draft of the ice shelf, in m.
  real :: min_draft  ! The minimum ocean draft of the ice shelf, in m.
  real :: flat_shelf_width ! The range over which the shelf is min_draft thick.
  real :: c1 ! The maximum depths in m.
  character(len=40) :: mdl = "USER_initialize_shelf_mass" ! This subroutine's name.
  integer :: i, j

  ! call MOM_error(FATAL, "USER_shelf_init.F90, USER_set_shelf_mass: " // &
  !  "Unmodified user routine called - you must edit the routine to use it")

  if (.not.associated(cs)) allocate(cs)

  ! Read all relevant parameters and write them to the model log.
  if (first_call) call write_user_log(param_file)
  call get_param(param_file, mdl, "RHO_0", cs%Rho_ocean, &
                 "The mean ocean density used with BOUSSINESQ true to \n"//&
                 "calculate accelerations and the mass for conservation \n"//&
                 "properties, or with BOUSSINSEQ false to convert some \n"//&
                 "parameters from vertical units of m to kg m-2.", &
                 units="kg m-3", default=1035.0)
  call get_param(param_file, mdl, "SHELF_MAX_DRAFT", cs%max_draft, &
                 units="m", default=1.0)
  call get_param(param_file, mdl, "SHELF_MIN_DRAFT", cs%min_draft, &
                 units="m", default=1.0)
  call get_param(param_file, mdl, "FLAT_SHELF_WIDTH", cs%flat_shelf_width, &
                 units="axis_units", default=0.0)
  call get_param(param_file, mdl, "SHELF_SLOPE_SCALE", cs%shelf_slope_scale, &
                 units="axis_units", default=0.0)
  call get_param(param_file, mdl, "SHELF_EDGE_POS_0", cs%pos_shelf_edge_0, &
                 units="axis_units", default=0.0)
  call get_param(param_file, mdl, "SHELF_SPEED", cs%shelf_speed, &
                 units="axis_units day-1", default=0.0)

  call user_update_shelf_mass(mass_shelf, area_shelf_h, h_shelf, hmask, g, cs, set_time(0,0), new_sim)

Here is the call graph for this function:

Here is the caller graph for this function:

user_update_shelf_mass()

subroutine, public user_shelf_init::user_update_shelf_mass	(	real, dimension(szi_(g),szj_(g)), intent(inout)	mass_shelf,
		real, dimension(szi_(g),szj_(g)), intent(inout)	area_shelf_h,
		real, dimension(szi_(g),szj_(g)), intent(inout)	h_shelf,
		real, dimension(szi_(g),szj_(g)), intent(inout)	hmask,
		type(ocean_grid_type), intent(in)	G,
		type(user_ice_shelf_cs), pointer	CS,
		type(time_type), intent(in)	Time,
		logical, intent(in)	new_sim
	)

Parameters

[in]

g

The ocean's grid structure

Definition at line 187 of file user_shelf_init.F90.

Referenced by user_initialize_shelf_mass().

  type(ocean_grid_type),            intent(in)    :: g    !< The ocean's grid structure
  real, dimension(SZI_(G),SZJ_(G)), intent(inout) :: mass_shelf, area_shelf_h, hmask, h_shelf
  type(user_ice_shelf_cs),          pointer       :: cs
  type(time_type),                  intent(in)    :: time
  logical,                          intent(in)    :: new_sim

! Arguments: mass_shelf - The mass per unit area averaged over the full ocean
!                         cell, in kg m-2. (Intent out)
!  (out)     area_shelf_h - The area of the ocean cell that is covered by the
!                           rigid ice shelf, in m2.
!  (in)      G          - The ocean's grid structure.
!  (in)      param_file - A structure indicating the open file to parse for
!                         model parameter values.

  real :: c1, edge_pos, slope_pos
  integer :: i, j

  edge_pos = cs%pos_shelf_edge_0 + cs%shelf_speed*(time_type_to_real(time) / 86400.0)

  slope_pos = edge_pos - cs%flat_shelf_width
  c1 = 0.0 ; if (cs%shelf_slope_scale > 0.0) c1 = 1.0 / cs%shelf_slope_scale


  do j=g%jsd,g%jed ;

   if (((j+g%jdg_offset) .le. g%domain%njglobal+g%domain%njhalo) .AND. &
       ((j+g%jdg_offset) .ge. g%domain%njhalo+1)) then

    do i=g%isc,g%iec

!    if (((i+G%idg_offset) <= G%domain%niglobal+G%domain%nihalo) .AND. &
!           ((i+G%idg_offset) >= G%domain%nihalo+1)) then

    if ((j.ge.g%jsc) .and. (j.le.g%jec)) then

      if (new_sim) then ; if (g%geoLonCu(i-1,j) >= edge_pos) then
        ! Everything past the edge is open ocean.
        mass_shelf(i,j) = 0.0
        area_shelf_h(i,j) = 0.0
        hmask(i,j) = 0.0
        h_shelf(i,j) = 0.0
      else
        if (g%geoLonCu(i,j) > edge_pos) then
          area_shelf_h(i,j) = g%areaT(i,j) * (edge_pos - g%geoLonCu(i-1,j)) / &
                              (g%geoLonCu(i,j) - g%geoLonCu(i-1,j))
          hmask(i,j) = 2.0
        else
          area_shelf_h(i,j) = g%areaT(i,j)
          hmask(i,j) = 1.0
        endif

        if (g%geoLonT(i,j) > slope_pos) then
          h_shelf(i,j) = cs%min_draft
          mass_shelf(i,j) = cs%Rho_ocean * cs%min_draft
        else
          mass_shelf(i,j) = cs%Rho_ocean * (cs%min_draft + &
                 (cs%max_draft - cs%min_draft) * &
                 min(1.0, (c1*(slope_pos - g%geoLonT(i,j)))**2) )
          h_shelf(i,j) = (cs%min_draft + &
                 (cs%max_draft - cs%min_draft) * &
                 min(1.0, (c1*(slope_pos - g%geoLonT(i,j)))**2) )
        endif

    endif ; endif ; endif

    if ((i+g%idg_offset) .eq. g%domain%nihalo+1) then
      hmask(i-1,j) = 3.0
    endif

  enddo ; endif ; enddo

Here is the caller graph for this function:

write_user_log()

subroutine user_shelf_init::write_user_log ( type(param_file_type), intent(in)  param_file )

private

Parameters

[in]

param_file

A structure to parse for run-time parameters

Definition at line 261 of file user_shelf_init.F90.

References first_call.

Referenced by user_initialize_shelf_mass().

  type(param_file_type), intent(in) :: param_file !< A structure to parse for run-time parameters

  character(len=128) :: version = '$Id: user_shelf_init.F90,v 1.1.2.7 2012/06/19 22:15:52 Robert.Hallberg Exp $'
  character(len=128) :: tagname = '$Name: MOM_ogrp $'
  character(len=40)  :: mdl = "user_shelf_init" ! This module's name.

  call log_version(param_file, mdl, version, tagname)
  first_call = .false.

Here is the caller graph for this function:

Variable Documentation

first_call

logical user_shelf_init::first_call = .true.

private

Definition at line 100 of file user_shelf_init.F90.

Referenced by user_initialize_shelf_mass(), and write_user_log().

logical :: first_call = .true.