namespace user_shelf_init

Overview

This module specifies the initial values and evolving properties of the MOM6 ice shelf, using user-provided code. More…

namespace user_shelf_init {

// global functions

subroutine, public user_initialize_shelf_mass(
    mass_shelf mass_shelf,
    area_shelf_h area_shelf_h,
    h_shelf h_shelf,
    hmask hmask,
    G G,
    US US,
    CS CS,
    param_file param_file,
    new_sim new_sim
    );

subroutine, public user_init_ice_thickness(
    h_shelf h_shelf,
    area_shelf_h area_shelf_h,
    hmask hmask,
    G G,
    US US,
    param_file param_file
    );

subroutine, public user_update_shelf_mass(
    mass_shelf mass_shelf,
    area_shelf_h area_shelf_h,
    h_shelf h_shelf,
    hmask hmask,
    G G,
    CS CS,
    Time Time,
    new_sim new_sim
    );

} // namespace user_shelf_init

Detailed Documentation

This module specifies the initial values and evolving properties of the MOM6 ice shelf, using user-provided code.

Global Functions

subroutine, public user_initialize_shelf_mass(
    mass_shelf mass_shelf,
    area_shelf_h area_shelf_h,
    h_shelf h_shelf,
    hmask hmask,
    G G,
    US US,
    CS CS,
    param_file param_file,
    new_sim new_sim
    )

This subroutine sets up the initial mass and area covered by the ice shelf, based on user-provided code.

Parameters:

g	The ocean’s grid structure
mass_shelf	The ice shelf mass per unit area averaged
h_shelf	The ice shelf thickness [Z ~> m].
area_shelf_h	The area per cell covered by the ice shelf [m2].
hmask	A mask indicating which tracer points are
us	A structure containing unit conversion factors
cs	A pointer to the user ice shelf control structure
param_file	A structure to parse for run-time parameters
new_sim	If true, this is a new run; otherwise it is being started from a restart file.

subroutine, public user_init_ice_thickness(
    h_shelf h_shelf,
    area_shelf_h area_shelf_h,
    hmask hmask,
    G G,
    US US,
    param_file param_file
    )

This subroutine updates the ice shelf thickness, as specified by user-provided code.

Parameters:

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

subroutine, public user_update_shelf_mass(
    mass_shelf mass_shelf,
    area_shelf_h area_shelf_h,
    h_shelf h_shelf,
    hmask hmask,
    G G,
    CS CS,
    Time Time,
    new_sim new_sim
    )

This subroutine updates the ice shelf mass, as specified by user-provided code.

Parameters:

g	The ocean’s grid structure
mass_shelf	The ice shelf mass per unit area averaged
area_shelf_h	The area per cell covered by the ice shelf [m2].
h_shelf	The ice shelf thickness [Z ~> m].
hmask	A mask indicating which tracer points are
cs	A pointer to the user ice shelf control structure
time	The current model time
new_sim	If true, this the start of a new run.