namespace dumbbell_surface_forcing

Overview

Surface forcing for the dumbbell test case. More…

namespace dumbbell_surface_forcing {

// global functions

subroutine, public dumbbell_buoyancy_forcing(state state, fluxes fluxes, day day, dt dt, G G, CS CS);
subroutine, public dumbbell_dynamic_forcing(state state, fluxes fluxes, day day, dt dt, G G, CS CS);

subroutine, public dumbbell_surface_forcing_init(
    Time Time,
    G G,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    );

} // namespace dumbbell_surface_forcing

Detailed Documentation

Surface forcing for the dumbbell test case.

Global Functions

subroutine, public dumbbell_buoyancy_forcing(
    state state,
    fluxes fluxes,
    day day,
    dt dt,
    G G,
    CS CS
    )

Surface buoyancy (heat and fresh water) fluxes for the dumbbell test case.

Parameters:

state	A structure containing fields that describe the surface state of the ocean.
fluxes	A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs.
day	Time of the fluxes.
dt	The amount of time over which the fluxes apply [s]
g	The ocean’s grid structure
cs	A control structure returned by a previous call to dumbbell_surface_forcing_init

subroutine, public dumbbell_dynamic_forcing(
    state state,
    fluxes fluxes,
    day day,
    dt dt,
    G G,
    CS CS
    )

Dynamic forcing for the dumbbell test case.

Parameters:

state	A structure containing fields that describe the surface state of the ocean.
fluxes	A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs.
day	Time of the fluxes.
dt	The amount of time over which the fluxes apply [s]
g	The ocean’s grid structure
cs	A control structure returned by a previous call to dumbbell_surface_forcing_init

subroutine, public dumbbell_surface_forcing_init(
    Time Time,
    G G,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    )

Reads and sets up the forcing for the dumbbell test case.

Parameters:

time	The current model time.
g	The ocean’s grid structure
us	A dimensional unit scaling type
param_file	A structure to parse for run-time parameters
diag	A structure that is used to regulate diagnostic output.
cs	A pointer to the control structure for this module