Variables

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.

A

Akt_bak

Background vertical mixing coefficient.

dimension = Akt_bak(MT,Ngrids)

units = meters² second^-1

option = BIOLOGY, SEDIMENT

routine = mod_mixing.F, mod_scalars.F

keywords = AKT_BAK, MUD_AKT_BAK, SAND_AKT_BAK

input = biology.in, sediment.in

C

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

dstart

Time stamp assigned to model initialization (days). Usually a Calendar linear coordinate, like modified Julian Day.

option =

routine = mod_scalars.F

keyword = DSTART

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

Output floats data 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

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

Ftype

Float trajectory type. If Ftype = 1, float(s) will be neutral density 3D Lagrangian particles. If Ftype = 2, float(s) will be isobaric (constant depth) particles.

option = FLOATS

routine = inp_par.F

input = floats.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

H

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

Vertical level thicknesses, $\,H_{z}\,(\xi ,\eta ,s)$.

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

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

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

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

inert

Identification indexes for inert tracer variables, t(:,:,:,:,inert(:)).

dimension = inert(NPT)

option = T_PASSIVE

routine = mod_scalars.F

isalt

Tracer identification index for salinity, t(:,:,:,:,isalt).

routine = mod_scalars.F

itemp

Tracer identification index for potential temperature, t(:,:,:,:,itemp).

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

L

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

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

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

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

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

M

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

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

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

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

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

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

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

NNS

Number of non-cohesive (sand) sediment tracer-type variables.

option = SEDIMENT

routine = mod_param.F

keyword = NNS

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

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

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

NV

Maximum number of variables in information arrays. Currently, 500.

option =

routine = mod_ncparam.F

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

R

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.

S

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

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

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

Output station data file name. Ngrids values are expected.

dimension = STAname(Ngrids)

option =

routine = mod_iounits.F

keyword = STANAME

input = ocean.in

T

t

Tracer-type variables, $\,T(\xi ,\eta ,s,t,itrc)$.

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

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

tide_start

Reference time origin for tidal forcing (days). 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 =

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

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 = meter² 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 = meter⁴ 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

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

u

Total momentum component in the ξ-direction, $\,u(\xi ,\eta ,s,t)$.

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

Vertically-integrated momentum component in the ξ-direction, ${\bar {u}}(\xi ,\eta ,t)$.

${\bar {u}}={\frac {1}{D}}\int _{-h}^{\zeta }u\,H_{z}\,dz$

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

V

v

3D momentum component in the η-direction, $\,v(\xi ,\eta ,s,t)$.

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

Vertically-integrated momentum component in the η-direction, ${\bar {v}}(\xi ,\eta ,t)$.

${\bar {v}}={\frac {1}{D}}\int _{-h}^{\zeta }v\,H_{z}\,dz$

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

W

W

Terrain-following, vertical velocity component, $\,\Omega (\xi ,\eta ,s)\,Hz/mn$.

dimension = W(LBi:UBi,LBj:UBj,0:N(ng))

pointer = OCEAN(ng)%W

tangent = tl_W

adjoint = ad_W

units = meter³ 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

True vertical velocity component, $\,w(\xi ,\eta ,s)$. It is computed only for output purposes.

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

Z

zeta

Free-surface, $\,\zeta (\xi ,\eta ,t)$.

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

Actual depths of variables at ρ-points, $\,Z_{r}(\xi ,\eta ,s)$.

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

Actual depths of variables at w-points, $\,Z_{w}(\xi ,\eta ,s)$.

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