namespace user_revise_forcing¶

Overview¶

Provides a template for users to code updating the forcing fluxes. More…

namespace user_revise_forcing {

// global variables

character(len=40) mdl = "user_revise_forcing";

// global functions

subroutine, public user_alter_forcing(state state, fluxes fluxes, day day, G G, CS CS);
subroutine, public user_revise_forcing_init(param_file param_file, CS CS);

} // namespace user_revise_forcing

Detailed Documentation¶

Provides a template for users to code updating the forcing fluxes.

Global Variables¶

character(len=40) mdl = "user_revise_forcing"

This module’s name.

Global Functions¶

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

This subroutine sets the surface wind stresses.

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.
g	The ocean’s grid structure.
cs	A pointer to the control structure returned by a previous call to surface_forcing_init.

subroutine, public user_revise_forcing_init(param_file param_file, CS CS)

Initialize the user_revise_forcing control structure.

Parameters:

param_file	A structure indicating the open file to parse for model parameter values.
cs	A pointer to the control structure returned by a previous call to surface_forcing_init.