scm_cvmix_tests module reference
Initial conditions and forcing for the single column model (SCM) CVMix test set.
Data Types
Container for surface forcing parameters. |
Functions/Subroutines
Initializes temperature and salinity for the SCM CVMix test example. |
|
Initializes surface forcing for the CVMix test case suite. |
|
Detailed Description
Initial conditions and forcing for the single column model (SCM) CVMix test set.
Type Documentation
- type scm_cvmix_tests/scm_cvmix_tests_cs
Container for surface forcing parameters.
- Type fields:
% usewindstress ::
logical, privateTrue to use wind stress.% useheatflux ::
logical, privateTrue to use heat flux.% useevaporation ::
logical, privateTrue to use evaporation.% usediurnalsw ::
logical, privateTrue to use diurnal sw radiation.% tau_x ::
real, private(Constant) Wind stress, X [R L Z T-2 ~> Pa]% tau_y ::
real, private(Constant) Wind stress, Y [R L Z T-2 ~> Pa]% surf_hf ::
real, private(Constant) Heat flux [C Z T-1 ~> m degC s-1]% surf_evap ::
real, private(Constant) Evaporation rate [Z T-1 ~> m s-1]% max_sw ::
real, privatemaximum of diurnal sw radiation [C Z T-1 ~> degC m s-1]% rho0 ::
real, privatereference density [R ~> kg m-3]% rho_restore ::
real, privateThe density that is used to convert piston velocities into salt or heat fluxes [R ~> kg m-3].
Function/Subroutine Documentation
- subroutine scm_cvmix_tests/scm_cvmix_tests_ts_init(T, S, h, G, GV, US, param_file, just_read)
Initializes temperature and salinity for the SCM CVMix test example.
- Parameters:
g :: [in] Grid structure
gv :: [in] Vertical grid structure
t :: [out] Potential temperature [C ~> degC]
s :: [out] Salinity [S ~> ppt]
h ::
h[in] Layer thickness [Z ~> m]us :: [in] A dimensional unit scaling type
param_file ::
param_file[in] Input parameter structurejust_read ::
just_read[in] If present and true, this call will only read parameters without changing T & S.
- Call to:
mdl- Called from:
- subroutine scm_cvmix_tests/scm_cvmix_tests_surface_forcing_init(Time, G, param_file, CS)
Initializes surface forcing for the CVMix test case suite.
- Parameters:
time :: [in] Model time
g :: [in] Grid structure
param_file ::
param_file[in] Input parameter structurecs :: Parameter container
- Call to:
- subroutine scm_cvmix_tests/scm_cvmix_tests_wind_forcing(sfc_state, forces, day, G, US, CS)
- Parameters:
sfc_state ::
sfc_state[in] Surface state structureforces ::
forces[inout] A structure with the driving mechanical forcesday ::
day[in] Time in daysg :: [inout] Grid structure
us :: [in] A dimensional unit scaling type
cs :: Container for SCM parameters
- subroutine scm_cvmix_tests/scm_cvmix_tests_buoyancy_forcing(sfc_state, fluxes, day, G, US, CS)
- Parameters:
sfc_state ::
sfc_state[in] Surface state structurefluxes ::
fluxes[inout] Surface fluxes structureday ::
day[in] Current model timeg :: [inout] Grid structure
us :: [in] A dimensional unit scaling type
cs :: Container for SCM parameters