namespace dumbbell_initialization

Overview

Configures the model for the idealized dumbbell test case. More…

namespace dumbbell_initialization {

// global functions

subroutine, public dumbbell_initialize_topography(D D, G G, param_file param_file, max_depth max_depth);

subroutine, public dumbbell_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public dumbbell_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    );

subroutine, public dumbbell_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    param_file param_file,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    );

} // namespace dumbbell_initialization

Detailed Documentation

Configures the model for the idealized dumbbell test case.

Global Functions

subroutine, public dumbbell_initialize_topography(
    D D,
    G G,
    param_file param_file,
    max_depth max_depth
    )

Initialization of topography.

Parameters:

g	The dynamic horizontal grid type
d	Ocean bottom depth in the units of depth_max
param_file	Parameter file structure
max_depth	Maximum ocean depth in arbitrary units

subroutine, public dumbbell_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    just_read_params just_read_params
    )

Initializes the layer thicknesses to be uniform in the dumbbell test case.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
h	The thickness that is being initialized [H ~> m or kg m-2].
param_file	A structure indicating the open file to parse for model parameter values.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public dumbbell_initialize_temperature_salinity(
    T T,
    S S,
    h h,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    just_read_params just_read_params
    )

Initial values for temperature and salinity for the dumbbell test case.

Parameters:

g	Ocean grid structure
gv	Vertical grid structure
t	Potential temperature [degC]
s	Salinity [ppt]
h	Layer thickness [H ~> m or kg m-2]
param_file	Parameter file structure
eqn_of_state	Equation of state structure
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public dumbbell_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    param_file param_file,
    use_ALE use_ALE,
    CSp CSp,
    ACSp ACSp
    )

Initialize the restoring sponges for the dumbbell test case.

Parameters:

g	Horizontal grid control structure
gv	Vertical grid control structure
us	A dimensional unit scaling type
tv	Thermodynamic variables
param_file	Parameter file structure
use_ale	ALE flag
csp	Layered sponge control structure pointer
acsp	ALE sponge control structure pointer