mom_surface_forcing module reference

Functions that calculate the surface wind stresses and fluxes of buoyancy or temperature/salinity and fresh water, in ocean-only (solo) mode.

More…

Data Types

surface_forcing_cs

Structure containing pointers to the forcing fields that may be used to drive MOM.

Functions/Subroutines

`set_forcing()`	Calls subroutines in this file to get surface forcing fields.
`wind_forcing_const()`	Sets the surface wind stresses to constant values.
`wind_forcing_2gyre()`	Sets the surface wind stresses to set up two idealized gyres.
`wind_forcing_1gyre()`	Sets the surface wind stresses to set up a single idealized gyre.
`wind_forcing_gyres()`	Sets the surface wind stresses to set up idealized gyres.
`neverworld_wind_forcing()`	Sets the surface wind stresses, forcestaux and forcestauy for the Neverworld forcing configuration.
`scurve_wind_forcing()`	Sets the zonal wind stresses to a piecewise series of s-curves.
`scurve()`	Returns the value of a cosine-bell function evaluated at x/L.
`wind_forcing_from_file()`
`wind_forcing_by_data_override()`
`stresses_to_ustar()`	Translate the wind stresses into the friction velocity, including effects of background gustiness.
`buoyancy_forcing_from_files()`	Specifies zero surface buoyancy fluxes from input files.
`buoyancy_forcing_from_data_override()`	Specifies zero surface buoyancy fluxes from data over-ride.
`buoyancy_forcing_zero()`	This subroutine specifies zero surface buoyancy fluxes.
`buoyancy_forcing_const()`	Sets up spatially and temporally constant surface heat fluxes.
`buoyancy_forcing_linear()`	Sets surface fluxes of heat and salinity by restoring to temperature and salinity profiles that vary linearly with latitude.
`get_file_time_level()`	Return a time record to read from a file based on the model time, the number of time records in that file and the number of time records per model day.
`marbl_forcing_from_data_override()`	Sets the necessary MARBL forcings via the data override facility.
`forcing_save_restart()`	Save a restart file for the forcing fields.
`surface_forcing_init()`	Initialize the surface forcing module.
`surface_forcing_end()`	Deallocate memory associated with the surface forcing module.

Detailed Description

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.

Type Documentation

type mom_surface_forcing/surface_forcing_cs

Structure containing pointers to the forcing fields that may be used to drive MOM. All fluxes are positive into the ocean.

Type fields:

