isomip_initialization module reference

Configures the ISOMIP test case.

Functions/Subroutines

`isomip_initialize_topography()`	Initialization of topography for the ISOMIP configuration.
`isomip_initialize_thickness()`	Initialization of thicknesses.
`isomip_initialize_temperature_salinity()`	Initial values for temperature and salinity.
`isomip_initialize_sponges()`	Sets up the inverse restoration time (Idamp), and the values towards which the interface heights and an arbitrary number of tracers should be restored within each sponge.

Detailed Description

See this paper for details: http://www.geosci-model-dev-discuss.net/8/9859/2015/gmdd-8-9859-2015.pdf .

Function/Subroutine Documentation

subroutine isomip_initialization/isomip_initialize_topography(D, G, param_file, max_depth, US)

Initialization of topography for the ISOMIP configuration.

Parameters:

g :: [in] The dynamic horizontal grid type
d :: [out] Ocean bottom depth [Z ~> m]
param_file :: param_file [in] Parameter file structure
max_depth :: max_depth [in] Maximum model depth [Z ~> m]
us :: [in] A dimensional unit scaling type

Call to:

mdl mom_error_handler::mom_error mom_error_handler::mom_mesg

Called from:

mom_fixed_initialization::mom_initialize_topography

[source]

subroutine isomip_initialization/isomip_initialize_thickness(h, depth_tot, G, GV, US, param_file, tv, just_read)

Initialization of thicknesses.

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
h :: h [out] The thickness that is being initialized [Z ~> m]
depth_tot :: depth_tot [in] The nominal total depth of the ocean [Z ~> m]
param_file :: param_file [in] A structure to parse for model parameter values
tv :: tv [in] A structure containing pointers to any available thermodynamic fields, including the eqn. of state.
just_read :: just_read [in] If true, this call will only read parameters without changing h.

Call to:

mdl mom_error_handler::mom_error mom_error_handler::mom_mesg regrid_consts::regridding_sigma_shelf_zstar

[source]

subroutine isomip_initialization/isomip_initialize_temperature_salinity(T, S, h, depth_tot, G, GV, US, param_file, eqn_of_state, just_read)

Initial values for temperature and salinity.

Parameters:

g :: [in] Ocean grid structure
gv :: [in] Vertical grid structure
us :: [in] A dimensional unit scaling type
t :: [out] Potential temperature [C ~> degC]
s :: [out] Salinity [S ~> ppt]
h :: h [in] Layer thickness [Z ~> m]
depth_tot :: depth_tot [in] The nominal total bottom-to-top depth of the ocean [Z ~> m]
param_file :: param_file [in] Parameter file structure
eqn_of_state :: eqn_of_state [in] Equation of state structure
just_read :: just_read [in] If true, this call will only read parameters without changing T & S.

Call to:

mdl mom_error_handler::mom_error regrid_consts::regridding_sigma_shelf_zstar

Called from:

mom_state_initialization::mom_initialize_state

[source]

subroutine isomip_initialization/isomip_initialize_sponges(G, GV, US, tv, depth_tot, PF, use_ALE, CSp, ACSp)

Sets up the inverse restoration time (Idamp), and the values towards which the interface heights and an arbitrary number of tracers should be restored within each sponge.

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
tv :: tv [in] A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
depth_tot :: depth_tot [in] The nominal total depth of the ocean [Z ~> m]
pf :: [in] A structure to parse for model parameter values
use_ale :: [in] If true, indicates model is in ALE mode
csp :: Layer-mode sponge structure
acsp :: ALE-mode sponge structure

Call to:

mom_sponge::initialize_sponge mdl mom_error_handler::mom_error regrid_consts::regridding_sigma_shelf_zstar mom_sponge::set_up_sponge_field

[source]