Detailed Description

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

Definition at line 71 of file MOM_surface_forcing.F90.

Collaboration diagram for mom_surface_forcing::surface_forcing_cs:

[legend]

Public variables and constants
logical	use_temperature
	if true, temp & salinity used as state variables More...

logical	restorebuoy
	if true, use restoring surface buoyancy forcing More...

logical	adiabatic
	if true, no diapycnal mass fluxes or surface buoyancy forcing More...

logical	variable_winds
	if true, wind stresses vary with time More...

logical	variable_buoyforce
	if true, buoyancy forcing varies with time. More...

real	south_lat
	southern latitude of the domain More...

real	len_lat
	domain length in latitude More...

real	rho0
	Boussinesq reference density [R ~> kg m-3]. More...

real	g_earth
	gravitational acceleration [L2 Z-1 T-2 ~> m s-2] More...

real	flux_const
	piston velocity for surface restoring [Z T-1 ~> m s-1] More...

real	flux_const_t
	piston velocity for surface temperature restoring [m s-1] More...

real	flux_const_s
	piston velocity for surface salinity restoring [Z T-1 ~> m s-1] More...

real	latent_heat_fusion
	latent heat of fusion times scaling factors [J T m-2 R-1 Z-1 s-1 ~> J kg-1] More...

real	latent_heat_vapor
	latent heat of vaporization [J kg-1] More...

real	tau_x0
	Constant zonal wind stress used in the WIND_CONFIG="const" forcing. More...

real	tau_y0
	Constant meridional wind stress used in the WIND_CONFIG="const" forcing. More...

real	gust_const
	constant unresolved background gustiness for ustar [R L Z T-1 ~> Pa] More...

logical	read_gust_2d
	if true, use 2-dimensional gustiness supplied from a file More...

real, dimension(:,:), pointer	gust => NULL()
	spatially varying unresolved background gustiness [R L Z T-1 ~> Pa] gust is used when read_gust_2d is true. More...

real, dimension(:,:), pointer	t_restore => NULL()
	temperature to damp (restore) the SST to [degC] More...

real, dimension(:,:), pointer	s_restore => NULL()
	salinity to damp (restore) the SSS [ppt] More...

real, dimension(:,:), pointer	dens_restore => NULL()
	density to damp (restore) surface density [kg m-3] More...

integer	buoy_last_lev_read = -1
	The last time level read from buoyancy input files. More...

real	gyres_taux_const
	A constant wind stress [Pa]. More...

real	gyres_taux_sin_amp
	The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'. More...

real	gyres_taux_cos_amp
	The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'. More...

real	gyres_taux_n_pis
	The number of sine lobes in the basin if if WIND_CONFIG=='gyres'. More...

logical	answers_2018
	If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use a form of the gyre wind stresses that are rotationally invariant and more likely to be the same between compilers. More...

real	t_north
	target temperatures at north used in buoyancy_forcing_linear More...

real	t_south
	target temperatures at south used in buoyancy_forcing_linear More...

real	s_north
	target salinity at north used in buoyancy_forcing_linear More...

real	s_south
	target salinity at south used in buoyancy_forcing_linear More...

logical	first_call_set_forcing = .true.
	True until after the first call to set_forcing. More...

logical	archaic_omip_file = .true.
	If true use the variable names and data fields from a very old version of the OMIP forcing. More...

logical	dataoverrideisinitialized = .false.
	If true, data override has been initialized. More...

real	wind_scale
	value by which wind-stresses are scaled, ND. More...

real	constantheatforcing
	value used for sensible heat flux when buoy_config="const" More...

character(len=8)	wind_stagger
	A character indicating how the wind stress components are staggered in WIND_FILE. Valid values are A or C for now. More...

type(tracer_flow_control_cs), pointer	tracer_flow_csp => NULL()
	A pointer to the structure that is used to orchestrate the calling of tracer packages. More...

type(mom_restart_cs), pointer	restart_csp => NULL()
	A pointer to the restart control structure. More...

type(diag_ctrl), pointer	diag
	structure used to regulate timing of diagnostic output More...

character(len=200)	inputdir
	directory where NetCDF input files are. More...

character(len=200)	wind_config
	indicator for wind forcing type (2gyre, USER, FILE..) More...

character(len=200)	wind_file
	if wind_config is "file", file to use More...

character(len=200)	buoy_config
	indicator for buoyancy forcing type More...

character(len=200)	longwave_file = ''
	The file from which the longwave heat flux is read. More...

character(len=200)	shortwave_file = ''
	The file from which the shortwave heat flux is read. More...

character(len=200)	evaporation_file = ''
	The file from which the evaporation is read. More...

character(len=200)	sensibleheat_file = ''
	The file from which the sensible heat flux is read. More...

character(len=200)	latentheat_file = ''
	The file from which the latent heat flux is read. More...

character(len=200)	rain_file = ''
	The file from which the rainfall is read. More...

character(len=200)	snow_file = ''
	The file from which the snowfall is read. More...

character(len=200)	runoff_file = ''
	The file from which the runoff is read. More...

character(len=200)	longwaveup_file = ''
	The file from which the upward longwave heat flux is read. More...

character(len=200)	shortwaveup_file = ''
	The file from which the upward shorwave heat flux is read. More...

