namespace scm_cvmix_tests

Overview

Initial conditions and forcing for the single column model (SCM) CVMix test set. More…

namespace scm_cvmix_tests {

// global functions

subroutine, public scm_cvmix_tests_ts_init(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public scm_cvmix_tests_surface_forcing_init(Time Time, G G, param_file param_file, CS CS);
subroutine, public scm_cvmix_tests_wind_forcing(state state, forces forces, day day, G G, US US, CS CS);
subroutine, public scm_cvmix_tests_buoyancy_forcing(state state, fluxes fluxes, day day, G G, CS CS);

} // namespace scm_cvmix_tests

Detailed Documentation

Initial conditions and forcing for the single column model (SCM) CVMix test set.

Global Functions

subroutine, public scm_cvmix_tests_ts_init(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initializes temperature and salinity for the SCM CVMix test example.

Parameters:

t	Potential temperature [degC]
s	Salinity [psu]
h	Layer thickness [H ~> m or kg m-2]
g	Grid structure
gv	Vertical grid structure
us	A dimensional unit scaling type
param_file	Input parameter structure
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public scm_cvmix_tests_surface_forcing_init(
    Time Time,
    G G,
    param_file param_file,
    CS CS
    )

Initializes surface forcing for the CVMix test case suite.

Parameters:

time	Model time
g	Grid structure
param_file	Input parameter structure
cs	Parameter container

subroutine, public scm_cvmix_tests_wind_forcing(
    state state,
    forces forces,
    day day,
    G G,
    US US,
    CS CS
    )

Parameters:

state	Surface state structure
forces	A structure with the driving mechanical forces
day	Time in days
g	Grid structure
us	A dimensional unit scaling type
cs	Container for SCM parameters

subroutine, public scm_cvmix_tests_buoyancy_forcing(
    state state,
    fluxes fluxes,
    day day,
    G G,
    CS CS
    )

Parameters:

state	Surface state structure
fluxes	Surface fluxes structure
day	Current model time
g	Grid structure
cs	Container for SCM parameters