mom_surface_forcing mom_surface_forcing::surface_forcing_cs integer integer mom_surface_forcing::id_clock_forcing id_clock_forcing A CPU time clock. set_forcing surface_forcing_init subroutine, public subroutine, public mom_surface_forcing::set_forcing (sfc_state, forces, fluxes, day_start, day_interval, G, US, CS) set_forcing sfc_state sfc_state forces forces fluxes fluxes day_start day_start day_interval day_interval G G US US CS CS Calls subroutines in this file to get surface forcing fields. It also allocates and initializes the fields in the forcing and mech_forcing types the first time it is called. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces fluxes A structure containing thermodynamic forcing fields day_start The start time of the fluxes day_interval Length of time over which these fluxes applied g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call buoyancy_forcing_const buoyancy_forcing_from_data_override buoyancy_forcing_from_files buoyancy_forcing_linear buoyancy_forcing_zero mom_error_handler::calltree_enter mom_error_handler::calltree_leave dumbbell_surface_forcing::dumbbell_buoyancy_forcing id_clock_forcing neverworld_wind_forcing scurve_wind_forcing wind_forcing_1gyre wind_forcing_2gyre wind_forcing_by_data_override wind_forcing_const wind_forcing_from_file wind_forcing_gyres mom_main subroutine subroutine mom_surface_forcing::wind_forcing_const (sfc_state, forces, tau_x0, tau_y0, day, G, US, CS) wind_forcing_const sfc_state sfc_state forces forces tau_x0 tau_x0 tau_y0 tau_y0 day day G G US US CS CS Sets the surface wind stresses to constant values. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces tau_x0 The zonal wind stress [Pa] tau_y0 The meridional wind stress [Pa] day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::wind_forcing_2gyre (sfc_state, forces, day, G, US, CS) wind_forcing_2gyre sfc_state sfc_state forces forces day day G G US US CS CS Sets the surface wind stresses to set up two idealized gyres. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::wind_forcing_1gyre (sfc_state, forces, day, G, US, CS) wind_forcing_1gyre sfc_state sfc_state forces forces day day G G US US CS CS Sets the surface wind stresses to set up a single idealized gyre. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::wind_forcing_gyres (sfc_state, forces, day, G, US, CS) wind_forcing_gyres sfc_state sfc_state forces forces day day G G US US CS CS Sets the surface wind stresses to set up idealized gyres. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::neverworld_wind_forcing (sfc_state, forces, day, G, US, CS) neverworld_wind_forcing sfc_state sfc_state forces forces day day G G US US CS CS Sets the surface wind stresses, forcestaux and forcestauy for the Neverworld forcing configuration. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day Time used for determining the fluxes. g Grid structure. us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call set_forcing subroutine subroutine mom_surface_forcing::scurve_wind_forcing (sfc_state, forces, day, G, US, CS) scurve_wind_forcing sfc_state sfc_state forces forces day day G G US US CS CS Sets the zonal wind stresses to a piecewise series of s-curves. sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day Time used for determining the fluxes. g Grid structure. us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call scurve set_forcing real function real function mom_surface_forcing::scurve (x, L) scurve x x L L Returns the value of a cosine-bell function evaluated at x/L. x non-dimensional position l non-dimensional width scurve_wind_forcing subroutine subroutine mom_surface_forcing::wind_forcing_from_file (sfc_state, forces, day, G, US, CS) wind_forcing_from_file sfc_state sfc_state forces forces day day G G US US CS CS sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_string_functions::uppercase set_forcing subroutine subroutine mom_surface_forcing::wind_forcing_by_data_override (sfc_state, forces, day, G, US, CS) wind_forcing_by_data_override sfc_state sfc_state forces forces day day G G US US CS CS sfc_state A structure containing fields that describe the surface state of the ocean. forces A structure with the driving mechanical forces day The time of the fluxes g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::buoyancy_forcing_from_files (sfc_state, fluxes, day, dt, G, US, CS) buoyancy_forcing_from_files sfc_state sfc_state fluxes fluxes day day dt dt G G US US CS CS Specifies zero surface bouyancy fluxes from input files. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing thermodynamic forcing fields day The time of the fluxes dt The amount of time over which the fluxes apply [s] g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::buoyancy_forcing_from_data_override (sfc_state, fluxes, day, dt, G, US, CS) buoyancy_forcing_from_data_override sfc_state sfc_state fluxes fluxes day day dt dt G G US US CS CS Specifies zero surface bouyancy fluxes from data over-ride. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing thermodynamic forcing fields day The time of the fluxes dt The amount of time over which the fluxes apply [s] g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::buoyancy_forcing_zero (sfc_state, fluxes, day, dt, G, CS) buoyancy_forcing_zero sfc_state sfc_state fluxes fluxes day day dt dt G G CS CS This subroutine specifies zero surface bouyancy fluxes. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing thermodynamic forcing fields day The time of the fluxes dt The amount of time over which the fluxes apply [s] g The ocean's grid structure cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::buoyancy_forcing_const (sfc_state, fluxes, day, dt, G, US, CS) buoyancy_forcing_const sfc_state sfc_state fluxes fluxes day day dt dt G G US US CS CS Sets up spatially and temporally constant surface heat fluxes. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing thermodynamic forcing fields day The time of the fluxes dt The amount of time over which the fluxes apply [s] g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine subroutine mom_surface_forcing::buoyancy_forcing_linear (sfc_state, fluxes, day, dt, G, US, CS) buoyancy_forcing_linear sfc_state sfc_state fluxes fluxes day day dt dt G G US US CS CS Sets surface fluxes of heat and salinity by restoring to temperature and salinity profiles that vary linearly with latitude. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing thermodynamic forcing fields day The time of the fluxes dt The amount of time over which the fluxes apply [s] g The ocean's grid structure us A dimensional unit scaling type cs pointer to control struct returned by a previous surface_forcing_init call mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_forcing subroutine, public subroutine, public mom_surface_forcing::forcing_save_restart (CS, G, Time, directory, time_stamped, filename_suffix) forcing_save_restart CS CS G G Time Time directory directory time_stamped time_stamped filename_suffix filename_suffix Save a restart file for the forcing fields. cs pointer to control struct returned by a previous surface_forcing_init call g The ocean's grid structure time model time at this call; needed for mpp_write calls directory directory into which to write these restart files time_stamped If true, the restart file names include a unique time stamp; the default is false. filename_suffix optional suffix (e.g., a time-stamp) to append to the restart fname mom_restart::save_restart mom_main subroutine, public subroutine, public mom_surface_forcing::surface_forcing_init (Time, G, US, param_file, diag, CS, tracer_flow_CSp) surface_forcing_init Time Time G G US US param_file param_file diag diag CS CS tracer_flow_CSp tracer_flow_CSp Initialize the surface forcing module. time The current model time g The ocean's grid structure us A dimensional unit scaling type param_file A structure to parse for run-time parameters diag structure used to regulate diagnostic output cs pointer to control struct returned by a previous surface_forcing_init call tracer_flow_csp Forcing for tracers? bfb_surface_forcing::bfb_surface_forcing_init mom_get_input::get_mom_input id_clock_forcing meso_surface_forcing::meso_surface_forcing_init mom_io::num_timelevels mom_restart::restart_init_end mom_restart::restore_state user_surface_forcing::user_surface_forcing_init mom_main subroutine subroutine mom_surface_forcing::surface_forcing_end (CS, fluxes) surface_forcing_end CS CS fluxes fluxes Deallocate memory associated with the surface forcing module. cs pointer to control struct returned by a previous surface_forcing_init call fluxes A structure containing thermodynamic forcing fields Functions that calculate the surface wind stresses and fluxes of buoyancy or temperature/salinity andfresh water, in ocean-only (solo) mode. These functions are called every time step, even if the wind stresses or buoyancy fluxes are constant in time - in that case these routines return quickly without doing anything. In addition, any I/O of forcing fields is controlled by surface_forcing_init, located in this file.