!

! ROMS/TOMS IO NetCDF variables.

!

!========================================================= Hernan G. Arango ===

! Copyright (c) 2002-2020 The ROMS/TOMS Group !

! Licensed under a MIT/X style license !

! See License_ROMS.txt !

!==============================================================================

!

! Note! This file contains some Tclm entries for historic reasons.

! These will no longer be read, but contain information on the

! climatology nudging used in CoSine. Many fields are using the same

! values since there is so little data.

! For instance, idTclm(iS1_N) points to NH4.

!

!==============================================================================

!

! This file contains all ROMS/TOMS Input/Output variables information. It !

! is used to manage NetCDF files. The following information is needed for !

! any IO variable: !

! !

! Vinfo(1) Field variable name. !

! Vinfo(2) Long-name attribute. !

! Vinfo(3) Units attribute. !

! Vinfo(4) Field type attribute. !

! Vinfo(5) Associated time variable name. !

! Vinfo(6) Index variable name used in information arrays. !

! Vinfo(7) Staggered C-grid variable type: !

! 'nulvar' => non-grided variable. !

! 'p2dvar' => 2D PHI-variable. !

! 'r2dvar' => 2D RHO-variable. !

! 'u2dvar' => 2D U-variable. !

! 'v2dvar' => 2D V-variable. !

! 'p3dvar' => 3D PHI-variable. !

! 'r3dvar' => 3D RHO-variable. !

! 'u3dvar' => 3D U-variable. !

! 'v3dvar' => 3D V-variable. !

! 'w3dvar' => 3D W-variable. !

! 'b3dvar' => 3D BED-sediment. !

! 'l3dvar' => 3D spectral light variable. !

! 'l4dvar' => 4D spectral light variable. !

! scale Scale to convert input data to model units. !

! !

! Enclose Vinfo variables with single quotes so this file can be read with !

! a free format statement. The Vinfo(6) variable must be unique and case !

! sensitive. It is checked in "mod_ncparm" to set the appropiate ID index !

! for the information arrays. !

! !

! Notice that there is commented information for each variable including !

! input/output type and internal model units in brackets. There are some !

! variables that are special and require a particular units for Input and !

! and output. !

! !

!==============================================================================

!

! The value in Vinfo(5) here is used to name the unlimited dimension in all

! output NetCDF files. By default it is set to 'time'. Alternatively, you

! can use 'ocean_time' as dimension name so both variable and dimension

! names are the same. This facilitates processing in some NetCDF packages.

! Notice that we use the prefix 'ocean' in the variable name to differentiate

! between oceanic and atmospheric time clocks in fully coupled applications.

!

! Notice that salinity does not have physical units. A commented [PSU] can

! be found below to indicate that the practical salinity scale was used to

! determine conductivity. See,

!

! http://marine.rutgers.edu/po/users/forum/viewtopic.php?t=294

!

!------------------------------------------------------------------------------

! Git Repository

!------------------------------------------------------------------------------

!

'$URL$'

!

!------------------------------------------------------------------------------

! Model state variables.

!------------------------------------------------------------------------------

!

'ocean_time' ! Input/Output

'time since initialization'

'second' ! [s]

'time, scalar, series'

'ocean_time'

'idtime'

'nulvar'

1.0d0

'bath' ! Input/Output

'bathymetry'

'meter' ! [m]

'bathymetry, scalar, series'

'ocean_time'

'idbath'

'r2dvar'

1.0d0

'zeta' ! Input/Output

'free-surface'

'meter' ! [m]

'free-surface, scalar, series'

'ocean_time'

'idFsur'

'r2dvar'

1.0d0

'ubar' ! Input/Ouput

'vertically integrated u-momentum component'

'meter second-1' ! [m/s]

'ubar-velocity, scalar, series'

'ocean_time'

'idUbar'

'u2dvar'

1.0d0

'vbar' ! Input/Output

'vertically integrated v-momentum component'

'meter second-1' ! [m/s]

'vbar-velocity, scalar, series'

'ocean_time'

'idVbar'

'v2dvar'

1.0d0

'ubar_eastward' ! Ouput

'eastward vertically integrated momentum component at RHO-points'

'meter second-1' ! [m/s]

'ubar_eastward, scalar, series'