% urf_cs :: type(user_revise_forcing_cs), pointer Control structures for named forcing packages.
% user_forcing_csp :: type(user_surface_forcing_cs), pointer Control structures for named forcing packages.
% bfb_forcing_csp :: type(bfb_surface_forcing_cs), pointer Control structures for named forcing packages.
% dumbbell_forcing_csp :: type(dumbbell_surface_forcing_cs), pointer Control structures for named forcing packages.
% meso_forcing_csp :: type(meso_surface_forcing_cs), pointer Control structures for named forcing packages.
% idealized_hurricane_csp :: type(idealized_hurricane_cs), pointer Control structures for named forcing packages.
% scm_cvmix_tests_csp :: type(scm_cvmix_tests_cs), pointer Control structures for named forcing packages.
% marbl_forcing_csp :: type(marbl_forcing_cs), pointer Control structures for named forcing packages.
% use_temperature :: logical if true, temp & salinity used as state variables
% restorebuoy :: logical if true, use restoring surface buoyancy forcing
% adiabatic :: logical if true, no diapycnal mass fluxes or surface buoyancy forcing
% nonbous :: logical If true, this run is fully non-Boussinesq.
% variable_winds :: logical if true, wind stresses vary with time
% variable_buoyforce :: logical if true, buoyancy forcing varies with time.
% south_lat :: real southern latitude of the domain [degrees_N] or [km] or [m]
% len_lat :: real domain length in latitude [degrees_N] or [km] or [m]
% rho0 :: real Boussinesq reference density [R ~> kg m-3].
% g_earth :: real gravitational acceleration [L2 Z-1 T-2 ~> m s-2]
% flux_const :: real piston velocity for surface restoring [Z T-1 ~> m s-1]
% flux_const_t :: real piston velocity for surface temperature restoring [Z T-1 ~> m s-1]
% flux_const_s :: real piston velocity for surface salinity restoring [Z T-1 ~> m s-1]
% rho_restore :: real The density that is used to convert piston velocities into salt or heat fluxes with salinity or temperature restoring [R ~> kg m-3].
% latent_heat_fusion :: real latent heat of fusion times [Q ~> J kg-1]
% latent_heat_vapor :: real latent heat of vaporization [Q ~> J kg-1]
% tau_x0 :: real Constant zonal wind stress used in the WIND_CONFIG=”const” forcing [R L Z T-2 ~> Pa].
% tau_y0 :: real Constant meridional wind stress used in the WIND_CONFIG=”const” forcing [R L Z T-2 ~> Pa].
% taux_mag :: real Peak magnitude of the zonal wind stress for several analytic profiles [R L Z T-2 ~> Pa].
% gust_const :: real constant unresolved background gustiness for ustar [R Z2 T-2 ~> Pa]
% read_gust_2d :: logical if true, use 2-dimensional gustiness supplied from a file
% gust :: real, dimension(:,:), pointer spatially varying unresolved background gustiness [R L Z T-2 ~> Pa] gust is used when read_gust_2d is true.
% t_restore :: real, dimension(:,:), pointer temperature to damp (restore) the SST to [C ~> degC]
% s_restore :: real, dimension(:,:), pointer salinity to damp (restore) the SSS [S ~> ppt]
% dens_restore :: real, dimension(:,:), pointer density to damp (restore) surface density [R ~> kg m-3]
% gyres_taux_const :: real A constant wind stress [R L Z T-2 ~> Pa].
% gyres_taux_sin_amp :: real The amplitude of cosine wind stress gyres [R L Z T-2 ~> Pa], if WIND_CONFIG==’gyres’.
% gyres_taux_cos_amp :: real The amplitude of cosine wind stress gyres [R L Z T-2 ~> Pa], if WIND_CONFIG==’gyres’.
% gyres_taux_n_pis :: real The number of sine lobes in the basin if WIND_CONFIG==’gyres’ [nondim].
% answer_date :: integer This 8-digit integer gives the approximate date with which the order of arithmetic and expressions were added to the code. Dates before 20190101 use original answers. Dates after 20190101 use a form of the gyre wind stresses that are rotationally invariant and more likely to be the same between compilers.
% ustar_gustless_bug :: logical If true, include a bug in the time-averaging of the gustless wind friction velocity.
% use_marbl_tracers :: logical If true, allocate memory for forcing needed by MARBL.
% scurves_ydata :: real, dimension(20) Latitudes of scurve nodes [degreesN].
% scurves_taux :: real, dimension(20) Zonal wind stress values at scurve nodes [R L Z T-2 ~> Pa].
% t_north :: real Target temperatures at north used in buoyancy_forcing_linear [C ~> degC].
% t_south :: real Target temperatures at south used in buoyancy_forcing_linear [C ~> degC].
% s_north :: real Target salinity at north used in buoyancy_forcing_linear [S ~> ppt].
% s_south :: real Target salinity at south used in buoyancy_forcing_linear [S ~> ppt].
% first_call_set_forcing :: logical True until after the first call to set_forcing.
% archaic_omip_file :: logical If true use the variable names and data fields from a very old version of the OMIP forcing.
% dataoverrideisinitialized :: logical If true, data override has been initialized.
% wind_scale :: real value by which wind-stresses are scaled [nondim]
% constantheatforcing :: real value used for sensible heat flux when buoy_config=”const” [Q R Z T-1 ~> W m-2]
% wind_stagger :: character(len=8) A character indicating how the wind stress components are staggered in WIND_FILE. Valid values are A or C for now.
% tracer_flow_csp :: type(tracer_flow_control_cs), pointer A pointer to the structure that is used to orchestrate the calling of tracer packages.
% restart_csp :: type(mom_restart_cs), pointer A pointer to the restart control structure.
% diag :: type(diag_ctrl), pointer structure used to regulate timing of diagnostic output
% inputdir :: character(len=200) directory where NetCDF input files are.
% wind_config :: character(len=200) indicator for wind forcing type (2gyre, USER, FILE..)
% wind_file :: character(len=200) if wind_config is “file”, file to use
% buoy_config :: character(len=200) indicator for buoyancy forcing type
% longwave_file :: character(len=200) The file from which the longwave heat flux is read.
% shortwave_file :: character(len=200) The file from which the shortwave heat flux is read.
% evaporation_file :: character(len=200) The file from which the evaporation is read.
% sensibleheat_file :: character(len=200) The file from which the sensible heat flux is read.
% latentheat_file :: character(len=200) The file from which the latent heat flux is read.
% rain_file :: character(len=200) The file from which the rainfall is read.
% snow_file :: character(len=200) The file from which the snowfall is read.
% runoff_file :: character(len=200) The file from which the runoff is read.
% longwaveup_file :: character(len=200) The file from which the upward longwave heat flux is read.
% shortwaveup_file :: character(len=200) The file from which the upward shortwave heat flux is read.
% sstrestore_file :: character(len=200) The file from which to read the sea surface temperature to restore toward.
% salinityrestore_file :: character(len=200) The file from which to read the sea surface salinity to restore toward.
% stress_x_var :: character(len=80) X-wind stress variable name in the input file.
% stress_y_var :: character(len=80) Y-wind stress variable name in the input file.
% ustar_var :: character(len=80) ustar variable name in the input file
% lw_var :: character(len=80) longwave heat flux variable name in the input file
% sw_var :: character(len=80) shortwave heat flux variable name in the input file
% latent_var :: character(len=80) latent heat flux variable name in the input file
% sens_var :: character(len=80) sensible heat flux variable name in the input file
% evap_var :: character(len=80) evaporation variable name in the input file
% rain_var :: character(len=80) rainfall variable name in the input file
% snow_var :: character(len=80) snowfall variable name in the input file
% lrunoff_var :: character(len=80) liquid runoff variable name in the input file
% frunoff_var :: character(len=80) frozen runoff variable name in the input file
% sst_restore_var :: character(len=80) target sea surface temperature variable name in the input file
% sss_restore_var :: character(len=80) target sea surface salinity variable name in the input file
% wind_days_per_rec :: integer If positive the number of days of wind stress per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% sw_days_per_rec :: integer If positive the number of days shortwave heat flux per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% lw_days_per_rec :: integer If positive the number of days longwave heat flux per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% latent_days_per_rec :: integer If positive the number of days latent heat flux per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% sens_days_per_rec :: integer If positive the number of days sensible heat flux per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% evap_days_per_rec :: integer If positive the number of days evaporation per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% precip_days_per_rec :: integer If positive the number of days precipitation per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% runoff_days_per_rec :: integer If positive the number of days runoff per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% sst_days_per_rec :: integer If positive the number of days target SST per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% sss_days_per_rec :: integer If positive the number of days target SSS per forcing file time level, or if negative the number of time levels per day. If 31 change forcing monthly, or if 0 the model will guess the right value based on the file size.
% wind_nlev :: integer The number of time levels in the file of wind stress.
% sw_nlev :: integer The number of time levels in the file of shortwave heat flux.
% lw_nlev :: integer The number of time levels in the file of longwave heat flux.
% latent_nlev :: integer The number of time levels in the file of latent heat flux.
% sens_nlev :: integer The number of time levels in the file of sensible heat flux.
% evap_nlev :: integer The number of time levels in the file of evaporation.
% precip_nlev :: integer The number of time levels in the file of precipitation.
% runoff_nlev :: integer The number of time levels in the file of runoff.
% sst_nlev :: integer The number of time levels in the file of target SST.
% sss_nlev :: integer The number of time levels in the file of target SSS.
% wind_last_lev :: integer The last time level read of wind stress.
% sw_last_lev :: integer The last time level read of shortwave heat flux.
% lw_last_lev :: integer The last time level read of longwave heat flux.
% latent_last_lev :: integer The last time level read of latent heat flux.
% sens_last_lev :: integer The last time level read of sensible heat flux.
% evap_last_lev :: integer The last time level read of evaporation.
% precip_last_lev :: integer The last time level read of precipitation.
% runoff_last_lev :: integer The last time level read of runoff.
% sst_last_lev :: integer The last time level read of target SST.
% sss_last_lev :: integer The last time level read of target SSS.
% handles :: type(forcing_diags), public A structure with diagnostics handles.

mom_surface_forcing module reference

Data Types

Functions/Subroutines

Detailed Description

Type Documentation

Function/Subroutine Documentation