Variables

From WikiROMS
Jump to navigationJump to search
Variables

This wikipage includes all ROMS global variables in alphabetic order. A single long page is built to facilitate printing. Each variable has a unique anchor tag to facilitate linking from any wikipage.


Contents

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

ad_Akt_fac
Adjoint-based algorithms vertical mixing, basic state, scale factor (nondimensional) for active (NAT) and inert (NPT) tracer variables. In some applications, smaller/larger values of vertical mixing are necessary for stability. It is only used when the CPP option FORWARD_MIXING is activated.
dimension = ad_Akt_fac(MT,Ngrids)
option = FORWARD_MIXING
routine = mod_scalars.F
keyword = ad_AKT_fac
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in
ad_Akv_fac
Adjoint-based algorithms vertical mixing, basic state, scale factor (nondimensional) for momentum. In some applications, smaller/larger values of vertical mixing are necessary for stability. It is only used when the CPP option FORWARD_MIXING is activated.
dimension = ad_Akv_fac(Ngrids)
option = FORWARD_MIXING
routine = mod_scalars.F
keyword = ad_AKV_fac
input = ocean.in
ad_LBC
Adjoint-based algorithms lateral boundary conditions.
dimension = ad_LBC(4,nLBCvar,Ngrids)
option =
routine = mod_param.F
keyword = ad_LBC
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in
ad_tnu2
Adjoint-based algorithms lateral, harmonic, constant, mixing coefficient (m2/s) for active (NAT) and inert (NPT) tracer variables. If variable horizontal diffusion is activated, ad_tnu2 is the mixing coefficient for the largest grid-cell in the domain. In some applications, a larger value than what is used in the nonlinear model (basic state) is necessary for stability.
dimension = ad_tnu2(MT,Ngrids)
option =
routine = mod_scalars.F
keyword = ad_TNU2
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in
ad_tnu4
Adjoint-based algorithms lateral, harmonic, constant, mixing coefficient (m4/s) for active (NAT) and inert (NPT) tracer variables. If variable horizontal diffusion is activated, ad_tnu4 is the mixing coefficient for the largest grid-cell in the domain. In some applications, a larger value than what is used in the nonlinear model (basic state) is necessary for stability.
dimension = ad_tnu4(MT,Ngrids)
option =
routine = mod_scalars.F
keyword = ad_TNU4
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in
ad_visc2
Adjoint-based algorithms lateral, harmonic, constant, mixing coefficient (m2/s) momentum. If variable horizontal viscosity is activated, ad_visc2 is the mixing coefficient for the largest grid-cell in the domain. In some applications, a larger value than what is used in the nonlinear model (basic state) is necessary for stability.
dimension = ad_visc2(Ngrids)
option =
routine = mod_scalars.F
keyword = ad_VISC2
input = ocean.in
ad_visc4
Adjoint-based algorithms lateral, harmonic, constant, mixing coefficient (m4/s) for momentum. If variable horizontal viscosity is activated, ad_visc4 is the mixing coefficient for the largest grid-cell in the domain. In some applications, a larger value than what is used in the nonlinear model (basic state) is necessary for stability.
dimension = ad_visc4(Ngrids)
option =
routine = mod_scalars.F
keyword = ad_VISC4
input = ocean.in
ad_VolCons
Lateral open boundary edge volume conservation switch for adjoint-based algorithms. This is usually activated with radiation boundary conditions to enforce global mass conservation. Notice that these switches should not be activated if tidal forcing enabled.
dimension = ad_VolCons(4,Ngrids)
option =
routine = mod_scalars.F
keyword = ad_VolCons
input = ocean.in
ADJname
Adjoint output NetCDF file name. Ngrids values are expected.
dimension = ADJname(Ngrids)
option =
routine = mod_iounits.F
keyword = ADJNAME
input = ocean.in
ADSname
Adjoint sensitivity functionals input NetCDF file name. Ngrids values are expected.
dimension = ADSname(Ngrids)
option =
routine = mod_iounits.F
keyword = ADSNAME
input = ocean.in
Akk_bak
Background vertical mixing coefficient for turbulent kinetic energy. Ngrids values are expected.
dimension = Akk_bak(Ngrids)
units = meters2 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keyword = AKK_BAK
input = ocean.in
Akp_bak
Background vertical mixing coefficient for turbulent kinetic generic statistical field, psi. Ngrids values are expected.
dimension = Akp_bak(Ngrids)
units = meters2 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keyword = AKP_BAK
input = ocean.in
Akt_bak
Background vertical mixing coefficient for tracer type variables.
dimension = Akt_bak(MT,Ngrids)
units = meters2 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keywords = AKT_BAK, MUD_AKT_BAK, SAND_AKT_BAK
input = biology.in, ocean.in, sediment.in
Akv_bak
Background vertical mixing coefficient for momentum. Ngrids values are expected.
dimension = Akv_bak(Ngrids)
units = meters2 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keyword = AKV_BAK
input = ocean.in
Aout
Set of switches that determine what fields are written to the averages output file (AVGname).
dimension = Aout(NV,Ngrids)
option =
routine = mod_ncparam.F
keyword = Aout
input = ocean.in
aparnam
Assimilation parameters input file name.
option =
routine = mod_iounits.F
keyword = APARNAM
input = ocean.in
AVGname
Averages output NetCDF file name. Ngrids values are expected.
dimension = AVGname(Ngrids)
option =
routine = mod_iounits.F
keyword = AVGNAME
input = ocean.in

B

