mom_diapyc_energy_req mom_diapyc_energy_req::diapyc_energy_req_cs subroutine, public subroutine, public mom_diapyc_energy_req::diapyc_energy_req_test (h_3d, dt, tv, G, GV, US, CS, Kd_int) diapyc_energy_req_test h_3d h_3d dt dt tv tv G G GV GV US US CS CS Kd_int Kd_int This subroutine helps test the accuracy of the diapycnal mixing energy requirement code by writing diagnostics, possibly using an intensely mixing test profile of diffusivity. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h_3d Layer thickness before entrainment [H ~> m or kg m-2]. tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. dt The amount of time covered by this call [T ~> s]. cs This module's control structure. kd_int Interface diffusivities [Z2 T-1 ~> m2 s-1]. diapyc_energy_req_calc mom_error_handler::is_root_pe mom_error_handler::mom_error mom_diabatic_driver::diabatic subroutine, public subroutine, public mom_diapyc_energy_req::diapyc_energy_req_calc (h_in, T_in, S_in, Kd, energy_Kd, dt, tv, G, GV, US, may_print, CS) diapyc_energy_req_calc h_in h_in T_in T_in S_in S_in Kd Kd energy_Kd energy_Kd dt dt tv tv G G GV GV US US may_print may_print CS CS This subroutine uses a substantially refactored tridiagonal equation for diapycnal mixing of temperature and salinity to estimate the potential energy change due to diapycnal mixing in a column of water. It does this estimate 4 different ways, all of which should be equivalent, but reports only one. The various estimates are taken because they will later be used as templates for other bits of code. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h_in Layer thickness before entrainment, [H ~> m or kg m-2]. t_in The layer temperatures [degC]. s_in The layer salinities [ppt]. kd The interfaces diapycnal diffusivities [Z2 T-1 ~> m2 s-1]. dt The amount of time covered by this call [T ~> s]. energy_kd The column-integrated rate of energy consumption by diapycnal diffusion [R Z L2 T-3 ~> W m-2]. tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. may_print If present and true, write out diagnostics of energy use. cs This module's control structure. find_pe_chg find_pe_chg_orig diapyc_energy_req_test subroutine subroutine mom_diapyc_energy_req::find_pe_chg (Kddt_h0, dKddt_h, hp_a, hp_b, Th_a, Sh_a, Th_b, Sh_b, dT_to_dPE_a, dS_to_dPE_a, dT_to_dPE_b, dS_to_dPE_b, pres_Z, dT_to_dColHt_a, dS_to_dColHt_a, dT_to_dColHt_b, dS_to_dColHt_b, PE_chg, dPEc_dKd, dPE_max, dPEc_dKd_0, ColHt_cor) find_pe_chg Kddt_h0 Kddt_h0 dKddt_h dKddt_h hp_a hp_a hp_b hp_b Th_a Th_a Sh_a Sh_a Th_b Th_b Sh_b Sh_b dT_to_dPE_a dT_to_dPE_a dS_to_dPE_a dS_to_dPE_a dT_to_dPE_b dT_to_dPE_b dS_to_dPE_b dS_to_dPE_b pres_Z pres_Z dT_to_dColHt_a dT_to_dColHt_a dS_to_dColHt_a dS_to_dColHt_a dT_to_dColHt_b dT_to_dColHt_b dS_to_dColHt_b dS_to_dColHt_b PE_chg PE_chg dPEc_dKd dPEc_dKd dPE_max dPE_max dPEc_dKd_0 dPEc_dKd_0 ColHt_cor ColHt_cor This subroutine calculates the change in potential energy and or derivatives for several changes in an interfaces's diapycnal diffusivity times a timestep. kddt_h0 The previously used diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. dkddt_h The trial change in the diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. hp_a The effective pivot thickness of the layer above the interface, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. hp_b The effective pivot thickness of the layer below the interface, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. th_a An effective temperature times a thickness in the layer above, including implicit mixing effects with other yet higher layers [degC H ~> degC m or degC kg m-2]. sh_a An effective salinity times a thickness in the layer above, including implicit mixing effects with other yet higher layers [ppt H ~> ppt m or ppt kg m-2]. th_b An effective temperature times a thickness in the layer below, including implicit mixing effects with other yet lower layers [degC H ~> degC m or degC kg m-2]. sh_b An effective salinity times a thickness in the layer below, including implicit mixing effects with other yet lower layers [ppt H ~> ppt m or ppt kg m-2]. dt_to_dpe_a A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers above [R Z L2 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_a A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers above [R Z L2 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dpe_b A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers below [R Z L2 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_b A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers below [R Z L2 T-2 ppt-1 ~> J m-2 ppt-1]. pres_z The hydrostatic interface pressure, which is used to relate the changes in column thickness to the energy that is radiated as gravity waves and unavailable to drive mixing [R L2 T-2 m Z-1 ~> J m-3]. dt_to_dcolht_a A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers above [Z degC-1 ~> m degC-1]. ds_to_dcolht_a A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers above [Z ppt-1 ~> m ppt-1]. dt_to_dcolht_b A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers below [Z degC-1 ~> m degC-1]. ds_to_dcolht_b A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers below [Z ppt-1 ~> m ppt-1]. pe_chg The change in column potential energy from applying Kddt_h at the present interface [R Z L2 T-2 ~> J m-2]. dpec_dkd The partial derivative of PE_chg with Kddt_h, [R Z L2 T-2 H-1 ~> J m-3 or J kg-1]. dpe_max The maximum change in column potential energy that could be realizedd by applying a huge value of Kddt_h at the present interface [R Z L2 T-2 ~> J m-2]. dpec_dkd_0 The partial derivative of PE_chg with Kddt_h in the limit where Kddt_h = 0 [R Z L2 T-2 H-1 ~> J m-3 or J kg-1]. colht_cor The correction to PE_chg that is made due to a net change in the column height [R Z L2 T-2 ~> J m-2]. diapyc_energy_req_calc subroutine subroutine mom_diapyc_energy_req::find_pe_chg_orig (Kddt_h, h_k, b_den_1, dTe_term, dSe_term, dT_km1_t2, dS_km1_t2, dT_to_dPE_k, dS_to_dPE_k, dT_to_dPEa, dS_to_dPEa, pres_Z, dT_to_dColHt_k, dS_to_dColHt_k, dT_to_dColHta, dS_to_dColHta, PE_chg, dPEc_dKd, dPE_max, dPEc_dKd_0) find_pe_chg_orig Kddt_h Kddt_h h_k h_k b_den_1 b_den_1 dTe_term dTe_term dSe_term dSe_term dT_km1_t2 dT_km1_t2 dS_km1_t2 dS_km1_t2 dT_to_dPE_k dT_to_dPE_k dS_to_dPE_k dS_to_dPE_k dT_to_dPEa dT_to_dPEa dS_to_dPEa dS_to_dPEa pres_Z pres_Z dT_to_dColHt_k dT_to_dColHt_k dS_to_dColHt_k dS_to_dColHt_k dT_to_dColHta dT_to_dColHta dS_to_dColHta dS_to_dColHta PE_chg PE_chg dPEc_dKd dPEc_dKd dPE_max dPE_max dPEc_dKd_0 dPEc_dKd_0 This subroutine calculates the change in potential energy and or derivatives for several changes in an interfaces's diapycnal diffusivity times a timestep using the original form used in the first version of ePBL. kddt_h The diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. h_k The thickness of the layer below the interface [H ~> m or kg m-2]. b_den_1 The first term in the denominator of the pivot for the tridiagonal solver, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. dte_term A diffusivity-independent term related to the temperature change in the layer below the interface [degC H ~> degC m or degC kg m-2]. dse_term A diffusivity-independent term related to the salinity change in the layer below the interface [ppt H ~> ppt m or ppt kg m-2]. dt_km1_t2 A diffusivity-independent term related to the temperature change in the layer above the interface [degC]. ds_km1_t2 A diffusivity-independent term related to the salinity change in the layer above the interface [ppt]. pres_z The hydrostatic interface pressure, which is used to relate the changes in column thickness to the energy that is radiated as gravity waves and unavailable to drive mixing [R L2 T-2 ~> J m-3]. dt_to_dpe_k A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers below [R Z L2 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_k A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers below [R Z L2 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dpea A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers above [R Z L2 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpea A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers above [R Z L2 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dcolht_k A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers below [Z degC-1 ~> m degC-1]. ds_to_dcolht_k A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers below [Z ppt-1 ~> m ppt-1]. dt_to_dcolhta A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers above [Z degC-1 ~> m degC-1]. ds_to_dcolhta A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers above [Z ppt-1 ~> m ppt-1]. pe_chg The change in column potential energy from applying Kddt_h at the present interface [R Z L2 T-2 ~> J m-2]. dpec_dkd The partial derivative of PE_chg with Kddt_h, [R Z L2 T-2 H-1 ~> J m-3 or J kg-1]. dpe_max The maximum change in column potential energy that could be realized by applying a huge value of Kddt_h at the present interface [R Z L2 T-2 ~> J m-2]. dpec_dkd_0 The partial derivative of PE_chg with Kddt_h in the limit where Kddt_h = 0 [R Z L2 T-2 H-1 ~> J m-3 or J kg-1]. diapyc_energy_req_calc subroutine, public subroutine, public mom_diapyc_energy_req::diapyc_energy_req_init (Time, G, GV, US, param_file, diag, CS) diapyc_energy_req_init Time Time G G GV GV US US param_file param_file diag diag CS CS Initialize parameters and allocate memory associated with the diapycnal energy requirement module. time model time g model grid structure gv ocean vertical grid structure us A dimensional unit scaling type param_file file to parse for parameter values diag structure to regulate diagnostic output cs module control structure mom_diag_mediator::register_diag_field subroutine, public subroutine, public mom_diapyc_energy_req::diapyc_energy_req_end (CS) diapyc_energy_req_end CS CS Clean up and deallocate memory associated with the diapycnal energy requirement module. cs Diapycnal energy requirement control structure that will be deallocated in this subroutine. Calculates the energy requirements of mixing.