user_change_diffusivity user_change_diffusivity::user_change_diff_cs subroutine, public subroutine, public user_change_diffusivity::user_change_diff (h, tv, G, GV, US, CS, Kd_lay, Kd_int, T_f, S_f, Kd_int_add) user_change_diff h h tv tv G G GV GV US US 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. 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. us A dimensional unit scaling type 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]. mom_eos::eos_domain mom_error_handler::mom_error range_ok val_weights logical function logical function user_change_diffusivity::range_ok (range) range_ok range range This subroutine checks whether the 4 values of range are in ascending order. range Four values to check. Return value. user_change_diff user_change_diff_init real function real function user_change_diffusivity::val_weights (val, range) val_weights val val range range This subroutine returns a value that goes smoothly from 0 to 1, stays at 1, and then goes smoothly back to 0 at the four values of range. The transitions are cubic, and have zero first derivatives where the curves hit 0 and 1. The values in range must be in ascending order, as can be checked by calling range_OK. val Value for which we need an answer [arbitrary units]. range Range over which the answer is non-zero [arbitrary units]. Return value [nondim]. user_change_diff subroutine, public subroutine, public user_change_diffusivity::user_change_diff_init (Time, G, GV, US, param_file, diag, CS) 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. 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. mom_error_handler::mom_error range_ok subroutine, public subroutine, public user_change_diffusivity::user_change_diff_end (CS) user_change_diff_end CS CS Clean up the module control structure. cs A pointer that is set to point to the control structure for this module. mom_set_diffusivity::set_diffusivity_end Increments the diapycnal diffusivity in a specified band of latitudes and densities.