blk_ZQ
Height of surface air humidity measurement. Usually recorded at 10 meters. Ngrids values are expected.
dimension = blk_ZQ(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = BLK_ZQ
input = ocean.in
blk_ZT
Height of surface air temperature measurement. Usually recorded at 2 or 10 meters. Ngrids values are expected.
dimension = blk_ZT(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = BLK_ZT
input = ocean.in
blk_ZW
Height of surface winds measurement. Usually recorded at 10 meters. Ngrids values are expected.
dimension = blk_ZW(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = BLK_ZW
input = ocean.in
bparnam
Biology parameters input file name.
option =
routine = mod_iounits.F
keyword = BPARNAM
input = ocean.in
BRYname
Open boundary conditions input NetCDF file name. Ngrids values are expected.
dimension = BRYname(Ngrids)
option =
routine = mod_iounits.F
keyword = BRYNAME
input = ocean.in
bvf_bak
Background Brunt-Vaisala frequency squared. Typical values for the ocean range (as a function of depth) from 1.0E-4 to 1.0E-6.
units = seconds-2
routine = mod_scalars.F
keyword = BVF_BAK
input = ocean.in

C

charnok_alpha
Charnok surface roughness used in the various formulations of surface turbulent kinetic energy flux in the GLS. Ngrids values are expected.
dimension = charnok_alpha(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = CHARNOK_ALPHA
input = ocean.in
CLMname
Climatology input NetCDF file name. Ngrids values are expected.
dimension = CLMname(Ngrids)
option =
routine = mod_iounits.F
keyword = CLMNAME
input = ocean.in
crgban_cw
Surface flux due to Craig and Banner wave breaking used in the various formulations of surface turbulent kinetic energy flux in the GLS. Ngrids values are expected.
dimension = crgban_cw(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = CRGBAN_CW
input = ocean.in
Csed
Sediment concentration used in analytical initial conditions. It is used to initialize full 3D cohesive and non-cohesive constant (homogeneous) concentrations of sediment.
dimension = Csed(NST,Ngrids)
units = kilograms meter-3
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_CSED, SAND_CSED
input = sediment.in

D

Dcrit
Minimum depth for wetting and drying. Ngrids values are expected.
dimension = Dcrit(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = DCRIT
input = ocean.in
DendS
Ending day for adjoint sensitivity forcing. Ngrids values are expected.
Note: The adjoint forcing is applied at every time step according to desired state functional stored in the adjoint sensitivity NetCDF file. DstrS must be less than or equal to DendS. If both values are zero, their values are reset internally to the full range of the adjoint integration.
dimension = DendS(Ngrids)
option =
routine = mod_scalars.F
keyword = DendS
input = ocean.in
DIAname
Diagnostics output NetCDF file name. Ngrids values are expected.
dimension = DIAname(Ngrids)
option =
routine = mod_iounits.F
keyword = DIANAME
input = ocean.in
Dout
Set of switches that determine what fields are written to the diagnostics output file (DIAname).
dimension = Dout(NV,Ngrids)
option =
routine = mod_ncparam.F
keyword = Dout
input = ocean.in
dstart
Time stamp assigned to model initialization. Usually a Calendar linear coordinate, like modified Julian Day.
option =
units = days
routine = mod_scalars.F
keyword = DSTART
input = ocean.in
DstrS
Starting day for adjoint sensitivity forcing. Ngrids values are expected.
Note: The adjoint forcing is applied at every time step according to desired state functional stored in the adjoint sensitivity NetCDF file. DstrS must be less than or equal to DendS. If both values are zero, their values are reset internally to the full range of the adjoint integration.
dimension = DstrS(Ngrids)
option =
routine = mod_scalars.F
keyword = DstrS
input = ocean.in
dt
Time-Step size in seconds. If 3D configuration, dt is the size of the baroclinic time-step. If only 2D configuration, dt is the size of the barotropic time-step. Ngrids values are expected.
dimension = dt(Ngrids)
option =
routine = mod_scalars.F
keyword = DT
input = ocean.in
Dwave
wind-induced wave direction. Direction the waves are coming from; measured clockwise from geographic North. (nautical convention).
dimension = Dwave(LBi:UBi,LBj:UBj)
pointer = FORCES(ng)%Dwave
units = degrees
grid = rho-points
option =
routine = ssw_bbl.h, mb_bbl.h, sg_bbl.h, ana_wwave.h, radiation_stress.F

E

Erate
Surface erosion rate for cohesive and non-cohesive sediment.
dimension = Erate(NST,Ngrids)
units = kilograms meter-2 second-1
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_ERATE, SAND_ERATE
input = sediment.in
ERstr
Starting ensemble run (perturbation or iteration) number.
option =
routine = mod_scalars.F
keyword = ERstr
input = ocean.in
ERend
Ending ensemble run (perturbation or iteration) number.
option =
routine = mod_scalars.F
keyword = ERend
input = ocean.in

F

Fcoor
Initial horizontal location (Fx0 and Fy0) coordinate type. If Fcoor = 0 then rho grid points are used. If Fcoor = 1 then location is given in latitude and longitude. Fcoor is column C in the POS specification at the end of the floats.in file.
option = FLOATS
routine = inp_par.F
input = floats.in
Fcount
Number of floats to be released at the specified (Fx0,Fy0,Fz0) location. It must be equal or greater than one. If Fcount is greater than one, a cluster distribution of floats centered at (Fx0,Fy0,Fz0) is activated. The total number of floats trajectories to compute must add up to NFLOATS. Fcount is column N in the POS specification at the end of the floats.in file.
option = FLOATS
routine = inp_par.F
input = floats.in
Fdt
Float cluster release time interval in days. This is only used if Fcount is greater than 1. If Fdt gt; 0 a cluster of floats will be deployed from (Fx0,Fy0,Fz0) at Fdt intervals until Fcount floats are released. If Fdt = 0 Fcount floats will be deployed simultaneously with a distribution centered at (Fx0,Fy0,Fz0) and defined by (Fdx,Fdy,Fdz). This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
Fdx
Cluster x-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
Fdy
Cluster y-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
Fdz
Cluster z-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
FLTname
floats output NetCDF file name. Ngrids values are expected.
dimension = FLTname(Ngrids)
option =
routine = mod_iounits.F
keyword = FLTNAME
input = ocean.in
fposnam
Input initial floats positions file name (floats.in).
option = FLOATS
routine = mod_iounits.F
keyword = FPOSNAM
input = ocean.in
FRCname
Input forcing fields file name(s). Ngrids values are expected.
dimension = FRCname(Ngrids)
option =
routine = mod_iounits.F
keyword = FRCNAME
input = ocean.in
frrec
Flag to indicate re-start from a previous solution. Ngrids values are expected. For new solutions (not a model restart) use frrec = 0. In a re-start solution, frrec is the time index in the floats NetCDF file assigned for initialization. If frrec is negative (say frrec = -1), the floats will re-start from the most recent time record. That is, the initialization record is assigned internally.
dimension = frrec(Ngrids)
option = FLOATS
routine = mod_scalars.F
keyword = FRREC
input = floats.in
Ft0
Time, in days, of float release after model initialization. This value must be of type real (i.e. 0.d0).
option = FLOATS
routine = inp_par.F
input = floats.in

<wikitex>;Ftype

Float trajectory type. If Ftype = 1, float(s) will be 3D Lagrangrian particles. If Ftype = 2, float(s) will be isobaric particles ($p=g*(z+zeta)=constant$). If Ftype = 3, float(s) will be geopotential (constant depth) particles.</wikitex>
option = FLOATS
routine = inp_par.F
input = floats.in
FWDname
Forward trajectory input NetCDF file name. Ngrids values are expected.
dimension = FWDname(Ngrids)
option =
routine = mod_iounits.F
keyword = FWDNAME
input = ocean.in
Fx0
Initial float(s) x-location in grid units or longitude depending on the value of Fcoor. This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
Fy0
Initial float(s) y-location in grid units or longitude depending on the value of Fcoor. This value must be of type real (i.e. 5.d0).
option = FLOATS
routine = inp_par.F
input = floats.in
Fz0
Initial float(s) z-location in vertical levels or depth. If Fz0 is less than or equal to zero then Fz0 is the initial depth in meters. If Fz0 is greater than 0 and less than N(ng) the initial position is relative to the W grid (0 is the bottom and N is the surface). This value must be of type real (i.e. -45.d0).
option = FLOATS
routine = inp_par.F
input = floats.in

G

gamma2
Slipperiness variable, either 1.0 (free slip) or -1.0 (no slip). Ngrids values are expected.
dimension = gamma2(Ngrids)
routine = mod_grid.F, mod_scalars.F
keyword = GAMMA2
input = ocean.in
gls_c1
Generic length-scale closure independent shear production coefficient. Ngrids values are expected.
dimension = gls_c1(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_C1
input = ocean.in
gls_c2
Generic length-scale closure independent dissipation coefficient. Ngrids values are expected.
dimension = gls_c2(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_C2
input = ocean.in
gls_c3m
Generic length-scale closure independent buoyancy production coefficient (minus). Ngrids values are expected.
dimension = gls_c3m(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_C3M
input = ocean.in
gls_c3p
Generic length-scale closure independent buoyancy production coefficient (plus). Ngrids values are expected.
dimension = gls_c3p(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_C3P
input = ocean.in
gls_cmu0
Generic length-scale closure independent stability coefficient. Ngrids values are expected.
dimension = gls_cmu0(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_CMU0
input = ocean.in
gls_Kmin
Generic length-scale minimum value of specific turbulent kinetic energy. Ngrids values are expected.
dimension = gls_Kmin(Ngrids)
option = GLS_MIXING
routine = mod_mixing.F, mod_scalars.F
keyword = GLS_KMIN
input = ocean.in
gls_m
Generic length-scale turbulent kinetic energy exponent. Ngrids values are expected.
dimension = gls_m(Ngrids)
option = GLS_MIXING
routine = mod_mixing.F, mod_scalars.F
keyword = GLS_M
input = ocean.in
gls_n
Generic length-scale turbulent length scale exponent. Ngrids values are expected.
dimension = gls_n(Ngrids)
option = GLS_MIXING
routine = mod_mixing.F, mod_scalars.F
keyword = GLS_N
input = ocean.in
gls_p
Generic length-scale stability exponent. Ngrids values are expected.
dimension = gls_p(Ngrids)
option = GLS_MIXING
routine = mod_mixing.F, mod_scalars.F
keyword = GLS_P
input = ocean.in
gls_Pmin
Generic length-scale minimum value of dissipation. Ngrids values are expected.
dimension = gls_Pmin(Ngrids)
option = GLS_MIXING
routine = mod_mixing.F, mod_scalars.F
keyword = GLS_PMIN
input = ocean.in
gls_sigk
Generic length-scale closure independent constant Schmidt number for turbulent kinetic energy diffusivity. Ngrids values are expected.
dimension = gls_sigk(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_SIGK
input = ocean.in
gls_sigp
Generic length-scale closure independent constant Schmidt number for turbulent generic statistical field, psi. Ngrids values are expected.
dimension = gls_sigp(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = GLS_SIGP
input = ocean.in
GRDname
Grid Input NetCDF file name. Ngrids values are expected.
dimension = GRDname(Ngrids)
option =
routine = mod_iounits.F
keyword = GRDNAME
input = ocean.in
GSTname
GST analysis input/output check pointing NetCDF file name. Ngrids values are expected.
dimension = GSTname(Ngrids)
option =
routine = mod_iounits.F
keyword = GSTNAME
input = ocean.in

H

HISname
History output NetCDF file name. Ngrids values are expected.
dimension = HISname(Ngrids)
option =
routine = mod_iounits.F
keyword = HISNAME
input = ocean.in
Hout
Set of switches that determine what fields are written to the history output file (HISname).
dimension = Hout(NV,Ngrids)
option =
routine = mod_ncparam.F
keyword = Hout
input = ocean.in
HISname
Output history data file name. Ngrids values are expected.
dimension = HISname(Ngrids)
option =
routine = mod_iounits.F
keyword = HISNAME
input = ocean.in
Hz
<wikitex>Vertical level thicknesses, $\,H_z\,(\xi,\eta,s)$.</wikitex>
dimension = Hz(LBi:UBi,LBj:UBj,N(ng))
pointer = GRID(ng)%Hz
tangent = tl_Hz
adjoint = ad_Hz
units = meter
grid = ρ-points
option = SOLVE3D
routine = set_depths.F

I

IADname
Adjoint initial conditions input NetCDF file name. Ngrids values are expected.
dimension = IADname(Ngrids)
option =
routine = mod_iounits.F
keyword = IADNAME
input = ocean.in
idbio
Identification indexes for biological tracer variables, t(:,:,:,:,idbio(:)).
dimension = idbio(NBT)
option = BIOLOGY
routine = mod_scalars.F
idsed
Identification indexes for biological tracer variables, t(:,:,:,:,idsed(:)).
dimension = idsed(NST)
option = SEDIMENT
routine = mod_scalars.F
ieast
Index of eastern boundary.
option =
routine = mod_scalars.F
Iend
Non-overlapping upper bound tile index in the i-direction. Its value depends on the tile rank (sub-domain partition).
routine = tile.h, get_tile.F
inert
Identification indexes for inert tracer variables, t(:,:,:,:,inert(:)).
dimension = inert(NPT)
option = T_PASSIVE
routine = mod_scalars.F
INIname
Nonlinear initial conditions input NetCDF file name. Ngrids values are expected.
dimension = INIname(Ngrids)
option =
routine = mod_iounits.F
keyword = ININAME
input = ocean.in
inorth
Index of northern boundary.
option =
routine = mod_scalars.F
IRPname
Representer initial conditions input NetCDF file name. Ngrids values are expected.
dimension = IRPname(Ngrids)
option =
routine = mod_iounits.F
keyword = IRPNAME
input = ocean.in
isFsur
Assimilation state variable index for free-surface.
value = 1
routine = mod_ncparam.F
isalt
Tracer identification index for salinity, t(:,:,:,:,isalt).
routine = mod_scalars.F
isouth
Index of southern boundary.
option =
routine = mod_scalars.F
Istr
Non-overlapping lower bound tile index in the i-direction. Its value depends on the tile rank (sub-domain partition).
routine = tile.h, get_tile.F
isTvar
Assimilation state variable indices for tracers.
dimension = isTvar(MT)
routine = mod_ncparam.F
isUbar
Assimilation state variable index for 2D U-momentum.
value = 2
routine = mod_ncparam.F
isVbar
Assimilation state variable index for 2D V-momentum.
value = 3
routine = mod_ncparam.F
isUvel
Assimilation state variable index for 3D U-momentum.
value = 4
routine = mod_ncparam.F
isVvel
Assimilation state variable index for 3D V-momentum.
value = 5
routine = mod_ncparam.F
itemp
Tracer identification index for potential temperature, t(:,:,:,:,itemp).
routine = mod_scalars.F
ITLname
Tangent linear initial conditions input NetCDF file name. Ngrids values are expected.
dimension = ITLname(Ngrids)
option =
routine = mod_iounits.F
keyword = ITLNAME
input = ocean.in
iwest
Index of western boundary.
option =
routine = mod_scalars.F

J

Jend
Non-overlapping upper bound tile index in the j-direction. Its value depends on the tile rank (sub-domain partition).
routine = tile.h, get_tile.F
Jstr
Non-overlapping lower bound tile index in the j-direction. Its value depends on the tile rank (sub-domain partition).
routine = tile.h, get_tile.F
Jwtype
Jerlov water type: an integer value from 1 to 5.
option =
routine = mod_mixing.F
keyword = WTYPE
input = ocean.in

K

KendS
Ending vertical level of the 3D adjoint state variables whose sensitivity is required. Ngrids values are expected.
dimension = KendS(Ngrids)
option =
routine = mod_scalars.F
keyword = KendS
input = ocean.in
KstrS
Starting vertical level of the 3D adjoint state variables whose sensitivity is required. Ngrids values are expected.
dimension = KstrS(Ngrids)
option =
routine = mod_scalars.F
keyword = KstrS
input = ocean.in

L

LBC
Lateral boundary conditions.
dimension = LBC(4,nLBCvar,Ngrids)
option =
routine = mod_param.F
keyword = LBC
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in
LBi
Array lower bound dimension in the i-direction. In serial and shared-memory applications its value is LBi = -2 for East-West periodic grids or LBi = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, LBi = Istr - NghostPoints.
option = LOWER_BOUND_I
routine = get_bounds.F, get_tile.F
LBj
Array lower bound dimension in the j-direction. In serial and shared-memory applications its value is LBj = -2 for North-South periodic grids or LBj = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, LBj = Jstr - NghostPoints.
option = LOWER_BOUND_J
routine = get_bounds.F, get_tile.F
LcycleADJ
Logical switch(s) (T/F) used to recycle time records in output adjoint file. Ngrids values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all adjoint fields are saved every nADJ time-steps without recycling.
dimension = LcycleADJ(Ngrids)
option =
routine = mod_scalars.F
keyword = LcycleADJ
input = ocean.in
LcycleRST
Logical switch(s) (T/F) used to recycle time records in output re-start file. Ngrids values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all re-start fields are saved every nRST time-steps without recycling. The re-start fields are written at all levels in double precision unless the RST_SINGLE CPP option is activated.
dimension = LcycleRST(Ngrids)
option = PERFECT_RESTART, RST_SINGLE
routine = mod_scalars.F
keyword = LcycleRST
input = ocean.in
LcycleTLM
Logical switch(s) (T/F) used to recycle time records in output tangent linear file. Ngrids values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all tangent linear fields are saved every nTLM time-steps without recycling.
dimension = LcycleTLM(Ngrids)
option =
routine = mod_scalars.F
keyword = LcycleTLM
input = ocean.in
ldefout
Logical switch(s) (T/F) used to create new output files when initializing from a re-start file, |nrrec| > 0. Ngrids values are expected. If TRUE and applicable, a new history, average, diagnostic and station files are created during the initialization stage. If FALSE and applicable, data is appended to existing history, average, diagnostic and station files. See also parameters ndefHIS, ndefAVG and ndefDIA.
dimension = ldefout(Ngrids)
option = PERFECT_RESTART
routine = mod_scalars.F
keyword = LcycleRST
input = ocean.in
levbfrc
Shallowest level to apply bottom momentum stress as a body-force. Ngrids values are expected.
dimension = levbfrc(Ngrids)
option = BODYFORCE
routine = mod_scalars.F
keyword = LEVBFRC
input = ocean.in
levsfrc
Deepest level to apply surface momentum stress as a body-force. Ngrids values are expected.
dimension = levsfrc(Ngrids)
option = BODYFORCE
routine = mod_scalars.F
keyword = LEVSFRC
input = ocean.in
Lfloats
Logical switch(s) (T/F) used to control the computation of floats trajectories within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option FLOATS is activated. The user can control which grids to process by turning on/off this switch.
dimension = Lfloats(Ngrids)
option = FLOATS
routine = mod_scalars.F
keyword = Lfloats
input = floats.in
Lm
Number of interior grid points in the ξ-direction. Ngrids values are expected.
dimension = Lm(Ngrids)
routine = mod_param.F
keyword = Lm
input = ocean.in
LrstGST
Logical switch(s) (T/F) used to restart GST analysis. If TRUE, the check pointing data is read in from the GST restart NetCDF file. If FALSE and applicable, the check pointing GST data is saved and overwritten every nGST iterations of the algorithm.
dimension =
option =
routine = mod_scalars.F
keyword = LcycleTLM
input = ocean.in
Lsediment
Logical switch(s) (T/F) used to control sediment model computation within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option SEDIMENT is activated. The user can control which grids to process by turning on/off this switch.
dimension = Lsediment(Ngrids)
option = SEDIMENT
routine = mod_scalars.F
keyword = Lsediment
input = sediment.in
Lstate
Logical switches (T/F) to specify the adjoint state variables whose sensitivity is required. Ngrids values are expected for each state variable.
routine = mod_scalars.F
keyword = Lstate
input = ocean.in
Lstations
Logical switch(s) (T/F) used to control the writing of station data within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option STATIONS is activated. The user can control which grids to process by turning on/off this switch.
dimension = Lstations(Ngrids)
option = STATIONS
routine = mod_scalars.F
keyword = Lstations
input = stations.in
LtracerSrc
Logical switch(s) (T/F) used to specify which tracer variables to consider when the CPP option TS_PSOURCE is activated. Only NAT active tracers (temperature, salinity) and NPT inert tracers need to be specified here.
dimension = LtracerSrc(MT,Ngrids)
option = TS_PSOURCE
routine = mod_scalars.F
keyword = LtracerSrc
input = bio_Fennel.in, ecosim.in, nemuro.in, npzd_Franks.in, npzd_iron.in, npzd_Powell.in, ocean.in

M

M2nudg
Nudging time scale for 2D momentum. Ngrids values are expected.
dimension = M2nudg(Ngrids)
units = days
option =
routine = mod_scalars.F
keyword = M2NUDG
input = ocean.in
M3nudg
Nudging time scale for 3D momentum. Ngrids values are expected.
dimension = M3nudg(Ngrids)
units = days
option =
routine = mod_scalars.F
keyword = M3NUDG
input = ocean.in
MaxIterGST
Maximum number of GST algorithm iterations.
dimension =
option =
routine = mod_scalars.F
keyword = MaxIterGST
input = ocean.in
Mm
Number of interior grid points in the η-direction. Ngrids values are expected.
dimension = Mm(Ngrids)
routine = mod_param.F
keyword = Mm
input = ocean.in
morph_fac
Morphological scale factor for cohesive and non-cohesive sediment.
dimension = morph_fac(NST,Ngrids)
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_MORPH_FAC, SAND_MORPH_FAC
input = sediment.in
MyAppCPP
C-preprocessing flag to define the specific configuration. In versions up to 2.3 this flag was one of the predefined model applications that headed the cppdefs.h file. You must make the value of MyAppCPP consistent with variable ROMS_APPLICATION in the build script or makefile if you are not using build.sh or build.bash. ROMS converts the ROMS_APPLICATION variable to lowercase to determine the name of the file to include.
keyword = MyAppCPP
input = ocean.in
MT
The maximum number of tracers between all nested grids. Basically the sum of all NT.

N

N
Number of vertical levels for each nested grid. Ngrids values are expected.
dimension = N(Ngrids)
routine = mod_param.F
keyword = N
input = ocean.in
NAT
Number of active tracer-type variables. Usually, it has a value of two for potential temperature and salinty.
option = SOLVE3D
routine = mod_param.F
keyword = NAT
input = ocean.in
nADJ
Number of time-steps between writing fields into adjoint model file. Ngrids values are expected.
dimension = nADJ(Ngrids)
routine = mod_scalars.F
keyword = NADJ
input = ocean.in
nAVG
Number of time-steps between writing time-averaged data into averages file. Averaged date is written for all fields. Ngrids values are expected.
dimension = nAVG(Ngrids)
routine = mod_scalars.F
keyword = NAVG
input = ocean.in
Nbed
Number of sediment bed layers.
routine = mod_param.F
keyword = Nbed
input = ocean.in
NBT
Number of biological tracer-type variables.
option = BIOLOGY
routine = mod_param.F
keyword = NBT
input = biology.in
NCS
Number of cohesive (mud) sediment tracer-type variables.
option = SEDIMENT
routine = mod_param.F
keyword = NCS
input = ocean.in
NCV
Number of eigenvectors to compute for the Lanczos/Arnoldi problem. NCV must be greater than NEV.
option =
routine = mod_storage.F
keyword = NCV
input = ocean.in
ndefADJ
Number of time-steps between the creation of new adjoint file. If ndefADJ =&nbsp0, the model will only process one adjoint file. This feature is useful for long simulations when output NetCDF files get too large; it creates a new file every ndefADJ time-steps. Ngrids values are expected.
dimension = ndefADJ(Ngrids)
routine = mod_scalars.F
keyword = NDEFADJ
input = ocean.in
ndefAVG
Number of time-steps between the creation of new average file. If ndefAVG =&nbsp0, the model will only process one average file. This feature is useful for long simulations when average files get too large; it creates a new file every ndefAVG time-steps. Ngrids values are expected.
dimension = ndefAVG(Ngrids)
routine = mod_scalars.F
keyword = NDEFAVG
input = ocean.in
ndefDIA
Number of time-steps between the creation of new time-averaged diagnostics file. If ndefDIA = 0, the model will only process one diagnostics file. This feature is useful for long simulations when diagnostics files get too large; it creates a new file every ndefDIA time-steps. Ngrids values are expected.
dimension = ndefDIA(Ngrids)
routine = mod_scalars.F
keyword = NDEFDIA
input = ocean.in
ndefHIS
Number of time-steps between the creation of new history file. If ndefHIS = 0, the model will only process one history file. This feature is useful for long simulations when history files get too large; it creates a new file every ndefHIS time-steps. Ngrids values are expected.
dimension = ndefHIS(Ngrids)
routine = mod_scalars.F
keyword = NDEFHIS
input = ocean.in
ndefTLM
Number of time-steps between the creation of new tangent linear file. If ndefTLM =&nbsp0, the model will only process one tangent linear file. This feature is useful for long simulations when output NetCDF files get too large; it creates a new file every ndefTLM time-steps. Ngrids values are expected.
dimension = ndefTLM(Ngrids)
routine = mod_scalars.F
keyword = NDEFTLM
input = ocean.in
nDIA
Number of time-steps between writing time-averaged diagnostics data into diagnostics file. Averaged date is written for all fields. Ngrids values are expected.
dimension = nDIA(Ngrids)
routine = mod_scalars.F
keyword = NDIA
input = ocean.in
ndtfast
Number of barotropic time-steps between each baroclinic time step. If only 2D configuration, ndtfast should be unity since there is no need to split time-stepping.
option =
routine = mod_scalars.F
keyword = NDTFAST
input = ocean.in
NEV
Number of eigenvalues to compute for the Lanczos/Arnoldi problem. Notice that the model memory requirement increases substantially as NEV increases. The GST requires NEV+1 copies of the model state vector. The memory requirements are decreased in distributed-memory applications.
option =
routine = mod_storage.F
keyword = NEV
input = ocean.in
nFfiles
Number of forcing NetCDF files. Ngrids values are expected.
dimension = nFfiles(Ngrids)
option =
routine = mod_iounits.F
keyword = NFFILES
input = ocean.in
nFLT
Number of time-steps between writing data into floats file (FLTname). Ngrids values are expected.
dimension = nFLT(Ngrids)
option = FLOATS
routine = mod_scalars.F
keyword = NFLT
input = ocean.in
Nfloats
Number of floats to release in each nested grid. Value(s) are used to dynamically allocate the arrays in the Floats array structure. Ngrids values are expected.
dimension = Nfloats(Ngrids)
option = FLOATS
routine = mod_floats.F init_param.F
keyword = NFLOATS
input = floats.in
NghostPoints
Number of ghost points in the halo region used in distributed-memory configurations.
option = GHOST_POINTS
routine = mod_param.F
Ngrids
Number of nested and/or multiple connected grids to solve.
routine = mod_param.F
nGST
Number of GST iterations between storing of check pointing data into NetCDF file. The restart data is always saved if MaxIterGST is reached without convergence. It is also saved when convergence is achieved. It is always a good idea to save the check pointing data at regular intervals so there is a mechanism to recover from an unexpected interruption in this very expensive computation. The check pointing data can be also be used to recompute the Ritz vectors by changing some of the parameters, like convergence criteria (Ritz_tol) and number of Arnoldi iterations (iparam(3)).
routine = mod_scalars.F
keyword = NGST
input = ocean.in
nHIS
Number of time-steps between writing fields into history file. Ngrids values are expected.
dimension = nHIS(Ngrids)
routine = mod_scalars.F
keyword = NHIS
input = ocean.in
ninfo
Number of time-steps between printing of single line information to standard output. It also determines the interval between the computation of global energy diagnostics. Ngrids values are expected.
dimension = ninfo(Ngrids)
option =
routine = mod_scalars.F
keyword = NINFO
input = ocean.in
Ninner
Maximum number of 4DVAR inner loop iterations.
option =
routine = mod_scalars.F
keyword = Ninner
input = ocean.in
Nintervals
Number of time interval divisions for stochastic optimals computations. It must be a multiple of ntimes.
option =
routine = mod_scalars.F
keyword = Nintervals
input = ocean.in
nLBCvar
Number of lateral boundary condition variables.
option =
routine = mod_scalars.F
NNS
Number of non-cohesive (sand) sediment tracer-type variables.
option = SEDIMENT
routine = mod_param.F
keyword = NNS
input = ocean.in
nOBC
Number of time-steps between 4DVAR adjustment of open boundary fields. Ngrids values are expected. In strong constraint 4DVAR, it is possible to adjust open boundaries at other time intervals in addition to initial time. This parameter is used to store the appropriate number of open boundary records in the output history NetCDF files: 1 + ntimes / nOBC records. nOBC must be a factor of ntimes or greater than ntimes. If nOBC > ntimes, only one record is stored in the NetCDF files and the adjustment is for constant forcing with constant correction. This parameter is only relevant in 4DVAR when activating ADJUST_BOUNDARY.
dimension = nOBC(Ngrids)
routine = mod_scalars.F
keyword = NOBC
input = ocean.in
Nouter
Maximum number of 4DVAR outer loop iterations.
option =
routine = mod_scalars.F
keyword = Nouter
input = ocean.in
NPT
Number of inert tracer-type variables. Currently, an inert passive tracer is one that it is only advected and diffused. Other processes are ignored. These tracers include, for example, dyes, pollutants, oil spills, etc.
option = T_PASSIVE
routine = mod_param.F
keyword = NPT
input = ocean.in
nrrec
Switch(s) to indicate re-start from a previous solution. Ngrids values are expected. Use nrrec = 0 for new solutions. In a re-start solution, nrrec is the time index of the re-start NetCDF file assigned for initialization. If nrrec is negative (say nrrec = -1), the model will re-start from the most recent time record. That is, the initialization record is assigned internally. Notice that it is also possible to re-start from a history or time-averaged NetCDF file. If a history or time-averaged NetCDF file is used for re-start, it must contain all the necessary primitive variables at all levels.
dimension = nrrec(Ngrids)
option = PERFECT_RESTART
routine = mod_scalars.F
keyword = NRREC
input = ocean.in
nRST
Number of time-steps between writing of re-start fields. Ngrids values are expected.
dimension = nRST(Ngrids)
option = PERFECT_RESTART
routine = mod_scalars.F
keyword = NRST
input = ocean.in
nSFF
Number of time-steps between 4DVAR adjustment of surface forcing fluxes. Ngrids values are expected. In strong constraint 4DVAR, it is possible to adjust surface forcing at other time intervals in addition to initial time. This parameter is used to store the appropriate number of surface forcing records in the output history NetCDF files: 1 + ntimes / nSFF records. nSFF must be a factor of ntimes or greater than ntimes. If nSFF > ntimes, only one record is stored in the NetCDF files and the adjustment is for constant forcing with constant correction. This parameter is only relevant in 4DVAR when activating either ADJUST_STFLUX or ADJUST_WSTRESS.
dimension = nSFF(Ngrids)
routine = mod_scalars.F
keyword = NSFF
input = ocean.in
NST
Number of sediment tracer-type variables, NST=NCS+NNS.
option = SEDIMENT
routine = mod_param.F
nSTA
Number of time-steps between writing data into stations file. Station data is written at all levels. Ngrids values are expected.
dimension = nSTA(Ngrids)
option = STATIONS
routine = mod_scalars.F
keyword = NSTA
input = ocean.in
Nstation
Number of stations to process in each nested grid. Value(s) are used to dynamically allocate the station arrays. Ngrids values are expected.
dimension = Nstation(Ngrids)
option = STATIONS
routine = mod_param.F
keyword = NSTATION
input = stations.in
NT
Total number of tracer-type variables for each nested grid. Currently, NT=NAT+NPT+NST+NBT.
dimension = NT(Ngrids)
option = SOLVE3D
routine = mod_param.F
input = ocean.in (derived from NAT+NPT+NST+NBT)
NtileI
Number of domain partitions in the I-direction (ξ-coordinate). It must be equal to or greater than one. Ngrids values are expected.
dimension = NtileI(Ngrids)
option =
routine = mod_param.F
keyword = NtileI
input = ocean.in
NtileJ
Number of domain partitions in the J-direction (η-coordinate). It must be equal to or greater than one. Ngrids values are expected.
dimension = NtileJ(Ngrids)
option =
routine = mod_param.F
keyword = NtileJ
input = ocean.in
ntimes
Total number time-steps in current run. If 3D configuration, ntimes is the total of baroclinic time-steps. If only 2D configuration, ntimes is the total of barotropic time-steps.
option =
routine = mod_scalars.F
keyword = NTIMES
input = ocean.in
nTLM
Number of time-steps between writing fields into tangent linear model file. Ngrids values are expected.
dimension = nTLM(Ngrids)
routine = mod_scalars.F
keyword = NTLM
input = ocean.in
ntsAVG
Starting time-step for the accumulation of output time-averaged data. Ngrids values are expected.
dimension = ntsAVG(Ngrids)
routine = mod_scalars.F
keyword = NTSAVG
input = ocean.in
ntsDIA
Starting time-step for the accumulation of output time-averaged diagnostics data. Ngrids values are expected.
dimension = ntsDIA(Ngrids)
routine = mod_scalars.F
keyword = NTSDIA
input = ocean.in
Nuser
Number of generic user parameters to consider (integer). This integer and the number of values in USER must be the same.
routine = mod_scalars.F
keyword = NUSER
input = ocean.in
NV
Maximum number of variables in information arrays. Currently, 500.
option =
routine = mod_ncparam.F
input = ocean.in
Nvct
Parameter to process the Nvct eigenvector of the stabilized representer matrix when computing array modes (here, Nvct=Ninner is the most important while Nvct=1 is the least important) OR cut-off parameter for the clipped analysis to disregard potentially unphysical array modes (that is, all the eigenvectors < Nvct are disregarded).
option =
routine = mod_fourdvar.F, inp_par.F
keyword = Nvct
input = s4dvar.in

O

obcfac
Factor between passive (outflow) and active (inflow) open boundary conditions. The nudging time scales for the active (inflow) conditions are obtained by multiplying the passive values by obcfac. If obcfac > 1, nudging on inflow is stronger than on outflow (recommended). Ngrids values are expected.
dimension = obcfac(Ngrids)
option =
routine = mod_scalars.F
keyword = OBCFAC
input = ocean.in

P

poros
Porosity for cohesive and non-cohesive sediment.
dimension = poros(NST,Ngrids)
option = SEDIMENT
routine = mod_ocean.F, mod_sediment.F
keywords = MUD_POROS, SAND_POROS
input = sediment.in

Q

R

R0
Background density value used in Linear Equation of State. Ngrids values are expected.
dimension = R0(Ngrids)
units = kilograms meters-3
option =
routine = mod_scalars.F
keyword = R0
input = ocean.in
rdrg
Linear bottom drag coefficient used in the computation of momentum stress. Ngrids values are expected.
dimension = rdrg(Ngrids)
units = meters seconds-1
option =
routine = mod_scalars.F
keyword = RDRG
input = ocean.in
rdrg2
Quadratic bottom drag coefficient used in the computation of momentum stress. Ngrids values are expected.
dimension = rdrg2(Ngrids)
option =
routine = mod_scalars.F
keyword = RDRG2
input = ocean.in

<wikitex>;rho

In situ density anomaly computed as a function of potential temperature, salinity, and depth.
$\sigma(\xi,\eta,s) = \rho(\xi,\eta,s) - 1000$.
dimension = rho(LBi:UBi,LBj:UBj,N(ng))
pointer = OCEAN(ng)%rho
tangent = tl_rho
adjoint = ad_rho
units = kilogram meter-3
grid = ρ-points
option = SOLVE3D, NONLIN_EOS
routine = rho_eos.F
It can computed using a linear or nonlinear equation of state. The nonlinear equation of state is based on Jackett and McDougall (1992) polynomial expressions.</wikitex>
rho0
Mean density used when the Boussinesq approximation is inferred.
units = kilograms meters-3
routine = mod_scalars.F
keyword = RHO0
input = ocean.in
Ritz_tol
Relative accuracy of the Ritz values computed in the GST analysis.
routine = mod_scalars.F
keyword = Ritz_tol
input = ocean.in
RSTname
Restart NetCDF file name. Ngrids values are expected.
dimension = RSTname(Ngrids)
option =
routine = mod_iounits.F
keyword = RSTNAME
input = ocean.in

S

S0
Background salinity (PSU) constant used in Linear Equation of State. Ngrids values are expected.
dimension = S0(Ngrids)
option =
routine = mod_scalars.F
keyword = S0
input = ocean.in
Scoef
Saline contraction coefficient in Linear Equation of State. Ngrids values are expected.
dimension = Scoef(Ngrids)
option =
routine = mod_scalars.F
keyword = SCOEF
input = ocean.in
Sd50
Median grain diameter for cohesive and non-cohesive sediment.
dimension = Sd50(NST,Ngrids)
units = millimeters
option = SEDIMENT
routine = mod_ncparam.F, mod_ocean.F, mod_sediment.F
keywords = MUD_SD50, SAND_SD50
input = sediment.in
SO_decay
Stochastic optimals time decorrelation scale assumed for red noise processes. Ngrids values are expected.
dimension = SO_decay(Ngrids)
units = days
option =
routine = mod_scalars.F
keyword = SO_decay
input = ocean.in
SO_sdev
Stochastic optimals surface forcing standard deviation for dimensionalization.
routine = mod_scalars.F
keyword = SO_sdev
input = ocean.in
SOstate
Logical switches (T/F) to specify the state surface forcing variables whose stochastic optimals are required.
routine = mod_scalars.F
keyword = SOstate
input = ocean.in
Sout
Set of switches that determine what fields are written to the stations output file (STAname).
dimension = Sout(NV,Ngrids)
option = STATIONS
routine = mod_ncparam.F
keyword = Sout
input = stations.in
sparnam
Input sediment transport parameters (sediment.in) file name.
option = SEDIMENT
routine = mod_iounits.F
keyword = SPARNAM
input = ocean.in
sposnam
Input initial stations positions (stations.in) file name.
option = STATIONS
routine = mod_iounits.F
keyword = SPOSNAM
input = ocean.in
Srho
Sediment grain density for cohesive and non-cohesive sediment.
dimension = Srho(NST,Ngrids)
units = kilograms meter-3
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_SRHO, SAND_SRHO
input = sediment.in
STAname
Stations output NetCDF file name. Ngrids values are expected.
dimension = STAname(Ngrids)
option =
routine = mod_iounits.F
keyword = STANAME
input = ocean.in
sz_alpha
Surface flux from wave dissipation used in the various formulations of surface turbulent kinetic energy flux in the GLS. Ngrids values are expected.
dimension = sz_alpha(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = SZ_ALPHA
input = ocean.in

T

t
<wikitex>Tracer-type variables, $T(\xi,\eta,s,t,itrc)$.</wikitex>
dimension = t(LBi:UBi,LBj:UBj,N(ng),3,NT(ng))
pointer = OCEAN(ng)%t
tangent = tl_t
adjoint = ad_t
grid = ρ-points
option = SOLVE3D
routine = step3d_t.F
This array contains all the tracer fields. They are classified as active (potential temperature, salinity), inert (dyes, pollutants, oil spills, etc), passive (sediment, biology). There is a index identifier for each tracer field (see table below). Notice that salinity does not have physical units. Usually PSU is used to indicate that the practical salinity scale was used to determine conductivity.
Index Field Units CPP
itemp Potential temperature Celsius SOLVE3D
isalt Salinity None SALINITY
inert(1:NPT) NPT inert tracers kilogram meter-3 T_PASSIVE
idsed(1:NST) NST sediment tracers kilogram meter-3 SEDIMENT
idbio(1:NBT) NBT biology tracers millimole meter-3 BIOLOGY
T0
Background potential temperature constant used in Linear Equation of State. Ngrids values are expected.
dimension = T0(Ngrids)
units = Celsius
option =
routine = mod_scalars.F
keyword = T0
input = ocean.in
tau_cd
Kinematic critical shear for deposition of cohesive and non-cohesive sediment. This is ignored for cohesive sediment.
dimension = tau_cd(NST,Ngrids)
units = Newton meter-2
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_TAU_CD, SAND_TAU_CD
input = sediment.in
tau_ce
Kinematic critical shear for erosion of cohesive and non-cohesive sediment.
dimension = tau_ce(NST,Ngrids)
units = Newton meter-2
option = SEDIMENT
routine = mod_sediment.F
keywords = MUD_TAU_CE, SAND_TAU_CE
input = sediment.in
Tcoef
Thermal expansion coefficient in Linear Equation of State. Ngrids values are expected.
dimension = Tcoef(Ngrids)
option =
routine = mod_scalars.F
keyword = TCOEF
input = ocean.in
Tcline
Width of surface or bottom boundary layer in which higher vertical resolution is required during stretching. Ngrids values are expected. WARNING: Users need to experiment with theta_b, theta_s and Tcline. We have found out that the model goes unstable with high values of theta_s. In steep and very tall topography, it is recommended to use theta_s < 3.0.
dimension = Tcline(Ngrids)
units = meters
routine = mod_scalars.F
keyword = TCLINE
input = ocean.in
theta_b
S-coordinate bottom control parameter, (0 < theta_b < 1). Ngrids values are expected. WARNING: Users need to experiment with theta_b, theta_s and Tcline. We have found out that the model goes unstable with high values of theta_s. In steep and very tall topography, it is recommended to use theta_s < 3.0.
dimension = theta_b(Ngrids)
routine = mod_scalars.F
keyword = THETA_B
input = ocean.in
theta_s
S-coordinate surface control parameter, (0 < theta_s < 20). Ngrids values are expected. WARNING: Users need to experiment with theta_b, theta_s and Tcline. We have found out that the model goes unstable with high values of theta_s. In steep and very tall topography, it is recommended to use theta_s < 3.0.
dimension = theta_s(Ngrids)
routine = mod_scalars.F
keyword = THETA_S
input = ocean.in
tide_start
Reference time origin for tidal forcing. This is the time used when processing input tidal model data. It is needed in routine set_tides.F to compute the correct phase lag with respect ROMS/TOMS initialization time.
option =
units = days
routine = mod_scalars.F
keyword = TIDE_START
input = ocean.in
time_ref
Reference time (yyyymmdd.f) used to compute relative time: elapsed time interval since reference-time.
option =
routine = mod_scalars.F
keyword = TIME_REF
input = ocean.in
title
Title of model run.
keyword = TITLE
input = ocean.in
tkenu2
Lateral harmonic constant mixing coefficient for turbulent closure variables. Ngrids values are expected.
dimension = tkenu2(Ngrids)
units = meters2 second-1
option =
routine = mod_scalars.F
keyword = TKENU2
input = ocean.in
tkenu4
Lateral biharmonic constant mixing coefficient for turbulent closure variables. Ngrids values are expected.
dimension = tkenu4(Ngrids)
units = meters4 second-1
option =
routine = mod_scalars.F
keyword = TKENU4
input = ocean.in
tl_LBC
Lateral boundary conditions.
dimension = tl_LBC(4,nLBCvar,Ngrids)
option =
routine = mod_param.F
TLFname
Impulse tangent linear forcing output NetCDF file name. Ngrids values are expected.
dimension = TLFname(Ngrids)
option =
routine = mod_iounits.F
keyword = TLFNAME
input = ocean.in
TLMname
Tangent linear history output NetCDF file name. Ngrids values are expected.
dimension = TLMname(Ngrids)
option =
routine = mod_iounits.F
keyword = TLMNAME
input = ocean.in
tnu2
Lateral harmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, tnu2 is the mixing coefficient for the largest grid-cell in the domain.
dimension = tnu2(MT,Ngrids)
units = meter2 second-1
option = SEDIMENT, BIOLOGY
routine = mod_mixing.F, mod_scalars.F
keywords = MUD_TNU2, SAND_TNU2, TNU2
input = biology.in, sediment.in
tnu4
Square root lateral biharmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, tnu4 is the mixing coefficient for the largest grid-cell in the domain.
dimension = tnu4(MT,Ngrids)
units = meter4 second-1
option = SEDIMENT, BIOLOGY
routine = mod_mixing.F, mod_scalars.F
keywords = MUD_TNU4, SAND_TNU4, TNU4
input = biology.in, sediment.in
Tnudg
Inverse time-scale for nudging tracers at open boundaries and sponge areas.
dimension = Tnudg(MT,Ngrids)
option = SEDIMENT, BIOLOGY
routine = mod_scalars.F
keywords = MUD_TNUDG, SAND_TNUDG, TNUDG
input = biology.in, sediment.in

U

u
<wikitex>Total momentum component in the $xi\hyphen$direction, $u(\xi,\eta,s,t)$.</wikitex>
dimension = u(LBi:UBi,LBj:UBj,N(ng),2)
pointer = OCEAN(ng)%u
tangent = tl_u
adjoint = ad_u
units = meter second-1
grid = u-points
option = SOLVE3D
routine = step3d_uv.F
ubar
<wikitex>Vertically-integrated momentum component in the ξ-direction, $\bar u(\xi,\eta,t)$.
$$\bar u = \frac{1}{D} \int_{-h}^{\zeta} u\,H_z\,dz$$</wikitex>
dimension = ubar(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%ubar
tangent = tl_ubar
adjoint = ad_ubar
units = meter second-1
grid = u-points
routine = step2d.F
UBi
Array upper bound dimension in the i-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_I. In distributed-memory its value is a function of the tile partition, UBi=Iend+NghostPoints.
option = UPPER_BOUND_I
routine = get_bounds.F, get_tile.F
UBj
Array upper bound dimension in the j-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_J. In distributed-memory its value is a function of the tile partition, UBj=Jend+NghostPoints.
option = UPPER_BOUND_J
routine = get_bounds.F, get_tile.F
user
Generic User parameters, NUSER values are expected.
routine = mod_scalars.F
keyword = USER
input = ocean.in
USRname
USER's input generic file name.
routine = mod_iounits.F
keyword = USRNAME
input = ocean.in

V

v
<wikitex>3D momentum component in the η-direction, $v(\xi,\eta,s,t)$.</wikitex>
dimension = v(LBi:UBi,LBj:UBj,N(ng),2)
pointer = OCEAN(ng)%v
tangent = tl_u
adjoint = ad_u
units = meter second-1
grid = v-points
option = SOLVE3D
routine = step3d_uv.F
varname
Input variable information file name. This file needs to be processed first so all information arrays can be initialized properly. The default file is at ROMS/External/varinfo.dat.
keyword = VARNAME
input = ocean.in
vbar
<wikitex>Vertically-integrated momentum component in the η-direction, $\bar v(\xi,\eta,t)$.
$$\bar v = \frac{1}{D} \int_{-h}^{\zeta} v\,H_z\,dz$$</wikitex>
dimension = vbar(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%vbar
tangent = tl_vbar
adjoint = ad_vbar
units = meter second-1
grid = v-points
routine = step2d.F
visc2
Lateral harmonic constant mixing coefficient for momentum. Ngrids values are expected. If variable horizontal viscosity is activated, visc2 is the mixing coefficient for the largest grid-cell in the domain.
dimension = visc2(Ngrids)
units = meters2 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keyword = VISC2
input = ocean.in
visc4
Lateral biharmonic constant mixing coefficient for momentum. Ngrids values are expected. If variable horizontal viscosity is activated, visc4 is the mixing coefficient for the largest grid-cell in the domain.
dimension = visc4(Ngrids)
units = meters4 second-1
option =
routine = mod_mixing.F, mod_scalars.F
keyword = VISC4
input = ocean.in
VolCons
Lateral open boundary edge volume conservation switch for the nonlinear model. This is usually activated with radiation boundary conditions to enforce global mass conservation. Notice that these switches should not be activated if tidal forcing enabled.
dimension = VolCons(4,Ngrids)
option =
routine = mod_scalars.F
keyword = VolCons
input = ocean.in
Vstretching
Selects the vertical stretching function, C(s). Ngrids values are expected. Possible values are:
1 - Original function in ROMS from the very beginning from Song and Haidvogel (1994)
2 - A. Shchepetkin function from UCLA-ROMS
3 - R. Geyer function for shallow sediment applications
See Vertical S-coordinate for more information.
dimension = Vstretching(Ngrids)
routine = mod_scalars.F
keyword = Vstretching
input = ocean.in
Vtransform
Selects the vertical transform equation. Ngrids values are expected. Possible values are:
1 - Original formulation that has been in ROMS since 1999 described in Shchepetkin and McWilliams (2005)
2 - New formulation developed by A. Shchepetkin
See Vertical S-coordinate for more information.
dimension = Vtransform(Ngrids)
routine = mod_scalars.F
keyword = Vtransform
input = ocean.in

W

W
<wikitex>Terrain-following, vertical velocity component, $\Omega(\xi,\eta,s)\,H_z/mn$.</wikitex>
dimension = W(LBi:UBi,LBj:UBj,0:N(ng))
pointer = OCEAN(ng)%W
tangent = tl_W
adjoint = ad_W
units = meter3 second-1
sign = positive downwards (downwelling), negative upwards (upwelling)
grid = w-points
option = SOLVE3D
routine = omega.F
Wsed
Particle settling velocity for cohesive and non-cohesive sediment.
dimension = Wsed(NST,Ngrids)
option = SEDIMENT
routine = mod_ncparam.F, mod_ocean.F, mod_sediment.F
keywords = MUD_WSED, SAND_WSED
input = sediment.in
wvel
<wikitex>True vertical velocity component, $w(\xi,\eta,s)$. It is computed only for output purposes.</wikitex>
dimension = wvel(LBi:UBi,LBj:UBj,0:N(ng))
pointer = OCEAN(ng)%wvel
units = meter second-1
sign = positive downwards (downwelling), negative upwards (upwelling
grid = w-points
option = SOLVE3D
routine = wvelocity.F

X

Y

Z

zeta
<wikitex>Free-surface, $\zeta(\xi,\eta,t)$.</wikitex>
dimension = zeta(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%zeta
tangent = tl_zeta
adjoint = ad_zeta
units = meter
grid = ρ-points
routine = step2d.F
z_r
<wikitex>Actual depths of variables at ρ-points, $Z_r(\xi,\eta,s)$.</wikitex>
dimension = z_r(LBi:UBi,LBj:UBj,N(ng))
pointer = GRID(ng)%z_r
units = meter
sign = negative downwards
grid = ρ-points
option = SOLVE3D
routine = set_depths.F
z_w
<wikitex>Actual depths of variables at w-points, $Z_w(\xi,\eta,s)$.</wikitex>
dimension = z_w(LBi:UBi,LBj:UBj,0:N(ng))
pointer = GRID(ng)%z_w
units = meter
sign = negative downwards
grid = w-points
option = SOLVE3D
routine = set_depths.F
Znudg
Nudging time scale for free-surface. Ngrids values are expected.
dimension = Znudg(Ngrids)
units = days
option =
routine = mod_scalars.F
keyword = ZNUDG
input = ocean.in
Zob
Bottom roughness used in the computation of momentum stress. Ngrids values are expected.
dimension = Zob(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = Zob
input = ocean.in
Zos
Surface roughness used in the computation of momentum stress. Ngrids values are expected.
dimension = Zos(Ngrids)
units = meters
option =
routine = mod_scalars.F
keyword = Zos
input = ocean.in
zos_hsig_alpha
Roughness from wave amplitude used in the various formulations of surface turbulent kinetic energy flux in the GLS. Ngrids values are expected.
dimension = zos_hsig_alpha(Ngrids)
option = GLS_MIXING
routine = mod_scalars.F
keyword = ZOS_HSIG_ALPHA
input = ocean.in
Retrieved from "https://www.myroms.org/wiki/index.php?title=Variables&oldid=4440"