namespace user_change_diffusivity

Overview

Increments the diapycnal diffusivity in a specified band of latitudes and densities. More…

namespace user_change_diffusivity {

// global functions

subroutine, public user_change_diff(
    h h,
    tv tv,
    G G,
    GV GV,
    CS CS,
    Kd_lay Kd_lay,
    Kd_int Kd_int,
    T_f T_f,
    S_f S_f,
    Kd_int_add Kd_int_add
    );

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

subroutine, public user_change_diff_end(CS CS);

} // namespace user_change_diffusivity

Detailed Documentation

Increments the diapycnal diffusivity in a specified band of latitudes and densities.

Global Functions

subroutine, public user_change_diff(
    h h,
    tv tv,
    G G,
    GV GV,
    CS CS,
    Kd_lay Kd_lay,
    Kd_int Kd_int,
    T_f T_f,
    S_f S_f,
    Kd_int_add Kd_int_add
    )

This subroutine provides an interface for a user to use to modify the main code to alter the diffusivities as needed. The specific example implemented here augments the diffusivity for a specified range of latitude and coordinate potential density.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure
h	Layer thickness [H ~> m or kg m-2].
tv	A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs.
cs	This module’s control structure.
kd_lay	The diapycnal diffusivity of each layer [Z2 T-1 ~> m2 s-1].
kd_int	The diapycnal diffusivity at each interface [Z2 T-1 ~> m2 s-1].
t_f	Temperature with massless layers filled in vertically [degC].
s_f	Salinity with massless layers filled in vertically [ppt].
kd_int_add	The diapycnal diffusivity that is being added at each interface [Z2 T-1 ~> m2 s-1].

subroutine, public user_change_diff_init(
    Time Time,
    G G,
    GV GV,
    US US,
    param_file param_file,
    diag diag,
    CS CS
    )

Set up the module control structure.

Parameters:

time	The current model time.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure
us	A dimensional unit scaling type
param_file	A structure indicating the open file to parse for model parameter values.
diag	A structure that is used to regulate diagnostic output.
cs	A pointer that is set to point to the control structure for this module.

subroutine, public user_change_diff_end(CS CS)

Clean up the module control structure.

Parameters:

cs	A pointer that is set to point to the control structure for this module.