mom_controlled_forcing mom_controlled_forcing::ctrl_forcing_cs subroutine, public subroutine, public mom_controlled_forcing::apply_ctrl_forcing (SST_anom, SSS_anom, SSS_mean, virt_heat, virt_precip, day_start, dt, G, US, CS) apply_ctrl_forcing SST_anom SST_anom SSS_anom SSS_anom SSS_mean SSS_mean virt_heat virt_heat virt_precip virt_precip day_start day_start dt dt G G US US CS CS This subroutine calls any of the other subroutines in this file that are needed to specify the current surface forcing fields. g The ocean's grid structure. sst_anom The sea surface temperature anomalies [degC]. sss_anom The sea surface salinity anomlies [ppt]. sss_mean The mean sea surface salinity [ppt]. virt_heat Virtual (corrective) heat fluxes that are augmented in this subroutine [W m-2]. virt_precip Virtual (corrective) precipitation fluxes that are augmented in this subroutine [kg m-2 s-1]. day_start Start time of the fluxes. dt Length of time over which these fluxes will be applied [s]. us A dimensional unit scaling type cs A pointer to the control structure returned by a previous call to ctrl_forcing_init. mom_error_handler::mom_error periodic_int periodic_real mom_time_manager::real_to_time integer function integer function mom_controlled_forcing::periodic_int (rval, num_period) periodic_int rval rval num_period num_period This function maps rval into an integer in the range from 1 to num_period. rval Input for mapping. num_period Maximum output. Return value. apply_ctrl_forcing real function real function mom_controlled_forcing::periodic_real (rval, num_period) periodic_real rval rval num_period num_period This function shifts rval by an integer multiple of num_period so that 0 <= val_out < num_period. rval Input to be shifted into valid range. num_period Maximum valid value. Return value. apply_ctrl_forcing subroutine, public subroutine, public mom_controlled_forcing::register_ctrl_forcing_restarts (G, param_file, CS, restart_CS) register_ctrl_forcing_restarts G G param_file param_file CS CS restart_CS restart_CS This subroutine is used to allocate and register any fields in this module that should be written to or read from the restart file. g The ocean's grid structure. param_file A structure indicating the open file to parse for model parameter values. cs A pointer that is set to point to the control structure for this module. restart_cs A pointer to the restart control structure. mom_error_handler::mom_error mom_io::var_desc subroutine, public subroutine, public mom_controlled_forcing::controlled_forcing_init (Time, G, param_file, diag, CS) controlled_forcing_init Time Time G G param_file param_file diag diag CS CS Set up this modules control structure. time The current model time. g The ocean's grid structure. 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 subroutine, public mom_controlled_forcing::controlled_forcing_end (CS) controlled_forcing_end CS CS Clean up this modules control structure. cs A pointer to the control structure returned by a previous call to controlled_forcing_init, it will be deallocated here. Use control-theory to adjust the surface heat flux and precipitation. * By Robert Hallberg, July 2011 * This program contains the subroutines that use control-theory * to adjust the surface heat flux and precipitation, based on the * time-mean or periodically (seasonally) varying anomalies from the * observed state. The techniques behind this are described in * Hallberg and Adcroft (2011, in prep.). *Macros written all in capital letters are defined in MOM_memory.h. *A small fragment of the grid is shown below: *j+1 x ^ x ^ x At x: q * j+1 > o > o > At ^: v, tauy * j x ^ x ^ x At >: u, taux * j > o > o > At o: h, fluxes. * j-1 x ^ x ^ x * i-1 i i+1 At x & ^: * i i+1 At > & o: *The boundaries always run through q grid points (x). * Adjustments are based on the time-mean or periodically (seasonally) varying anomalies from the observed state.The techniques behind this are described in Hallberg and Adcroft (2018, in prep.).