character(len=200)	sstrestore_file = ''
	The file from which to read the sea surface temperature to restore toward. More...

character(len=200)	salinityrestore_file = ''
	The file from which to read the sea surface salinity to restore toward. More...

character(len=80)	stress_x_var = ''
	X-windstress variable name in the input file. More...

character(len=80)	stress_y_var = ''
	Y-windstress variable name in the input file. More...

character(len=80)	ustar_var = ''
	ustar variable name in the input file More...

character(len=80)	lw_var = ''
	lonngwave heat flux variable name in the input file More...

character(len=80)	sw_var = ''
	shortwave heat flux variable name in the input file More...

character(len=80)	latent_var = ''
	latent heat flux variable name in the input file More...

character(len=80)	sens_var = ''
	sensible heat flux variable name in the input file More...

character(len=80)	evap_var = ''
	evaporation variable name in the input file More...

character(len=80)	rain_var = ''
	rainfall variable name in the input file More...

character(len=80)	snow_var = ''
	snowfall variable name in the input file More...

character(len=80)	lrunoff_var = ''
	liquid runoff variable name in the input file More...

character(len=80)	frunoff_var = ''
	frozen runoff variable name in the input file More...

character(len=80)	sst_restore_var = ''
	target sea surface temeperature variable name in the input file More...

character(len=80)	sss_restore_var = ''
	target sea surface salinity variable name in the input file More...

integer	wind_nlev = -1
	The number of time levels in the file of wind stress. More...

integer	sw_nlev = -1
	The number of time levels in the file of shortwave heat flux. More...

integer	lw_nlev = -1
	The number of time levels in the file of longwave heat flux. More...

integer	latent_nlev = -1
	The number of time levels in the file of latent heat flux. More...

integer	sens_nlev = -1
	The number of time levels in the file of sensible heat flux. More...

integer	evap_nlev = -1
	The number of time levels in the file of evaporation. More...

integer	precip_nlev = -1
	The number of time levels in the file of precipitation. More...

integer	runoff_nlev = -1
	The number of time levels in the file of runoff. More...

integer	sst_nlev = -1
	The number of time levels in the file of target SST. More...

integer	sss_nlev = -1
	The number of time levels in the file of target SSS. More...

integer	wind_last_lev = -1
	The last time level read of wind stress. More...

integer	sw_last_lev = -1
	The last time level read of shortwave heat flux. More...

integer	lw_last_lev = -1
	The last time level read of longwave heat flux. More...

integer	latent_last_lev = -1
	The last time level read of latent heat flux. More...

integer	sens_last_lev = -1
	The last time level read of sensible heat flux. More...

integer	evap_last_lev = -1
	The last time level read of evaporation. More...

integer	precip_last_lev = -1
	The last time level read of precipitation. More...

integer	runoff_last_lev = -1
	The last time level read of runoff. More...

integer	sst_last_lev = -1
	The last time level read of target SST. More...

integer	sss_last_lev = -1
	The last time level read of target SSS. More...

type(forcing_diags), public	handles
	A structure with diagnostics handles. More...


type(user_revise_forcing_cs), pointer	urf_cs => NULL()
	Control structures for named forcing packages. More...

type(user_surface_forcing_cs), pointer	user_forcing_csp => NULL()
	Control structures for named forcing packages. More...

type(bfb_surface_forcing_cs), pointer	bfb_forcing_csp => NULL()
	Control structures for named forcing packages. More...

type(dumbbell_surface_forcing_cs), pointer	dumbbell_forcing_csp => NULL()
	Control structures for named forcing packages. More...

type(meso_surface_forcing_cs), pointer	meso_forcing_csp => NULL()
	Control structures for named forcing packages. More...

type(neverland_surface_forcing_cs), pointer	neverland_forcing_csp => NULL()
	Control structures for named forcing packages. More...

type(idealized_hurricane_cs), pointer	idealized_hurricane_csp => NULL()
	Control structures for named forcing packages. More...

type(scm_cvmix_tests_cs), pointer	scm_cvmix_tests_csp => NULL()
	Control structures for named forcing packages. More...

Variables and constants

◆ adiabatic

logical mom_surface_forcing::surface_forcing_cs::adiabatic

if true, no diapycnal mass fluxes or surface buoyancy forcing

Definition at line 75 of file MOM_surface_forcing.F90.

75 logical :: adiabatic !< if true, no diapycnal mass fluxes or surface buoyancy forcing

◆ answers_2018

logical mom_surface_forcing::surface_forcing_cs::answers_2018

If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use a form of the gyre wind stresses that are rotationally invariant and more likely to be the same between compilers.

Definition at line 108 of file MOM_surface_forcing.F90.

108 logical :: answers_2018 !< If true, use the order of arithmetic and expressions that recover

◆ archaic_omip_file

logical mom_surface_forcing::surface_forcing_cs::archaic_omip_file = .true.

If true use the variable names and data fields from a very old version of the OMIP forcing.

Definition at line 119 of file MOM_surface_forcing.F90.

119 logical :: archaic_OMIP_file = .true. !< If true use the variable names and data fields from

◆ bfb_forcing_csp

