stochastic_physics module reference¶

Functions/Subroutines¶

`init_stochastic_physics_ocn()`	Initializes the stochastic physics perturbations.
`run_stochastic_physics_ocn()`	Determines the stochastic physics perturbations.

Detailed Description¶

Function/Subroutine Documentation¶

subroutine stochastic_physics/init_stochastic_physics_ocn(delt, geoLonT, geoLatT, nx, ny, nz, pert_epbl_in, do_sppt_in, mpiroot, mpicomm, iret)¶

Initializes the stochastic physics perturbations.

Parameters:

delt :: [in] timestep in seconds between calls to run_stochastic_physics_ocn [s]
nx :: [in] number of gridpoints in the x-direction of the compute grid
ny :: [in] number of gridpoints in the y-direction of the compute grid
nz :: [in] number of gridpoints in the z-direction of the compute grid
geolont :: [in] Longitude in degrees
geolatt :: [in] Latitude in degrees
pert_epbl_in :: [in] logical flag, if true generate random pattern for ePBL perturbations
do_sppt_in :: [in] logical flag, if true generate random pattern for SPPT perturbations
mpiroot :: [in] root processor
mpicomm :: [in] mpi communicator
iret :: [out] return code

Call to:

mom_error_handler::mom_error

Called from:

mom_stochastics::stochastics_init

subroutine stochastic_physics/run_stochastic_physics_ocn(sppt_wts, t_rp1, t_rp2)¶

Determines the stochastic physics perturbations.

Parameters:

sppt_wts :: [inout] array containing random weights for SPPT range [0,2]
t_rp1 :: [inout] array containing random weights for ePBL perturbations (KE generation) range [0,2]
t_rp2 :: [inout] array containing random weights for ePBL perturbations (KE dissipation) range [0,2]

Called from:

mom_stochastics::update_stochastics