'ocean_time'

'idu2dE'

'r2dvar'

1.0d0

'vbar_northward' ! Output

'northward vertically integrated momentum component at RHO-points'

'meter second-1' ! [m/s]

'vbar_northward, scalar, series'

'ocean_time'

'idv2dN'

'r2dvar'

1.0d0

'u' ! Input/Output

'u-momentum component'

'meter second-1' ! [m/s]

'u-velocity, scalar, series'

'ocean_time'

'idUvel'

'u3dvar'

1.0d0

'v' ! Input/Output

'v-momentum component'

'meter second-1' ! [m/s]

'v-velocity, scalar, series'

'ocean_time'

'idVvel'

'v3dvar'

1.0d0

'u_eastward' ! Output

'eastward momentum component at RHO-points'

'meter second-1' ! [m/s]

'u_eastward, scalar, series'

'ocean_time'

'idu3dE'

'r3dvar'

1.0d0

'v_northward' ! Output

'northward momentum component at RHO-points'

'meter second-1' ! [m/s]

'v_northward, scalar, series'

'ocean_time'

'idv3dN'

'r3dvar'

1.0d0

'u_sur' ! Output

'model surface u-momentum component'

'meter second-1' ! [m/s]

'u_sur, scalar, series'

'ocean_time'

'idUsur'

'u2dvar'

1.0d0

'v_sur' ! Output

'model surface v-momentum component'

'meter second-1' ! [m/s]

'v_sur, scalar, series'

'ocean_time'

'idVsur'

'v2dvar'

1.0d0

'u_sur_eastward' ! Output

'model surface eastward momentum component at RHO-points'

'meter second-1' ! [m/s]

'u_sur_eastward, scalar, series'

'ocean_time'

'idUsuE'

'r2dvar'

1.0d0

'v_sur_northward' ! Output

'model surface northward momentum component at RHO-points'

'meter second-1' ! [m/s]

'v_sur_northward, scalar, series'

'ocean_time'

'idVsuN'

'r2dvar'

1.0d0

'w' ! Output

'vertical momentum component'

'meter second-1' ! [m/s]

'w-velocity, scalar, series'

'ocean_time'

'idWvel'

'w3dvar'

1.0d0

'omega' ! Output

'S-coordinate vertical momentum component'

'meter3 second-1' ! [m3/s]

'omega, scalar, series'

'ocean_time'

'idOvel'

'w3dvar'

1.0d0

'omega' ! Output

'S-coordinate vertical momentum component'

'meter3 second-1' ! [m3/s]

'omega, scalar, series'

'ocean_time'

'idOclm'

'w3dvar'

1.0d0

'rho' ! Output

'density anomaly'

'kilogram meter-3' ! [kg/m3]

'density, scalar, series'

'ocean_time'

'idDano'

'r3dvar'

1.0d0

'temp' ! Input/Output

'potential temperature'

'Celsius' ! [Celsius]

'temperature, scalar, series'

'ocean_time'

'idTvar(itemp)'

'r3dvar'

1.0d0

'salt' ! Input/Output

'salinity'

'nondimensional' ! [PSU]

'salinity, scalar, series'

'ocean_time'

'idTvar(isalt)'

'r3dvar'

1.0d0

'temp_sur' ! Output

'model surface potential temperature'

'Celsius' ! [Celsius]

'temp_sur, scalar, series'

'ocean_time'

'idsurT(itemp)'

'r2dvar'

1.0d0

'salt_sur' ! Output

'model surface salinity'

'nondimensional' ! [PSU]

'salinity, scalar, series'

'ocean_time'

'idsurT(isalt)'

'r2dvar'

1.0d0

'z_rho' ! Output

'depth of RHO-points'

'meter' ! [meter]

'z_rho, scalar, series'

'ocean_time'

'idpthR'

'r3dvar'

1.0d0

'z_u' ! Output

'depth of U-points'

'meter' ! [meter]

'z_u, scalar, series'

'ocean_time'

'idpthU'

'u3dvar'

1.0d0

'z_v' ! Output

'depth of V-points'

'meter' ! [meter]

'z_v, scalar, series'

'ocean_time'

'idpthV'

'v3dvar'

1.0d0

'z_w' ! Output

'depth of W-points'

