mom_stochastics module reference

Top-level module for the MOM6 ocean model in coupled mode.

More…

Data Types

stochastic_cs

This control structure holds parameters for the MOM_stochastics module.

Functions/Subroutines

stochastics_init()

update_stochastics()

update_ocean_model uses the forcing in Ice_ocean_boundary to advance the ocean model’s state from the input value of Ocean_state (which must be for time time_start_update) for a time interval of Ocean_coupling_time_step, returning the publicly visible ocean surface properties in Ocean_sfc and storing the new ocean properties in Ocean_state.

Detailed Description

Top-level module for the MOM6 ocean model in coupled mode.

Type Documentation

type mom_stochastics/stochastic_cs

This control structure holds parameters for the MOM_stochastics module.

Type fields:

  • % do_sppt [logical] :: If true, stochastically perturb the diabatic.

  • % pert_epbl [logical] :: If true, then randomly perturb the KE dissipation and genration terms.

  • % id_sppt_wts [integer] :: Diagnostic id for SPPT.

  • % id_epbl1_wts [integer] :: Diagnostic id for epbl generation perturbation.

  • % id_epbl2_wts [integer] :: Diagnostic id for epbl dissipation perturbation.

  • % sppt_wts [real(:,:),allocatable] :: Random pattern for ocean SPPT tendencies with a number between 0 and 2 [nondim].

  • % epbl1_wts [real(:,:),allocatable] :: Random pattern for K.E. generation [nondim].

  • % epbl2_wts [real(:,:),allocatable] :: Random pattern for K.E. dissipation [nondim].

  • % diag [type( diag_ctrl ),pointer] :: structure used to regulate timing of diagnostic output

  • % time [type(time_type),pointer] :: Pointer to model time (needed for sponges)

Function/Subroutine Documentation

subroutine mom_stochastics/stochastics_init(dt, grid, GV, CS, param_file, diag, Time)
Parameters:

  • dt :: [in] time step [T ~> s]

  • grid :: [in] horizontal grid information

  • gv :: [in] vertical grid structure

  • cs :: [inout] stochastic control structure

  • param_file :: [in] A structure to parse for run-time parameters

  • diag :: [inout] structure to regulate diagnostic output

  • time :: model time

Call to:

mom_error_handler::calltree_enter mom_error_handler::calltree_leave stochastic_physics::init_stochastic_physics_ocn mom_diag_mediator::register_diag_field

Called from:

mom::initialize_mom

subroutine mom_stochastics/update_stochastics(CS)

update_ocean_model uses the forcing in Ice_ocean_boundary to advance the ocean model’s state from the input value of Ocean_state (which must be for time time_start_update) for a time interval of Ocean_coupling_time_step, returning the publicly visible ocean surface properties in Ocean_sfc and storing the new ocean properties in Ocean_state.

Parameters:

cs :: [inout] diabatic control structure

Call to:

mom_error_handler::calltree_enter stochastic_physics::run_stochastic_physics_ocn

Called from:

mom::step_mom