mom_ice_shelf_initialize module reference

Initialize ice shelf variables.

Functions/Subroutines

`initialize_ice_thickness()`	Initialize ice shelf thickness.
`initialize_ice_thickness_from_file()`	Initialize ice shelf thickness from file.
`initialize_ice_thickness_channel()`	Initialize ice shelf thickness for a channel configuration.
`initialize_ice_shelf_boundary_channel()`	Initialize ice shelf boundary conditions for a channel configuration.
`initialize_ice_flow_from_file()`	Initialize ice shelf flow from file.
`initialize_ice_shelf_boundary_from_file()`	Initialize ice shelf b.c.s from file.
`initialize_ice_c_basal_friction()`	Initialize ice basal friction.
`initialize_ice_aglen()`	Initialize ice-stiffness parameter.
`initialize_ice_smb()`	Initialize ice surface mass balance field that is held constant over time.

Detailed Description

Initialize ice shelf variables.

Function/Subroutine Documentation

subroutine mom_ice_shelf_initialize/initialize_ice_thickness(h_shelf, area_shelf_h, hmask, melt_mask, G, G_in, US, PF, rotate_index, turns)

Initialize ice shelf thickness.

Parameters:

g :: [in] The ocean’s grid structure
g_in :: [in] The ocean’s unrotated grid structure
h_shelf :: h_shelf [inout] The ice shelf thickness [Z ~> m].
area_shelf_h :: area_shelf_h [inout] The area per cell covered by the ice shelf [L2 ~> m2].
hmask :: hmask [inout] A mask indicating which tracer points are
melt_mask :: melt_mask [inout] A mask indicating where to allow ice-shelf melting [nondim]
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters
rotate_index :: rotate_index [in] If true, this is a rotation test
turns :: turns [in] Number of turns for rotation test

Call to:

initialize_ice_thickness_channel initialize_ice_thickness_from_file mom_error_handler::mom_error user_shelf_init::user_init_ice_thickness

Called from:

mom_ice_shelf::initialize_ice_shelf

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_thickness_from_file(h_shelf, area_shelf_h, hmask, melt_mask, G, US, PF)

Initialize ice shelf thickness from file.

Parameters:

g :: [in] The ocean’s grid structure
h_shelf :: h_shelf [inout] The ice shelf thickness [Z ~> m].
area_shelf_h :: area_shelf_h [inout] The area per cell covered by the ice shelf [L2 ~> m2].
hmask :: hmask [inout] A mask indicating which tracer points are
melt_mask :: melt_mask [inout] A mask indicating where to allow ice-shelf melting [nondim]
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

Called from:

initialize_ice_thickness

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_thickness_channel(h_shelf, area_shelf_h, hmask, G, US, PF)

Initialize ice shelf thickness for a channel configuration.

Parameters:

g :: [in] The ocean’s grid structure
h_shelf :: h_shelf [inout] The ice shelf thickness [Z ~> m].
area_shelf_h :: area_shelf_h [inout] The area per cell covered by the ice shelf [L2 ~> m2].
hmask :: hmask [inout] A mask indicating which tracer points are
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_mesg

Called from:

initialize_ice_thickness

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_shelf_boundary_channel(u_face_mask_bdry, v_face_mask_bdry, u_flux_bdry_val, v_flux_bdry_val, u_bdry_val, v_bdry_val, u_shelf, v_shelf, h_bdry_val, hmask, h_shelf, G, US, PF)

Initialize ice shelf boundary conditions for a channel configuration.

Parameters:

g :: [in] The ocean’s grid structure
u_face_mask_bdry :: u_face_mask_bdry [inout] A boundary-type mask at C-grid u faces
u_flux_bdry_val :: u_flux_bdry_val [inout] The boundary thickness flux through
v_face_mask_bdry :: v_face_mask_bdry [inout] A boundary-type mask at C-grid v faces
v_flux_bdry_val :: v_flux_bdry_val [inout] The boundary thickness flux through
u_bdry_val :: u_bdry_val [inout] The zonal ice shelf velocity at open
v_bdry_val :: v_bdry_val [inout] The meridional ice shelf velocity at open
u_shelf :: u_shelf [inout] The zonal ice shelf velocity [L T-1 ~> m s-1].
v_shelf :: v_shelf [inout] The meridional ice shelf velocity [L T-1 ~> m s-1].
h_bdry_val :: h_bdry_val [inout] The ice shelf thickness at open boundaries [Z ~> m]
hmask :: hmask [inout] A mask indicating which tracer points are
h_shelf :: h_shelf [inout] Ice-shelf thickness [Z ~> m]
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_mesg

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_flow_from_file(bed_elev, u_shelf, v_shelf, float_cond, G, US, PF)

Initialize ice shelf flow from file.

Parameters:

g :: [in] The ocean’s grid structure
bed_elev :: bed_elev [inout] The bed elevation [Z ~> m].
u_shelf :: u_shelf [inout] The zonal ice shelf velocity [L T-1 ~> m s-1].
v_shelf :: v_shelf [inout] The meridional ice shelf velocity [L T-1 ~> m s-1].
float_cond :: float_cond [inout] An array indicating where the ice
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_shelf_boundary_from_file(u_face_mask_bdry, v_face_mask_bdry, u_bdry_val, v_bdry_val, umask, vmask, h_bdry_val, hmask, h_shelf, G, US, PF)

Initialize ice shelf b.c.s from file.

Parameters:

g :: [in] The ocean’s grid structure
u_face_mask_bdry :: u_face_mask_bdry [inout] A boundary-type mask at B-grid u faces [nondim]
v_face_mask_bdry :: v_face_mask_bdry [inout] A boundary-type mask at B-grid v faces [nondim]
u_bdry_val :: u_bdry_val [inout] The zonal ice shelf velocity at open
v_bdry_val :: v_bdry_val [inout] The meridional ice shelf velocity at open
umask :: umask [inout] A mask for ice shelf velocity [nondim]
vmask :: vmask [inout] A mask for ice shelf velocity [nondim]
h_bdry_val :: h_bdry_val [inout] The ice shelf thickness at open boundaries [Z ~> m]
hmask :: hmask [inout] A mask indicating which tracer points are
h_shelf :: h_shelf [in] Ice-shelf thickness [Z ~> m]
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_c_basal_friction(C_basal_friction, G, US, PF)

Initialize ice basal friction.

Parameters:

g :: [in] The ocean’s grid structure
c_basal_friction :: [inout] Ice-stream basal friction
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_aglen(AGlen, ice_viscosity_compute, G, US, PF)

Initialize ice-stiffness parameter.

Parameters:

g :: [in] The ocean’s grid structure
aglen :: [inout] The ice-stiffness parameter A_Glen, often in [Pa-3 s-1]
ice_viscosity_compute :: ice_viscosity_compute Specifies whether the ice viscosity is computed internally according to Glen’s flow law; is constant (for debugging purposes) or using observed strain rates and read from a file
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

Called from:

mom_ice_shelf_dynamics::initialize_ice_shelf_dyn

[source]

subroutine mom_ice_shelf_initialize/initialize_ice_smb(SMB, G, US, PF)

Initialize ice surface mass balance field that is held constant over time.

Parameters:

g :: [in] The ocean’s grid structure
smb :: [inout] Ice surface mass balance parameter, often in [R Z T-1 ~> kg m-2 s-1]
us :: [in] A structure containing unit conversion factors
pf :: [in] A structure to parse for run-time parameters

Call to:

mom_error_handler::mom_error mom_error_handler::mom_mesg

Called from:

mom6

[source]