'meter' ! [meter]

'z_w, scalar, series'

'ocean_time'

'idpthW'

'w3dvar'

1.0d0

'EBF' ! Output

'Ekman buoyancy flux at PSI-points'

'Watt kg-1' ! [m/s]

'EBF, scalar, series'

'ocean_time'

'idEBF'

'p2dvar'

1.0d0

'strain' ! Output

'strain'

'second-1' ! [1/s]

'strain, scalar, series'

'ocean_time'

'idStr'

'p3dvar'

1.0d0

'strain_sur' ! Output

'surface strain'

'second-1' ! [1/s]

'strain_sur, scalar, series'

'ocean_time'

'idStr2'

'p2dvar'

1.0d0

'rvort_sur' ! Output

'surface relative vorticity'

'second-1' ! [1/s]

'rvort_sur, scalar, series'

'ocean_time'

'idRVsu'

'p2dvar'

1.0d0

'pvort_sur' ! Output

'surface potential vorticity'

'meter-1 second-1' ! [1/m/s]

'pvort_sur, scalar, series'

'ocean_time'

'idPVsu'

'p2dvar'

1.0d0

'pvortk_sur' ! Output

'surface potential vorticity, k component'

'meter-1 second-1' ! [1/m/s]

'pvortk_sur, scalar, series'

'ocean_time'

'idPVKsu'

'p2dvar'

1.0d0

'pvortk' ! Input/Output

'potential vorticity, k component'

'meter-1 second-1' ! [1/m/s]

'pvorticity k component, scalar, series'

'ocean_time'

'id3dPVK'

'p3dvar'

1.0d0

'pvorti' ! Input/Output

'potential vorticity, i component'

'meter-1 second-1' ! [1/m/s]

'pvorticity, i component, scalar, series'

'ocean_time'

'id3dPVI'

'p3dvar'

1.0d0

'pvortj' ! Input/Output

'potential vorticity, j component'

'meter-1 second-1' ! [1/m/s]

'pvorticity, j component, scalar, series'

'ocean_time'

'id3dPVJ'

'p3dvar'

1.0d0

'pvorti_sur' ! Output

'surface potential vorticity, i component'

'meter-1 second-1' ! [1/m/s]

'pvorti_sur, scalar, series'

'ocean_time'

'idPVIsu'

'p2dvar'

1.0d0

'pvortj_sur' ! Output

'surface potential vorticity, j component'

'meter-1 second-1' ! [1/m/s]

'pvortj_sur, scalar, series'

'ocean_time'

'idPVJsu'

'p2dvar'

1.0d0

!

!------------------------------------------------------------------------------

! Wet/dry masks.

!------------------------------------------------------------------------------

!

'wetdry_mask_psi' ! Input/Output

'wet/dry mask on PSI-points'

'nondimensional'

'wetdry_mask_psi, scalar, series'

'ocean_time'

'idPwet'

'p2dvar'

1.0d0

'wetdry_mask_rho' ! Input/Output

'wet/dry mask on RHO-points'

'nondimensional'

'wetdry_mask_rho, scalar, series'

'ocean_time'

'idRwet'

'r2dvar'

1.0d0

'wetdry_mask_u' ! Input/Output

'wet/dry mask on U-points'

'nondimensional'

'wetdry_mask_u, scalar, series'

'ocean_time'

'idUwet'

'u2dvar'

1.0d0

'wetdry_mask_v' ! Input/Output

'wet/dry mask on V-points'

'nondimensional'

'wetdry_mask_v, scalar, series'

'ocean_time'

'idVwet'

'v2dvar'

1.0d0

!

!------------------------------------------------------------------------------

! Detided variables

!------------------------------------------------------------------------------

!

'CosW' ! Input/Output

'time-accumulated COS(omega(k)*t)'

'radians' ! [radians]

'CosW, scalar'

'tide_period'

'idCosW'

'nulvar'

1.0d0

'SinW' ! Input/Output

'time-accumulated SIN(omega(k)*t)'

'radians' ! [radians]

'SinW, scalar'

'tide_period'

'idSinW'

'nulvar'

1.0d0

'CosWCosW' ! Input/Output

'time-accumulated COS(omega(k)*t)*COS(omega(l)*t) matrix'