type(bfb_surface_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::bfb_forcing_csp => NULL()

Control structures for named forcing packages.

Definition at line 202 of file MOM_surface_forcing.F90.

202 type(BFB_surface_forcing_CS), pointer :: BFB_forcing_CSp => null()

◆ buoy_config

character(len=200) mom_surface_forcing::surface_forcing_cs::buoy_config

indicator for buoyancy forcing type

Definition at line 138 of file MOM_surface_forcing.F90.

138 character(len=200) :: buoy_config !< indicator for buoyancy forcing type

◆ buoy_last_lev_read

integer mom_surface_forcing::surface_forcing_cs::buoy_last_lev_read = -1

The last time level read from buoyancy input files.

Definition at line 100 of file MOM_surface_forcing.F90.

100 integer :: buoy_last_lev_read = -1 !< The last time level read from buoyancy input files

◆ constantheatforcing

real mom_surface_forcing::surface_forcing_cs::constantheatforcing

value used for sensible heat flux when buoy_config="const"

Definition at line 124 of file MOM_surface_forcing.F90.

124 real :: constantHeatForcing !< value used for sensible heat flux when buoy_config="const"

◆ dataoverrideisinitialized

logical mom_surface_forcing::surface_forcing_cs::dataoverrideisinitialized = .false.

If true, data override has been initialized.

Definition at line 121 of file MOM_surface_forcing.F90.

121 logical :: dataOverrideIsInitialized = .false. !< If true, data override has been initialized

◆ dens_restore

real, dimension(:,:), pointer mom_surface_forcing::surface_forcing_cs::dens_restore => NULL()

density to damp (restore) surface density [kg m-3]

Definition at line 98 of file MOM_surface_forcing.F90.

98 real, pointer :: Dens_Restore(:,:) => null() !< density to damp (restore) surface density [kg m-3]

◆ diag

type(diag_ctrl), pointer mom_surface_forcing::surface_forcing_cs::diag

structure used to regulate timing of diagnostic output

Definition at line 133 of file MOM_surface_forcing.F90.

133 type(diag_ctrl), pointer :: diag !< structure used to regulate timing of diagnostic output

◆ dumbbell_forcing_csp

type(dumbbell_surface_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::dumbbell_forcing_csp => NULL()

Control structures for named forcing packages.

Definition at line 203 of file MOM_surface_forcing.F90.

203 type(dumbbell_surface_forcing_CS), pointer :: dumbbell_forcing_CSp => null()

◆ evap_last_lev

integer mom_surface_forcing::surface_forcing_cs::evap_last_lev = -1

The last time level read of evaporation.

Definition at line 191 of file MOM_surface_forcing.F90.

191 integer :: evap_last_lev = -1 !< The last time level read of evaporation

◆ evap_nlev

integer mom_surface_forcing::surface_forcing_cs::evap_nlev = -1

The number of time levels in the file of evaporation.

Definition at line 179 of file MOM_surface_forcing.F90.

179 integer :: evap_nlev = -1 !< The number of time levels in the file of evaporation

◆ evap_var

character(len=80) mom_surface_forcing::surface_forcing_cs::evap_var = ''

evaporation variable name in the input file

Definition at line 165 of file MOM_surface_forcing.F90.

165 character(len=80) :: evap_var = '' !< evaporation variable name in the input file

◆ evaporation_file

character(len=200) mom_surface_forcing::surface_forcing_cs::evaporation_file = ''

The file from which the evaporation is read.

Definition at line 142 of file MOM_surface_forcing.F90.

142 character(len=200) :: evaporation_file = '' !< The file from which the evaporation is read

◆ first_call_set_forcing

logical mom_surface_forcing::surface_forcing_cs::first_call_set_forcing = .true.

True until after the first call to set_forcing.

Definition at line 118 of file MOM_surface_forcing.F90.

118 logical :: first_call_set_forcing = .true. !< True until after the first call to set_forcing

◆ flux_const

real mom_surface_forcing::surface_forcing_cs::flux_const

piston velocity for surface restoring [Z T-1 ~> m s-1]

Definition at line 83 of file MOM_surface_forcing.F90.

83 real :: Flux_const !< piston velocity for surface restoring [Z T-1 ~> m s-1]

◆ flux_const_s

real mom_surface_forcing::surface_forcing_cs::flux_const_s

piston velocity for surface salinity restoring [Z T-1 ~> m s-1]

Definition at line 85 of file MOM_surface_forcing.F90.

85 real :: Flux_const_S !< piston velocity for surface salinity restoring [Z T-1 ~> m s-1]

◆ flux_const_t

real mom_surface_forcing::surface_forcing_cs::flux_const_t

piston velocity for surface temperature restoring [m s-1]

Definition at line 84 of file MOM_surface_forcing.F90.

84 real :: Flux_const_T !< piston velocity for surface temperature restoring [m s-1]

◆ frunoff_var

character(len=80) mom_surface_forcing::surface_forcing_cs::frunoff_var = ''

frozen runoff variable name in the input file

Definition at line 169 of file MOM_surface_forcing.F90.

169 character(len=80) :: frunoff_var = '' !< frozen runoff variable name in the input file

◆ g_earth

real mom_surface_forcing::surface_forcing_cs::g_earth

gravitational acceleration [L2 Z-1 T-2 ~> m s-2]

Definition at line 82 of file MOM_surface_forcing.F90.

82 real :: G_Earth !< gravitational acceleration [L2 Z-1 T-2 ~> m s-2]

◆ gust

real, dimension(:,:), pointer mom_surface_forcing::surface_forcing_cs::gust => NULL()

spatially varying unresolved background gustiness [R L Z T-1 ~> Pa] gust is used when read_gust_2d is true.

Definition at line 93 of file MOM_surface_forcing.F90.

93 real, pointer :: gust(:,:) => null() !< spatially varying unresolved background gustiness [R L Z T-1 ~> Pa]

◆ gust_const

real mom_surface_forcing::surface_forcing_cs::gust_const

constant unresolved background gustiness for ustar [R L Z T-1 ~> Pa]

Definition at line 91 of file MOM_surface_forcing.F90.

91 real :: gust_const !< constant unresolved background gustiness for ustar [R L Z T-1 ~> Pa]

◆ gyres_taux_const

real mom_surface_forcing::surface_forcing_cs::gyres_taux_const

A constant wind stress [Pa].

Definition at line 104 of file MOM_surface_forcing.F90.

104 real :: gyres_taux_const !< A constant wind stress [Pa].

◆ gyres_taux_cos_amp

real mom_surface_forcing::surface_forcing_cs::gyres_taux_cos_amp

The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'.

Definition at line 106 of file MOM_surface_forcing.F90.

106 real :: gyres_taux_cos_amp !< The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'.

◆ gyres_taux_n_pis

real mom_surface_forcing::surface_forcing_cs::gyres_taux_n_pis

The number of sine lobes in the basin if if WIND_CONFIG=='gyres'.

Definition at line 107 of file MOM_surface_forcing.F90.

107 real :: gyres_taux_n_pis !< The number of sine lobes in the basin if if WIND_CONFIG=='gyres'

◆ gyres_taux_sin_amp

real mom_surface_forcing::surface_forcing_cs::gyres_taux_sin_amp

The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'.

Definition at line 105 of file MOM_surface_forcing.F90.

105 real :: gyres_taux_sin_amp !< The amplitude of cosine wind stress gyres [Pa], if WIND_CONFIG=='gyres'.

◆ handles

type(forcing_diags), public mom_surface_forcing::surface_forcing_cs::handles

A structure with diagnostics handles.

Definition at line 197 of file MOM_surface_forcing.F90.

197 type(forcing_diags), public :: handles !< A structure with diagnostics handles

◆ idealized_hurricane_csp

type(idealized_hurricane_cs), pointer mom_surface_forcing::surface_forcing_cs::idealized_hurricane_csp => NULL()

Control structures for named forcing packages.

Definition at line 206 of file MOM_surface_forcing.F90.

206 type(idealized_hurricane_CS), pointer :: idealized_hurricane_CSp => null()

◆ inputdir

character(len=200) mom_surface_forcing::surface_forcing_cs::inputdir

directory where NetCDF input files are.

Definition at line 135 of file MOM_surface_forcing.F90.

135 character(len=200) :: inputdir !< directory where NetCDF input files are.

◆ latent_heat_fusion

real mom_surface_forcing::surface_forcing_cs::latent_heat_fusion

latent heat of fusion times scaling factors [J T m-2 R-1 Z-1 s-1 ~> J kg-1]

Definition at line 86 of file MOM_surface_forcing.F90.

86 real :: latent_heat_fusion !< latent heat of fusion times scaling factors [J T m-2 R-1 Z-1 s-1 ~> J kg-1]

◆ latent_heat_vapor

real mom_surface_forcing::surface_forcing_cs::latent_heat_vapor

latent heat of vaporization [J kg-1]

Definition at line 87 of file MOM_surface_forcing.F90.

87 real :: latent_heat_vapor !< latent heat of vaporization [J kg-1]

◆ latent_last_lev

integer mom_surface_forcing::surface_forcing_cs::latent_last_lev = -1

The last time level read of latent heat flux.

Definition at line 189 of file MOM_surface_forcing.F90.

189 integer :: latent_last_lev = -1 !< The last time level read of latent heat flux

◆ latent_nlev

integer mom_surface_forcing::surface_forcing_cs::latent_nlev = -1

The number of time levels in the file of latent heat flux.

Definition at line 177 of file MOM_surface_forcing.F90.

177 integer :: latent_nlev = -1 !< The number of time levels in the file of latent heat flux

◆ latent_var

character(len=80) mom_surface_forcing::surface_forcing_cs::latent_var = ''

latent heat flux variable name in the input file

Definition at line 163 of file MOM_surface_forcing.F90.

163 character(len=80) :: latent_var = '' !< latent heat flux variable name in the input file

◆ latentheat_file

character(len=200) mom_surface_forcing::surface_forcing_cs::latentheat_file = ''

The file from which the latent heat flux is read.

Definition at line 144 of file MOM_surface_forcing.F90.

144 character(len=200) :: latentheat_file = '' !< The file from which the latent heat flux is read

◆ len_lat

real mom_surface_forcing::surface_forcing_cs::len_lat

domain length in latitude

Definition at line 79 of file MOM_surface_forcing.F90.

79 real :: len_lat !< domain length in latitude

◆ longwave_file

character(len=200) mom_surface_forcing::surface_forcing_cs::longwave_file = ''

The file from which the longwave heat flux is read.

Definition at line 140 of file MOM_surface_forcing.F90.

140 character(len=200) :: longwave_file = '' !< The file from which the longwave heat flux is read

◆ longwaveup_file

character(len=200) mom_surface_forcing::surface_forcing_cs::longwaveup_file = ''

The file from which the upward longwave heat flux is read.

Definition at line 150 of file MOM_surface_forcing.F90.

150 character(len=200) :: longwaveup_file = '' !< The file from which the upward longwave heat flux is read

◆ lrunoff_var

character(len=80) mom_surface_forcing::surface_forcing_cs::lrunoff_var = ''

liquid runoff variable name in the input file

Definition at line 168 of file MOM_surface_forcing.F90.

168 character(len=80) :: lrunoff_var = '' !< liquid runoff variable name in the input file

◆ lw_last_lev

integer mom_surface_forcing::surface_forcing_cs::lw_last_lev = -1

The last time level read of longwave heat flux.

Definition at line 188 of file MOM_surface_forcing.F90.

188 integer :: LW_last_lev = -1 !< The last time level read of longwave heat flux

◆ lw_nlev

integer mom_surface_forcing::surface_forcing_cs::lw_nlev = -1

The number of time levels in the file of longwave heat flux.

Definition at line 176 of file MOM_surface_forcing.F90.

176 integer :: LW_nlev = -1 !< The number of time levels in the file of longwave heat flux

◆ lw_var

character(len=80) mom_surface_forcing::surface_forcing_cs::lw_var = ''

lonngwave heat flux variable name in the input file

Definition at line 161 of file MOM_surface_forcing.F90.

161 character(len=80) :: LW_var = '' !< lonngwave heat flux variable name in the input file

◆ meso_forcing_csp

type(meso_surface_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::meso_forcing_csp => NULL()

Control structures for named forcing packages.

Definition at line 204 of file MOM_surface_forcing.F90.

204 type(MESO_surface_forcing_CS), pointer :: MESO_forcing_CSp => null()

◆ neverland_forcing_csp

type(neverland_surface_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::neverland_forcing_csp => NULL()

Control structures for named forcing packages.

Definition at line 205 of file MOM_surface_forcing.F90.

205 type(Neverland_surface_forcing_CS), pointer :: Neverland_forcing_CSp => null()

◆ precip_last_lev

integer mom_surface_forcing::surface_forcing_cs::precip_last_lev = -1

The last time level read of precipitation.

Definition at line 192 of file MOM_surface_forcing.F90.

192 integer :: precip_last_lev = -1 !< The last time level read of precipitation

◆ precip_nlev

integer mom_surface_forcing::surface_forcing_cs::precip_nlev = -1

The number of time levels in the file of precipitation.

Definition at line 180 of file MOM_surface_forcing.F90.

180 integer :: precip_nlev = -1 !< The number of time levels in the file of precipitation

◆ rain_file

character(len=200) mom_surface_forcing::surface_forcing_cs::rain_file = ''

The file from which the rainfall is read.

Definition at line 146 of file MOM_surface_forcing.F90.

146 character(len=200) :: rain_file = '' !< The file from which the rainfall is read

◆ rain_var

character(len=80) mom_surface_forcing::surface_forcing_cs::rain_var = ''

rainfall variable name in the input file

Definition at line 166 of file MOM_surface_forcing.F90.

166 character(len=80) :: rain_var = '' !< rainfall variable name in the input file

◆ read_gust_2d

logical mom_surface_forcing::surface_forcing_cs::read_gust_2d

if true, use 2-dimensional gustiness supplied from a file

Definition at line 92 of file MOM_surface_forcing.F90.

92 logical :: read_gust_2d !< if true, use 2-dimensional gustiness supplied from a file

◆ restart_csp

type(mom_restart_cs), pointer mom_surface_forcing::surface_forcing_cs::restart_csp => NULL()

A pointer to the restart control structure.

Definition at line 131 of file MOM_surface_forcing.F90.

131 type(MOM_restart_CS), pointer :: restart_CSp => null() !< A pointer to the restart control structure

◆ restorebuoy

logical mom_surface_forcing::surface_forcing_cs::restorebuoy

if true, use restoring surface buoyancy forcing

Definition at line 74 of file MOM_surface_forcing.F90.

74 logical :: restorebuoy !< if true, use restoring surface buoyancy forcing

◆ rho0

real mom_surface_forcing::surface_forcing_cs::rho0

Boussinesq reference density [R ~> kg m-3].

Definition at line 81 of file MOM_surface_forcing.F90.

81 real :: Rho0 !< Boussinesq reference density [R ~> kg m-3]

◆ runoff_file

character(len=200) mom_surface_forcing::surface_forcing_cs::runoff_file = ''

The file from which the runoff is read.

Definition at line 148 of file MOM_surface_forcing.F90.

148 character(len=200) :: runoff_file = '' !< The file from which the runoff is read

◆ runoff_last_lev

integer mom_surface_forcing::surface_forcing_cs::runoff_last_lev = -1

The last time level read of runoff.

Definition at line 193 of file MOM_surface_forcing.F90.

193 integer :: runoff_last_lev = -1 !< The last time level read of runoff

◆ runoff_nlev

integer mom_surface_forcing::surface_forcing_cs::runoff_nlev = -1

The number of time levels in the file of runoff.

Definition at line 181 of file MOM_surface_forcing.F90.

181 integer :: runoff_nlev = -1 !< The number of time levels in the file of runoff

◆ s_north

real mom_surface_forcing::surface_forcing_cs::s_north

target salinity at north used in buoyancy_forcing_linear

Definition at line 115 of file MOM_surface_forcing.F90.

115 real :: S_north !< target salinity at north used in buoyancy_forcing_linear

◆ s_restore

real, dimension(:,:), pointer mom_surface_forcing::surface_forcing_cs::s_restore => NULL()

salinity to damp (restore) the SSS [ppt]

Definition at line 97 of file MOM_surface_forcing.F90.

97 real, pointer :: S_Restore(:,:) => null() !< salinity to damp (restore) the SSS [ppt]

◆ s_south

real mom_surface_forcing::surface_forcing_cs::s_south

target salinity at south used in buoyancy_forcing_linear

Definition at line 116 of file MOM_surface_forcing.F90.

116 real :: S_south !< target salinity at south used in buoyancy_forcing_linear

◆ salinityrestore_file

character(len=200) mom_surface_forcing::surface_forcing_cs::salinityrestore_file = ''

The file from which to read the sea surface salinity to restore toward.

Definition at line 155 of file MOM_surface_forcing.F90.

155 character(len=200) :: salinityrestore_file = '' !< The file from which to read the sea surface

◆ scm_cvmix_tests_csp

type(scm_cvmix_tests_cs), pointer mom_surface_forcing::surface_forcing_cs::scm_cvmix_tests_csp => NULL()

Control structures for named forcing packages.

Definition at line 207 of file MOM_surface_forcing.F90.

207 type(SCM_CVmix_tests_CS), pointer :: SCM_CVmix_tests_CSp => null()

◆ sens_last_lev

integer mom_surface_forcing::surface_forcing_cs::sens_last_lev = -1

The last time level read of sensible heat flux.

Definition at line 190 of file MOM_surface_forcing.F90.

190 integer :: sens_last_lev = -1 !< The last time level read of sensible heat flux

◆ sens_nlev

integer mom_surface_forcing::surface_forcing_cs::sens_nlev = -1

The number of time levels in the file of sensible heat flux.

Definition at line 178 of file MOM_surface_forcing.F90.

178 integer :: sens_nlev = -1 !< The number of time levels in the file of sensible heat flux

◆ sens_var

character(len=80) mom_surface_forcing::surface_forcing_cs::sens_var = ''

sensible heat flux variable name in the input file

Definition at line 164 of file MOM_surface_forcing.F90.

164 character(len=80) :: sens_var = '' !< sensible heat flux variable name in the input file

◆ sensibleheat_file

character(len=200) mom_surface_forcing::surface_forcing_cs::sensibleheat_file = ''

The file from which the sensible heat flux is read.

Definition at line 143 of file MOM_surface_forcing.F90.

143 character(len=200) :: sensibleheat_file = '' !< The file from which the sensible heat flux is read

◆ shortwave_file

character(len=200) mom_surface_forcing::surface_forcing_cs::shortwave_file = ''

The file from which the shortwave heat flux is read.

Definition at line 141 of file MOM_surface_forcing.F90.

141 character(len=200) :: shortwave_file = '' !< The file from which the shortwave heat flux is read

◆ shortwaveup_file

character(len=200) mom_surface_forcing::surface_forcing_cs::shortwaveup_file = ''

The file from which the upward shorwave heat flux is read.

Definition at line 151 of file MOM_surface_forcing.F90.

151 character(len=200) :: shortwaveup_file = '' !< The file from which the upward shorwave heat flux is read

◆ snow_file

character(len=200) mom_surface_forcing::surface_forcing_cs::snow_file = ''

The file from which the snowfall is read.

Definition at line 147 of file MOM_surface_forcing.F90.

147 character(len=200) :: snow_file = '' !< The file from which the snowfall is read

◆ snow_var

character(len=80) mom_surface_forcing::surface_forcing_cs::snow_var = ''

snowfall variable name in the input file

Definition at line 167 of file MOM_surface_forcing.F90.

167 character(len=80) :: snow_var = '' !< snowfall variable name in the input file

◆ south_lat

real mom_surface_forcing::surface_forcing_cs::south_lat

southern latitude of the domain

Definition at line 78 of file MOM_surface_forcing.F90.

78 real :: south_lat !< southern latitude of the domain

◆ sss_last_lev

integer mom_surface_forcing::surface_forcing_cs::sss_last_lev = -1

The last time level read of target SSS.

Definition at line 195 of file MOM_surface_forcing.F90.

195 integer :: SSS_last_lev = -1 !< The last time level read of target SSS

◆ sss_nlev

integer mom_surface_forcing::surface_forcing_cs::sss_nlev = -1

The number of time levels in the file of target SSS.

Definition at line 183 of file MOM_surface_forcing.F90.

183 integer :: SSS_nlev = -1 !< The number of time levels in the file of target SSS

◆ sss_restore_var

character(len=80) mom_surface_forcing::surface_forcing_cs::sss_restore_var = ''

target sea surface salinity variable name in the input file

Definition at line 171 of file MOM_surface_forcing.F90.

171 character(len=80) :: SSS_restore_var = '' !< target sea surface salinity variable name in the input file

◆ sst_last_lev

integer mom_surface_forcing::surface_forcing_cs::sst_last_lev = -1

The last time level read of target SST.

Definition at line 194 of file MOM_surface_forcing.F90.

194 integer :: SST_last_lev = -1 !< The last time level read of target SST

◆ sst_nlev

integer mom_surface_forcing::surface_forcing_cs::sst_nlev = -1

The number of time levels in the file of target SST.

Definition at line 182 of file MOM_surface_forcing.F90.

182 integer :: SST_nlev = -1 !< The number of time levels in the file of target SST

◆ sst_restore_var

character(len=80) mom_surface_forcing::surface_forcing_cs::sst_restore_var = ''

target sea surface temeperature variable name in the input file

Definition at line 170 of file MOM_surface_forcing.F90.

170 character(len=80) :: SST_restore_var = '' !< target sea surface temeperature variable name in the input file

◆ sstrestore_file

character(len=200) mom_surface_forcing::surface_forcing_cs::sstrestore_file = ''

The file from which to read the sea surface temperature to restore toward.

Definition at line 153 of file MOM_surface_forcing.F90.

153 character(len=200) :: SSTrestore_file = '' !< The file from which to read the sea surface

◆ stress_x_var

character(len=80) mom_surface_forcing::surface_forcing_cs::stress_x_var = ''

X-windstress variable name in the input file.

Definition at line 158 of file MOM_surface_forcing.F90.

158 character(len=80) :: stress_x_var = '' !< X-windstress variable name in the input file

◆ stress_y_var

character(len=80) mom_surface_forcing::surface_forcing_cs::stress_y_var = ''

Y-windstress variable name in the input file.

Definition at line 159 of file MOM_surface_forcing.F90.

159 character(len=80) :: stress_y_var = '' !< Y-windstress variable name in the input file

◆ sw_last_lev

integer mom_surface_forcing::surface_forcing_cs::sw_last_lev = -1

The last time level read of shortwave heat flux.

Definition at line 187 of file MOM_surface_forcing.F90.

187 integer :: SW_last_lev = -1 !< The last time level read of shortwave heat flux

◆ sw_nlev

integer mom_surface_forcing::surface_forcing_cs::sw_nlev = -1

The number of time levels in the file of shortwave heat flux.

Definition at line 175 of file MOM_surface_forcing.F90.

175 integer :: SW_nlev = -1 !< The number of time levels in the file of shortwave heat flux

◆ sw_var

character(len=80) mom_surface_forcing::surface_forcing_cs::sw_var = ''

shortwave heat flux variable name in the input file

Definition at line 162 of file MOM_surface_forcing.F90.

162 character(len=80) :: SW_var = '' !< shortwave heat flux variable name in the input file

◆ t_north

real mom_surface_forcing::surface_forcing_cs::t_north

target temperatures at north used in buoyancy_forcing_linear

Definition at line 113 of file MOM_surface_forcing.F90.

113 real :: T_north !< target temperatures at north used in buoyancy_forcing_linear

◆ t_restore

real, dimension(:,:), pointer mom_surface_forcing::surface_forcing_cs::t_restore => NULL()

temperature to damp (restore) the SST to [degC]

Definition at line 96 of file MOM_surface_forcing.F90.

96 real, pointer :: T_Restore(:,:) => null() !< temperature to damp (restore) the SST to [degC]

◆ t_south

real mom_surface_forcing::surface_forcing_cs::t_south

target temperatures at south used in buoyancy_forcing_linear

Definition at line 114 of file MOM_surface_forcing.F90.

114 real :: T_south !< target temperatures at south used in buoyancy_forcing_linear

◆ tau_x0

real mom_surface_forcing::surface_forcing_cs::tau_x0

Constant zonal wind stress used in the WIND_CONFIG="const" forcing.

Definition at line 88 of file MOM_surface_forcing.F90.

88 real :: tau_x0 !< Constant zonal wind stress used in the WIND_CONFIG="const" forcing

◆ tau_y0

real mom_surface_forcing::surface_forcing_cs::tau_y0

Constant meridional wind stress used in the WIND_CONFIG="const" forcing.

Definition at line 89 of file MOM_surface_forcing.F90.

89 real :: tau_y0 !< Constant meridional wind stress used in the WIND_CONFIG="const" forcing

◆ tracer_flow_csp

type(tracer_flow_control_cs), pointer mom_surface_forcing::surface_forcing_cs::tracer_flow_csp => NULL()

A pointer to the structure that is used to orchestrate the calling of tracer packages.

Definition at line 128 of file MOM_surface_forcing.F90.

128 type(tracer_flow_control_CS), pointer :: tracer_flow_CSp => null() !< A pointer to the structure

◆ urf_cs

type(user_revise_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::urf_cs => NULL()

Control structures for named forcing packages.

Definition at line 200 of file MOM_surface_forcing.F90.

200 type(user_revise_forcing_CS), pointer :: urf_CS => null()

◆ use_temperature

logical mom_surface_forcing::surface_forcing_cs::use_temperature

if true, temp & salinity used as state variables

Definition at line 73 of file MOM_surface_forcing.F90.

73 logical :: use_temperature !< if true, temp & salinity used as state variables

◆ user_forcing_csp

type(user_surface_forcing_cs), pointer mom_surface_forcing::surface_forcing_cs::user_forcing_csp => NULL()

Control structures for named forcing packages.

Definition at line 201 of file MOM_surface_forcing.F90.

201 type(user_surface_forcing_CS), pointer :: user_forcing_CSp => null()

◆ ustar_var

character(len=80) mom_surface_forcing::surface_forcing_cs::ustar_var = ''

ustar variable name in the input file

Definition at line 160 of file MOM_surface_forcing.F90.

160 character(len=80) :: ustar_var = '' !< ustar variable name in the input file

◆ variable_buoyforce

logical mom_surface_forcing::surface_forcing_cs::variable_buoyforce

if true, buoyancy forcing varies with time.

Definition at line 77 of file MOM_surface_forcing.F90.

77 logical :: variable_buoyforce !< if true, buoyancy forcing varies with time.

◆ variable_winds

logical mom_surface_forcing::surface_forcing_cs::variable_winds

if true, wind stresses vary with time

Definition at line 76 of file MOM_surface_forcing.F90.

76 logical :: variable_winds !< if true, wind stresses vary with time

◆ wind_config

character(len=200) mom_surface_forcing::surface_forcing_cs::wind_config

indicator for wind forcing type (2gyre, USER, FILE..)

Definition at line 136 of file MOM_surface_forcing.F90.

136 character(len=200) :: wind_config !< indicator for wind forcing type (2gyre, USER, FILE..)

◆ wind_file

character(len=200) mom_surface_forcing::surface_forcing_cs::wind_file

if wind_config is "file", file to use

Definition at line 137 of file MOM_surface_forcing.F90.

137 character(len=200) :: wind_file !< if wind_config is "file", file to use

◆ wind_last_lev

integer mom_surface_forcing::surface_forcing_cs::wind_last_lev = -1

The last time level read of wind stress.

Definition at line 186 of file MOM_surface_forcing.F90.

186 integer :: wind_last_lev = -1 !< The last time level read of wind stress

◆ wind_nlev

integer mom_surface_forcing::surface_forcing_cs::wind_nlev = -1

The number of time levels in the file of wind stress.

Definition at line 174 of file MOM_surface_forcing.F90.

174 integer :: wind_nlev = -1 !< The number of time levels in the file of wind stress

◆ wind_scale

real mom_surface_forcing::surface_forcing_cs::wind_scale

value by which wind-stresses are scaled, ND.

Definition at line 123 of file MOM_surface_forcing.F90.

123 real :: wind_scale !< value by which wind-stresses are scaled, ND.

◆ wind_stagger

character(len=8) mom_surface_forcing::surface_forcing_cs::wind_stagger

A character indicating how the wind stress components are staggered in WIND_FILE. Valid values are A or C for now.

Definition at line 126 of file MOM_surface_forcing.F90.

126 character(len=8) :: wind_stagger !< A character indicating how the wind stress components

The documentation for this type was generated from the following file:

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/config_src/solo_driver/MOM_surface_forcing.F90

Detailed Description

Public variables and constants

Variables and constants

◆ adiabatic

◆ answers_2018

◆ archaic_omip_file

◆ bfb_forcing_csp

◆ buoy_config

◆ buoy_last_lev_read

◆ constantheatforcing

◆ dataoverrideisinitialized

◆ dens_restore

◆ diag

◆ dumbbell_forcing_csp

◆ evap_last_lev

◆ evap_nlev

◆ evap_var

◆ evaporation_file

◆ first_call_set_forcing

◆ flux_const

◆ flux_const_s

◆ flux_const_t

◆ frunoff_var

◆ g_earth

◆ gust

◆ gust_const

◆ gyres_taux_const

◆ gyres_taux_cos_amp

◆ gyres_taux_n_pis

◆ gyres_taux_sin_amp

◆ handles

◆ idealized_hurricane_csp

◆ inputdir

◆ latent_heat_fusion

◆ latent_heat_vapor

◆ latent_last_lev

◆ latent_nlev

◆ latent_var

◆ latentheat_file

◆ len_lat

◆ longwave_file

◆ longwaveup_file

◆ lrunoff_var

◆ lw_last_lev

◆ lw_nlev

◆ lw_var

◆ meso_forcing_csp

◆ neverland_forcing_csp

◆ precip_last_lev

◆ precip_nlev

◆ rain_file

◆ rain_var

◆ read_gust_2d

◆ restart_csp

◆ restorebuoy

◆ rho0

◆ runoff_file

◆ runoff_last_lev

◆ runoff_nlev

◆ s_north

◆ s_restore

◆ s_south

◆ salinityrestore_file

◆ scm_cvmix_tests_csp

◆ sens_last_lev

◆ sens_nlev

◆ sens_var

◆ sensibleheat_file

◆ shortwave_file

◆ shortwaveup_file

◆ snow_file

◆ snow_var

◆ south_lat

◆ sss_last_lev

◆ sss_nlev

◆ sss_restore_var

◆ sst_last_lev

◆ sst_nlev

◆ sst_restore_var

◆ sstrestore_file