Model variables¶
The variable meta-data (i.e., all instances of Variable
)
are available in a dictionary as the attribute VerosState.var_meta
. The actual
data arrays are attributes of VerosState.variables
:
state.variables.psi # data array for variable psi
state.var_meta["psi"] # metadata for variable psi
Variable class¶
Available variables¶
There are two kinds of variables in Veros. Main variables are always present in a
simulation, while conditional variables are only available if their respective
condition is True
at the time of variable allocation.
- Attributes:
- : Time-dependent: Conditional: Written to restart files by default
- VerosVariables.tau¶
- Units
- Dimensions
scalar
- Type
int32
- Attributes
Index of current time step
- VerosVariables.taup1¶
- Units
- Dimensions
scalar
- Type
int32
- Attributes
Index of next time step
- VerosVariables.taum1¶
- Units
- Dimensions
scalar
- Type
int32
- Attributes
Index of last time step
- VerosVariables.itt¶
- Units
- Dimensions
scalar
- Type
int32
- Attributes
Current iteration
- VerosVariables.dyt¶
- Units
m
- Dimensions
(yt)
- Type
- Attributes
Meridional (y) spacing of T-grid point
- VerosVariables.dyu¶
- Units
m
- Dimensions
(yu)
- Type
- Attributes
Meridional (y) spacing of U-grid point
- VerosVariables.cost¶
- Units
1
- Dimensions
(yt)
- Type
- Attributes
Metric factor for spherical coordinates
- VerosVariables.cosu¶
- Units
1
- Dimensions
(yu)
- Type
- Attributes
Metric factor for spherical coordinates
- VerosVariables.tantr¶
- Units
1
- Dimensions
(yt)
- Type
- Attributes
Metric factor for spherical coordinates
- VerosVariables.coriolis_t¶
- Units
1/s
- Dimensions
(xt, yt)
- Type
- Attributes
Coriolis frequency at T grid point
- VerosVariables.kbot¶
- Units
- Dimensions
(xt, yt)
- Type
int32
- Attributes
Index of the deepest grid cell (counting from 1, 0 means all land)
- VerosVariables.ht¶
- Units
m
- Dimensions
(xt, yt)
- Type
- Attributes
Total depth of the water column
- VerosVariables.hu¶
- Units
m
- Dimensions
(xu, yt)
- Type
- Attributes
Total depth of the water column
- VerosVariables.hv¶
- Units
m
- Dimensions
(xt, yu)
- Type
- Attributes
Total depth of the water column
- VerosVariables.hur¶
- Units
m
- Dimensions
(xu, yt)
- Type
- Attributes
Total depth of the water column (masked)
- VerosVariables.hvr¶
- Units
m
- Dimensions
(xt, yu)
- Type
- Attributes
Total depth of the water column (masked)
- VerosVariables.beta¶
- Units
1/(ms)
- Dimensions
(xt, yt)
- Type
- Attributes
Change of Coriolis frequency with latitude
- VerosVariables.maskT¶
- Units
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Mask in physical space for tracer points
- VerosVariables.maskU¶
- Units
- Dimensions
(xu, yt, zt)
- Type
- Attributes
Mask in physical space for U points
- VerosVariables.maskV¶
- Units
- Dimensions
(xt, yu, zt)
- Type
- Attributes
Mask in physical space for V points
- VerosVariables.maskW¶
- Units
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Mask in physical space for W points
- VerosVariables.maskZ¶
- Units
- Dimensions
(xu, yu, zt)
- Type
- Attributes
Mask in physical space for Zeta points
- VerosVariables.rho¶
- Units
kg/m^3
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
In-situ density anomaly, relative to the surface mean value of 1024 kg/m^3
- VerosVariables.prho¶
- Units
kg/m^3
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Potential density anomaly, relative to the surface mean value of 1024 kg/m^3 (identical to in-situ density anomaly for equation of state type 1, 2, and 4)
- VerosVariables.int_drhodT¶
- Units
kg / (m^2 deg C)
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Partial derivative of dynamic enthalpy by temperature
- VerosVariables.int_drhodS¶
- Units
kg / (m^2 g / kg)
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Partial derivative of dynamic enthalpy by salinity
- VerosVariables.Nsqr¶
- Units
1/s^2
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Attributes
Square of stability frequency
- VerosVariables.Hd¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Dynamic enthalpy
- VerosVariables.dHd¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Change of dynamic enthalpy due to advection
- VerosVariables.temp¶
- Units
deg C
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Conservative temperature
- VerosVariables.dtemp¶
- Units
deg C/s
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Conservative temperature tendency
- VerosVariables.dsalt¶
- Units
g/(kg s)
- Dimensions
(xt, yt, zt, timesteps)
- Type
- Attributes
Salinity tendency
- VerosVariables.dtemp_vmix¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of temperature due to vertical mixing
- VerosVariables.dtemp_hmix¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of temperature due to horizontal mixing
- VerosVariables.dsalt_vmix¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of salinity due to vertical mixing
- VerosVariables.dsalt_hmix¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of salinity due to horizontal mixing
- VerosVariables.dtemp_iso¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of temperature due to isopycnal mixing plus skew mixing
- VerosVariables.dsalt_iso¶
- Units
deg C/s
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Change of salinity due to isopycnal mixing plus skew mixing
- VerosVariables.forc_temp_surface¶
- Units
m deg C/s
- Dimensions
(xt, yt)
- Type
- Attributes
Surface temperature flux
- VerosVariables.forc_salt_surface¶
- Units
m g/s kg
- Dimensions
(xt, yt)
- Type
- Attributes
Surface salinity flux
- VerosVariables.v¶
- Units
m/s
- Dimensions
(xt, yu, zt, timesteps)
- Type
- Attributes
Meridional velocity
- VerosVariables.w¶
- Units
m/s
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Attributes
Vertical velocity
- VerosVariables.du¶
- Units
m/s
- Dimensions
(xu, yt, zt, timesteps)
- Type
- Attributes
Zonal velocity tendency
- VerosVariables.dv¶
- Units
m/s
- Dimensions
(xt, yu, zt, timesteps)
- Type
- Attributes
Meridional velocity tendency
- VerosVariables.du_cor¶
- Units
m/s^2
- Dimensions
(xu, yt, zt)
- Type
- Attributes
Change of u due to Coriolis force
- VerosVariables.dv_cor¶
- Units
m/s^2
- Dimensions
(xt, yu, zt)
- Type
- Attributes
Change of v due to Coriolis force
- VerosVariables.du_mix¶
- Units
m/s^2
- Dimensions
(xu, yt, zt)
- Type
- Attributes
Change of u due to implicit vertical mixing
- VerosVariables.dv_mix¶
- Units
m/s^2
- Dimensions
(xt, yu, zt)
- Type
- Attributes
Change of v due to implicit vertical mixing
- VerosVariables.du_adv¶
- Units
m/s^2
- Dimensions
(xu, yt, zt)
- Type
- Attributes
Change of u due to advection
- VerosVariables.dv_adv¶
- Units
m/s^2
- Dimensions
(xt, yu, zt)
- Type
- Attributes
Change of v due to advection
- VerosVariables.p_hydro¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zt)
- Type
- Attributes
Hydrostatic pressure
- VerosVariables.kappaH¶
- Units
m^2/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Vertical diffusivity
- VerosVariables.surface_taux¶
- Units
N/m^2
- Dimensions
(xu, yt)
- Type
- Attributes
Zonal surface wind stress
- VerosVariables.surface_tauy¶
- Units
N/m^2
- Dimensions
(xt, yu)
- Type
- Attributes
Meridional surface wind stress
- VerosVariables.forc_rho_surface¶
- Units
kg / (m^2 s)
- Dimensions
(xt, yt)
- Type
- Attributes
Surface potential density flux
- VerosVariables.ssh¶
- Units
m
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: not settings.enable_streamfunction
- Attributes
Sea surface height
- VerosVariables.psi¶
- Units
lambda settings: "m^3/s" if settings.enable_streamfunction else "m^2/s^2"
- Dimensions
lambda settings: ZETA_HOR + TIMESTEPS if settings.enable_streamfunction else T_HOR + TIMESTEPS
- Type
- Attributes
lambda settings: "Barotropic streamfunction" if settings.enable_streamfunction else "Surface pressure"
- VerosVariables.dpsi¶
- Units
m^3/s^2
- Dimensions
(xu, yu, timesteps)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Streamfunction tendency
- VerosVariables.land_map¶
- Units
- Dimensions
(xt, yt)
- Type
int32
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Land map
- VerosVariables.isle¶
- Units
- Dimensions
(isle)
- Type
int32
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Island number
- VerosVariables.psin¶
- Units
m^3/s
- Dimensions
(xu, yu, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Boundary streamfunction
- VerosVariables.dpsin¶
- Units
m^3/s^2
- Dimensions
(isle, timesteps)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Boundary streamfunction factor
- VerosVariables.line_psin¶
- Units
m^4/s^2
- Dimensions
(isle, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Boundary line integrals
- VerosVariables.isle_boundary_mask¶
- Units
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Island boundary mask
- VerosVariables.line_dir_south_mask¶
- Units
- Dimensions
(xt, yt, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Line integral mask
- VerosVariables.line_dir_north_mask¶
- Units
- Dimensions
(xt, yt, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Line integral mask
- VerosVariables.line_dir_east_mask¶
- Units
- Dimensions
(xt, yt, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Line integral mask
- VerosVariables.line_dir_west_mask¶
- Units
- Dimensions
(xt, yt, isle)
- Type
- Condition
lambda settings: settings.enable_streamfunction
- Attributes
Line integral mask
- VerosVariables.K_gm¶
- Units
m^2/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
GM diffusivity, either constant or from EKE model
- VerosVariables.K_iso¶
- Units
m^2/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Along-isopycnal diffusivity
- VerosVariables.K_diss_v¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Kinetic energy dissipation by vertical, rayleigh and bottom friction
- VerosVariables.K_diss_bot¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Mean energy dissipation by bottom and rayleigh friction
- VerosVariables.K_diss_h¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Kinetic energy dissipation by horizontal friction
- VerosVariables.K_diss_gm¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Mean energy dissipation by GM (TRM formalism only)
- VerosVariables.P_diss_v¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by vertical diffusion
- VerosVariables.P_diss_nonlin¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by nonlinear equation of state
- VerosVariables.P_diss_iso¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by isopycnal mixing
- VerosVariables.P_diss_skew¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by GM (w/o TRM)
- VerosVariables.P_diss_hmix¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by horizontal mixing
- VerosVariables.P_diss_adv¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by advection
- VerosVariables.P_diss_sources¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Potential energy dissipation by external sources (e.g. restoring zones)
- VerosVariables.u_wgrid¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Zonal velocity interpolated to W grid points
- VerosVariables.v_wgrid¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Meridional velocity interpolated to W grid points
- VerosVariables.w_wgrid¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Attributes
Vertical velocity interpolated to W grid points
- VerosVariables.xt¶
- Units
lambda settings: "degrees_east" if settings.coord_degree else "km"
- Dimensions
(xt)
- Type
- Attributes
Zonal (x) coordinate of T-grid point
- VerosVariables.xu¶
- Units
lambda settings: "degrees_east" if settings.coord_degree else "km"
- Dimensions
(xu)
- Type
- Attributes
Zonal (x) coordinate of U-grid point
- VerosVariables.yt¶
- Units
lambda settings: "degrees_north" if settings.coord_degree else "km"
- Dimensions
(yt)
- Type
- Attributes
Meridional (y) coordinate of T-grid point
- VerosVariables.yu¶
- Units
lambda settings: "degrees_north" if settings.coord_degree else "km"
- Dimensions
(yu)
- Type
- Attributes
Meridional (y) coordinate of U-grid point
- VerosVariables.temp_source¶
- Units
K/s
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_tempsalt_sources
- Attributes
Non-conservative source of temperature
- VerosVariables.salt_source¶
- Units
g/(kg s)
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_tempsalt_sources
- Attributes
Non-conservative source of salt
- VerosVariables.u_source¶
- Units
m/s^2
- Dimensions
(xu, yt, zt)
- Type
- Condition
lambda settings: settings.enable_momentum_sources
- Attributes
Non-conservative source of zonal velocity
- VerosVariables.v_source¶
- Units
m/s^2
- Dimensions
(xt, yu, zt)
- Type
- Condition
lambda settings: settings.enable_momentum_sources
- Attributes
Non-conservative source of meridional velocity
- VerosVariables.K_11¶
- Units
m^2/s
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
Isopycnal mixing tensor component
- VerosVariables.K_22¶
- Units
m^2/s
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
Isopycnal mixing tensor component
- VerosVariables.K_33¶
- Units
m^2/s
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
Isopycnal mixing tensor component
- VerosVariables.Ai_ez¶
- Units
Vertical isopycnal diffusion coefficient on eastern face of T cell
- Dimensions
(xt, yt, zt, tensor1, tensor2)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
1
- VerosVariables.Ai_nz¶
- Units
Vertical isopycnal diffusion coefficient on northern face of T cell
- Dimensions
(xt, yt, zt, tensor1, tensor2)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
1
- VerosVariables.Ai_bx¶
- Units
Zonal isopycnal diffusion coefficient on bottom face of T cell
- Dimensions
(xt, yt, zt, tensor1, tensor2)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
1
- VerosVariables.Ai_by¶
- Units
Meridional isopycnal diffusion coefficient on bottom face of T cell
- Dimensions
(xt, yt, zt, tensor1, tensor2)
- Type
- Condition
lambda settings: settings.enable_neutral_diffusion
- Attributes
1
- VerosVariables.B1_gm¶
- Units
m^2/s
- Dimensions
(xt, yu, zt)
- Type
- Condition
lambda settings: settings.enable_skew_diffusion
- Attributes
Zonal component of GM streamfunction
- VerosVariables.B2_gm¶
- Units
m^2/s
- Dimensions
(xu, yt, zt)
- Type
- Condition
lambda settings: settings.enable_skew_diffusion
- Attributes
Meridional component of GM streamfunction
- VerosVariables.r_bot_var_u¶
- Units
1/s
- Dimensions
(xu, yt)
- Type
- Condition
lambda settings: settings.enable_bottom_friction_var
- Attributes
Zonal bottom friction coefficient
- VerosVariables.r_bot_var_v¶
- Units
1/s
- Dimensions
(xt, yu)
- Type
- Condition
lambda settings: settings.enable_bottom_friction_var
- Attributes
Meridional bottom friction coefficient
- VerosVariables.kappa_gm¶
- Units
m^2/s
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_TEM_friction
- Attributes
Vertical diffusivity
- VerosVariables.tke¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Turbulent kinetic energy
- VerosVariables.sqrttke¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Square-root of TKE
- VerosVariables.dtke¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Turbulent kinetic energy tendency
- VerosVariables.Prandtlnumber¶
- Units
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Prandtl number
- VerosVariables.mxl¶
- Units
m
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Mixing length
- VerosVariables.forc_tke_surface¶
- Units
m^3/s^3
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
TKE surface flux
- VerosVariables.tke_diss¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
TKE dissipation
- VerosVariables.tke_surf_corr¶
- Units
m^3/s^3
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: settings.enable_tke
- Attributes
Correction of TKE surface flux
- VerosVariables.eke¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
meso-scale energy
- VerosVariables.deke¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
meso-scale energy tendency
- VerosVariables.sqrteke¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
square-root of eke
- VerosVariables.L_rossby¶
- Units
m
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
Rossby radius
- VerosVariables.L_rhines¶
- Units
m
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
Rhines scale
- VerosVariables.eke_len¶
- Units
m
- Dimensions
(xt, yt, zt)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
Eddy length scale
- VerosVariables.eke_diss_iw¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
Dissipation of EKE to internal waves
- VerosVariables.eke_diss_tke¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_eke
- Attributes
Dissipation of EKE to TKE
- VerosVariables.E_iw¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Internal wave energy
- VerosVariables.dE_iw¶
- Units
m^2/s^2
- Dimensions
(xt, yt, zw, timesteps)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Internal wave energy tendency
- VerosVariables.c0¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Vertical internal wave group velocity
- VerosVariables.v0¶
- Units
m/s
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Horizontal internal wave group velocity
- VerosVariables.alpha_c¶
- Units
?
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
?
- VerosVariables.iw_diss¶
- Units
m^2/s^3
- Dimensions
(xt, yt, zw)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Internal wave dissipation
- VerosVariables.forc_iw_surface¶
- Units
m^3/s^3
- Dimensions
(xt, yt)
- Type
- Condition
lambda settings: settings.enable_idemix
- Attributes
Internal wave surface forcing