'radians' ! [radians]

'CosWCosW, scalar'

'tide_period'

'idCos2'

'nulvar'

1.0d0

'SinWSinW' ! Input/Output

'time-accumulated SIN(omega(k)*t)*SIN(omega(l)*t) matrix'

'radians' ! [radians]

'SinWSinW, scalar'

'tide_period'

'idSin2'

'nulvar'

1.0d0

'SinWCosW' ! Input/Output

'time-accumulated SIN(omega(k)*t)*COS(omega(l)*t) matrix'

'radians' ! [radians]

'SinWCosW, scalar'

'tide_period'

'idSWCW'

'nulvar'

1.0d0

'zeta_tide' ! Input/Output

'time-accumulated free-surface tide harmonics'

'meter' ! [m]

'zeta_tide, scalar'

'ocean_time'

'idFsuH'

'r2dvar'

1.0d0

'zeta_detided' ! Output

'detided free-surface'

'meter' ! [m]

'zeta_detided, scalar, series'

'ocean_time'

'idFsuD'

'r2dvar'

1.0d0

'ubar_tide' ! Input/Ouput

'time-accumulated 2D u-momentum tide harmonics'

'meter second-1' ! [m/s]

'ubar_tide, scalar'

'ocean_time'

'idu2dH'

'u2dvar'

1.0d0

'ubar_detided' ! Ouput

'detided 2D u-momentum'

'meter second-1' ! [m/s]

'ubar_detided, scalar, series'

'ocean_time'

'idu2dD'

'u2dvar'

1.0d0

'vbar_tide' ! Input/Output

'time-accumulated 2D v-momentum tide harmonics'

'meter second-1' ! [m/s]

'vbar_tide, scalar'

'ocean_time'

'idv2dH'

'v2dvar'

1.0d0

'vbar_detided' ! Output

'detided 2D v-momentum'

'meter second-1' ! [m/s]

'vbar_detided, scalar, series'

'ocean_time'

'idv2dD'

'v2dvar'

1.0d0

'u_tide' ! Input/Output

'time-accumulated 3D u-momentum tide harmonics'

'meter second-1' ! [m/s]

'u_tide, scalar'

'ocean_time'

'idu3dH'

'u3dvar'

1.0d0

'u_detided' ! Output

'detided 3D u-momentum'

'meter second-1' ! [m/s]

'u_detided, scalar, series'

'ocean_time'

'idu3dD'

'u3dvar'

1.0d0

'v_tide' ! Input/Output

'time-accumulated 3D v-momentum tide harmonics'

'meter second-1' ! [m/s]

'v_tide, scalar'

'ocean_time'

'idv3dH'

'v3dvar'

1.0d0

'v_detided' ! Output

'detided 3D v-momentum'

'meter second-1' ! [m/s]

'v_detided, scalar, series'

'ocean_time'

'idv3dD'

'v3dvar'

1.0d0

'temp_tide' ! Input/Output

'time-accumulated potential temperature tide harmonics'

'Celsius' ! [Celsius]

'temp_tide, scalar'

'ocean_time'

'idTrcH(itemp)'

'r3dvar'

1.0d0

'temp_detided' ! Output

'detided potential temperature'

'Celsius' ! [Celsius]

'v_detided, scalar, series'

'ocean_time'

'idTrcD(itemp)'

'r3dvar'

1.0d0

'temp_tide' ! Input/Output

'time-accumulated potential temperature tide harmonics'

'Celsius' ! [Celsius]

'temp_tide, scalar'

'ocean_time'

'idTrcH(itemp)'

'r3dvar'

1.0d0

'temp_detided' ! Output

'detided potential temperature'

'Celsius' ! [Celsius]

'temp_detided, scalar, series'

'ocean_time'

'idTrcD(itemp)'

'r3dvar'

1.0d0

'salt_tide' ! Input/Output

'time-accumulated salinity tide harmonics'

'nondimensional' ! [PSU]

'salt_tide, scalar'

'ocean_time'

'idTrcH(isalt)'

'r3dvar'

1.0d0

'salt_detided' ! Output

'detided potential temperature'

'nondimensional' ! [PSU]

'salt_detided, scalar, series'

'ocean_time'

'idTrcD(isalt)'

