user_revise_forcing module reference¶
Provides a template for users to code updating the forcing fluxes.
Data Types¶
Control structure for |
Functions/Subroutines¶
This subroutine sets the surface wind stresses. |
|
Initialize the |
Detailed Description¶
Provides a template for users to code updating the forcing fluxes.
Type Documentation¶
-
type
user_revise_forcing/
user_revise_forcing_cs
¶ Control structure for
user_revise_forcing()
. .- Type fields:
%
cdrag
[real] :: The quadratic bottom drag coefficient [nondim].
Function/Subroutine Documentation¶
-
subroutine
user_revise_forcing/
user_alter_forcing
(sfc_state, fluxes, day, G, CS)¶ This subroutine sets the surface wind stresses.
- Parameters:
sfc_state :: [in] A structure containing fields that describe the surface state of the ocean.
fluxes :: [inout] A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs.
day :: [in] Time of the fluxes.
g :: [in] The ocean’s grid structure.
cs :: A pointer to the control structure returned by a previous call to surface_forcing_init.
-
subroutine
user_revise_forcing/
user_revise_forcing_init
(param_file, CS)¶ Initialize the
user_revise_forcing()
control structure. control structure.- Parameters:
param_file :: [in] 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.