'r3dvar'

1.0d0

!

!------------------------------------------------------------------------------

! Momentum stress variables.

!------------------------------------------------------------------------------

!

'sustr' ! Input/Output

'surface u-momentum stress'

'newton meter-2' ! Input: [N/m2]

'surface u-momentum stress, scalar, series' ! [m2/s2]

'sms_time' ! Output: [N/m2]

'idUsms'

'u2dvar'

1.0d0

'svstr' ! Input/Output

'surface v-momentum stress'

'newton meter-2' ! Input: [N/m2]

'surface v-momentum stress, scalar, series' ! [m2/s2]

'sms_time' ! Output: [N/m2]

'idVsms'

'v2dvar'

1.0d0

'bustr' ! Output

'bottom u-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom u-momentum stress, scalar, series' ! Output: [N/m2]

'bms_time'

'idUbms'

'u2dvar'

1.0d0

'bvstr' ! Output

'bottom v-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom v-momentum stress, scalar, series' ! Output: [N/m2]

'bms_time'

'idVbms'

'v2dvar'

1.0d0

'bustrc' ! Output

'current-induced, bottom u-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom u-momentum stress, scalar, series' ! Output: [N/m2]

'bms_time'

'idUbrs'

'r2dvar'

1.0d0

'bvstrc' ! Ouput

'current-induced, bottom v-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom v-momentum stress, scalar, series' ! Output: [N/m2]

'bms_time'

'idVbrs'

'r2dvar'

1.0d0

'bustrw' ! Output

'wind-induced, bottom u-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom u-wave stress, scalar, series' ! Output: [N/m2]

'ocean_time'

'idUbws'

'r2dvar'

1.0d0

'bvstrw' ! Output

'wind-induced, bottom v-momentum stress'

'newton meter-2' ! [m2/s2]

'bottom v-wave stress, scalar, series' ! Output: [N/m2]

'ocean_time'

'idVbws'

'r2dvar'

1.0d0

'bustrcwmax' ! Output

'maximum wind and current, bottom u-wave stress'

'newton meter-2' ! [m2/s2]

'bustrcwmax, scalar, series' ! Output: [N/m2]

'ocean_time'

'idUbcs'

'u2dvar'

1.0d0

'bvstrcwmax' ! Output

'maximum wind and current, bottom v-wave stress'

'newton meter-2' ! [m2/s2]

'bustrcwmax, scalar, series' ! Output: [N/m2]

'ocean_time'

'idVbcs'

'v2dvar'

1.0d0

'Ubot' ! Output

'wind-induced, bed wave orbital u-velocity'

'meter second-1' ! [m/s]

'bed wave u-velocity, scalar, series'

'ocean_time'

'idUbot'

'r2dvar'

1.0d0

'Vbot' ! Output

'wind-induced, bed wave orbital v-velocity'

'meter second-1' ! [m/s]

'bed wave v-velocity, scalar, series'

'ocean_time'

'idVbot'

'r2dvar'

1.0d0

'Ur' ! Output

'bottom u-momentum above bed'

'meter second-1' ! [m/s]

'bottom u-velocity, scalar, series'

'ocean_time'

'idUbur'

'r2dvar'

1.0d0

'Vr' ! Output

'bottom v-momentum above bed'

'meter second-1' ! [m/s]

'bottom v-velocity, scalar, series'

'ocean_time'

'idVbvr'

'r2dvar'

1.0d0

!

!------------------------------------------------------------------------------

! Tracer flux variables.

!------------------------------------------------------------------------------

!

'shflux' ! Input/Output

'surface net heat flux'

'watt meter-2' ! Input: [Watt/m2]

'surface heat flux, scalar, series' ! [Celsius m/s]

'shf_time' ! Output: [Watt/m2]

'idTsur(itemp)'

'r2dvar'

1.0d0

'dQdSST' ! Input

'surface net heat flux sensitivity to SST'

'watt meter-2 Celsius-1' ! Input: [Watt/m2]

'dQdSST, scalar, series' ! [Celsius m/s]

'sst_time'

'iddQdT'

'r2dvar'

1.0d0

'ssflux' ! Output

'surface net salt flux, (E-P)*SALT'

'meter second-1' ! [PSU m/s]

'surface net salt flux, scalar, series'

'ssf_time'

'idTsur(isalt)'

'r2dvar'

1.0d0

'swflux' ! Input

'surface net freswater flux, (E-P)'

'centimeter day-1' ! Input: [m/s]

'surface net salt flux, scalar, series' ! [PSU m/s]

'swf_time'

'idsfwf'

'r2dvar'

1.157407d-7 ! 0.01/86400

'EminusP' ! Input/Output

'bulk_flux surface net freswater flux, (E-P)'

'meter second-1' ! computed by NLM ROMS

'EminusP, scalar, series' ! bulk_flux.F and

'ocean_time' ! needed in adjoint-based

'idEmPf' ! applications

'r2dvar'

1.0d0

'SSSf' ! Input/Output

'surface net freswater flux from salinity nudging'

'meter second-1' ! computed by NLM ROMS

'SSSf, scalar, series' ! bulk_flux.F and

'ocean_time' ! needed in adjoint-based

'idSSSf' ! applications

'r2dvar'

1.0d0

'fastice' ! Input/Output

'landfast ice extent'

'1' !

'FastIce, scalar, series' !

'ocean_time' !

'idFastIce' !

'r2dvar'

1.0d0

'bhflux' ! Input

'bottom net heat flux'

'watt meter-2' ! Input: [Watt/m2]

'bottom heat flux, scalar, series' ! [Celsius m/s]

'bhf_time'

'idTbot(itemp)'

'r2dvar'

1.0d0

'bwflux' ! Input

'bottom net freshwater flux'

'centimeter day-1' ! Input: [m/s]

'bottom water flux, scalar, series' ! [PSU m/s]

'bwf_time'

'idTbot(isalt)'

'r2dvar'

1.157407d-7 ! 0.01/86400

!

!------------------------------------------------------------------------------

! Ice-related variables

!------------------------------------------------------------------------------

!

'prate'

'precipitation rate'

'kilogram meter-2 second-1'

'precipitation rate, scalar, series'

'prate_time'

'idPrate'

'r2dvar'

1.0d0

'icec'

'observed ice concentration'

'nondimensional'

'ice concentration, scalar series'

'icec_time'

'idIcec'

'r2dvar'

1.0d0

'skt'

'skin temperature'

'degrees Kelvin'

'skin temperature, scalar, series'

'skt_time'

'idSkt'

'r2dvar'

1.0d0

'uice'

'u-component of ice velocity'

'meter second-1'

'u-component of ice velocity, scalar, series'

'ocean_time'

'idUice'

'u2dvar'

1.0d0

'uice'

'u-component of ice velocity'

'meter second-1'

'u-component of ice velocity, scalar, series'

'ocean_time'

'idUIclm'

'u2dvar'

1.0d0

'vice'

'v-component of ice velocity'

'meter second-1'

'v-component of ice velocity, scalar, series'

'ocean_time'

'idVice'

'v2dvar'

1.0d0

'vice'

'v-component of ice velocity'

'meter second-1'

'v-component of ice velocity, scalar, series'

'ocean_time'

'idVIclm'

'v2dvar'

1.0d0

'uice_eastward' ! Output

'ice eastward momentum component at RHO-points'

'meter second-1' ! [m/s]

'uice_eastward, scalar, series'

'ocean_time'

'idUiceE'

'r2dvar'

1.0d0

'vice_northward' ! Output

'ice northward momentum component at RHO-points'

'meter second-1' ! [m/s]

'vice_northward, scalar, series'

'ocean_time'

'idViceN'

'r2dvar'

1.0d0

'aice'

'fraction of cell covered by ice'

'nondimensional'

'ice concentration, scalar, series'

'ocean_time'

'idAice'

'r2dvar'

1.0d0

'aice'

'fraction of cell covered by ice'

'nondimensional'

'ice concentration, scalar, series'

'ocean_time'

'idAIclm'

'r2dvar'

1.0d0

'hice'

'average ice thickness in cell'

'meter'

'ice thickness, scalar, series'

'ocean_time'

'idHice'

'r2dvar'

1.0d0

'hice'

'average ice thickness in cell'

'meter'

'ice thickness, scalar, series'

'ocean_time'

'idHIclm'

'r2dvar'

1.0d0