Options: Difference between revisions

From WikiROMS
Jump to navigationJump to search
No edit summary   (change visibility)
Line 2,037: Line 2,037:


==<span class="alphabet">P</span>==
==<span class="alphabet">P</span>==
<section begin=PERFECT_RESTART />;<span id="PICARD_TEST"></span>[[PERFECT_RESTART]]
:Option to
:'''parameter = '''
:'''parent = '''
:'''required = '''
:'''related = '''
:'''conflict = '''
:'''routine = '''  <section end=PICARD_TEST />


<section begin=PICARD_TEST />;<span id="PICARD_TEST"></span>[[PICARD_TEST]]
<section begin=PICARD_TEST />;<span id="PICARD_TEST"></span>[[PICARD_TEST]]

Revision as of 12:21, 15 April 2008

CPP Options

This wikipage includes all ROMS CPP options in alphabetic order. A single long page is built to facilitate printing. Each option also has an individual page and its definition below is loaded using labeled section transclusion syntax. The following attributes have been identified to aid in the description of ROMS CPP options:

  • conflict: indicates mutually exclusive options.
  • parameter: important standard input parameter(s) associtated with the option.
  • parent: indicates association to a main option.
  • related: indicates other affiliated option(s) that may affect or not its scope.
  • required: indicates other dependent option(s) that must be activated.
  • routine: main files associated with the option.
  • variable: important state array(s) associtated with the option.


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

ADD_FSOBC
Option to add tidal elevation to sea surface height climatology, if any, and open boundary conditions data.
variable = ssh, zeta_east, zeta_north, zeta_south, zeta_west
required = SSH_TIDES
related = ZCLIMATOLOGY
related = EAST_FSOBC, NORTH_FSOBC, SOUTH_FSOBC, WEST_FSOBC
routine = set_tides.F
ADD_M2OBC
Option to add tidal currents to 2D momentum climatology, if any, and open boundary conditions data.
variable = ubarclm, vbarclm
variable = ubar_east, ubar_north, ubar_south, ubar_west
variable = vbar_east, vbar_north, vbar_south, vbar_west
required = UV_TIDES
related = M2CLIMATOLOGY
related = EAST_M2OBC, NORTH_M2OBC, SOUTH_M2OBC, WEST_M2OBC
routine = set_tides.F
ADJOINT
Internal option to include adjoint model. It primarily declares and allocate all adjoint state variables and activates all adjoint subroutines.
related = TANGENT
ADM_DRIVER
Option to run the adjoint model as a standalone driver.
related = RPM_DRIVER, TLM_DRIVER
routine = ocean_control.F
AD_SENSITIVITY
Option to run the adjoint sensitivity ocean driver ( Moore et al., 2006).
parent = ADJOINT
routine = adsen_ocean.h, ocean_control.F
AFT_EIGENMODES
Option to run the adjoint finite time eigenvalues driver ( Moore et al., 2004).
parent = ADJOINT
related = FT_EIGENMODES
routine = aft_ocean.h, ocean_control.F
AIR_OCEAN
Option to activate two-way coupling to an atmospheric model. Currently, the coupling is done with the Model Coupling Toolkit (MCT). The coupling is either sequential or concurrent and it is only available for distributed-memory configurations. If concurrent, the MPI communicator is splited into atmosphere and ocean nodes.
conflict = WAVES_OCEAN
routine = master.F, air_ocean.h, coupling.in
ALBEDO
Option to compute net shortwave radiation flux using the Laevastu (1960) cloud correction to the Zillerman (1972) equation for cloudless radiation (Parkinson and Washington, 1979).
variable = srflx
required = ANA_SRFLUX
related = DIURNAL_SRFLUX
routine = analytical.F (ana_srflux)
ANA_BIOLOGY
Option to set biological tracers initial conditions with analytical expressions.
variable = t(:,:,:,:,idbio(1:NBT))
related = BIOLOGY
routine = analytical.F (ana_biology)
ANA_BPFLUX
Option to set passive tracers bottom flux with analytical expressions (usually zero, no bottom flux).
variable = btflx(:,:,NAT+1:NT(ng))
required = BIOLOGY, SEDIMENT
related = ANA_BSFLUX, ANA_BTFLUX
routine = analytical.F (ana_btflux)
ANA_BSFLUX
Option to set kinematic bottom salinity flux with an analytical expression (usually zero, no bottom flux).
variable = btflx(:,:,isalt)
required = SALINITY, SOLVE3D
related = ANA_BPFLUX, ANA_BTFLUX
routine = analytical.F (ana_btflux)
ANA_BTFLUX
Option to set kinematic bottom heat flux with an analytical expression (usually zero, no bottom flux).
variable = btflx(:,:,itemp)
required = SOLVE3D
related = ANA_BPFLUX, ANA_BSFLUX
routine = analytical.F (ana_btflux)
ANA_CLOUD
Option to set cloud fraction with an analytical expression.
variable = cloud
required = CLOUDS
routine = analytical.F (ana_clouds)
ANA_DIAG
Option to activate the computation of any user specified diagnostics.
routine = analytical (ana_diag), diag.F
ANA_FSOBC
Option to set free-surface open boundary conditions using analytical expressions.
variable = zeta_east, zeta_north, zeta_south, zeta_west
required = OBC
routine = analytical.F (ana_fsobc)
ANA_GRID
Option to set application grid variables with analytical expressions. Mostly, all the idealized test problems use this option. It sets the following grid-related variables: Coriolis parameter, bathymetry, ξ- and η-direction metrics and its derivates, curvilinear grid angle, ξ- and η-direction coordinates, and spherical coordinates, if applicable.
variable = f, h
variable = angler, dmde , dndx, pm , pn
variable = xp, xr, xu, xv, yp, yr, yu, yv
variable = lonp, lonr, lonu, lonv, latp, latr, latu, latv
routine = analytical.F (ana_grid)
ANA_HUMIDITY
Option to set surface air humidity (moisture) with an analytical expression. There are three types of humidity: i) absolute humidity is the density of water vapor, ii) specific humidity is the ratio of the mass of water vapor to the mass of moist air containing the vapor (g/kg), and iii) relative humidity is the ratio of the actual mixing ratio to saturation mixing ratio of the air at a given temperature and pressure (percentage).
variable = Hair
required = ALBEDO, BULK_FLUXES, ECOSIM
routine = analytical.F (ana_humid)
ANA_INITIAL
Option to set initial conditions for free-surface, momentum, and tracers with analytical expressions. Mostly, all the idealized test problems use this option.
variable = zeta, ubar, vbar
variable = u, v, t
conflict = INI_FILE
routine = analytical.F (ana_initial)
ANA_M2CLIMA
Option to set 2D momentum climatology with analytical expressions.
variable = ubarclm, vbarclm
required = M2CLIMATOLOGY
related = M2CLM_NUDGING, UV_TIDES
routine = analytical.F (ana_m2clima)
ANA_M2OBC
Option to set 2D momentum open boundary conditions using analytical expressions.
variable = ubar_east, ubar_north, ubar_south, ubar_west
variable = vbar_east, vbar_north, vbar_south, vbar_west
required = OBC
routine = analytical.F (ana_m2obc)
ANA_M3CLIMA
Option to set 3D momentum climatology with analytical expressions.
variable = uclm, vclm
parent = SOLVE3D
required = M3CLIMATOLOGY
related = M3CLM_NUDGING
routine = analytical.F (ana_m3clima)
ANA_M3OBC
Option to set 3D momentum open boundary conditions using analytical expressions.
variable = u_east, u_north, u_south, u_west
variable = v_east, v_north, v_south, v_west
required = OBC
routine = analytical.F (ana_m3obc)
ANA_MASK
Option to set land/sea masking using the analytical set-up. It is used in few idealized test problems. The mask has a value of zero over land and unity over water.
variables = pmask, rmask, umask, vmask
routine = analytical.F (ana_mask)
ANA_PAIR
Option to set surface air pressure with an analytical expression.
variable = Pair
required = BULK_FLUXES, ECOSIM
routine = analytical.F (ana_pair)
ANA_PASSIVE
Option to set inert, passive tracers initial conditions with analytical expressions.
variable = t(:,:,:,:,inert(1:NPT))
parent = SOLVE3D
required = T_PASSIVE
routine = analytical.F (ana_passive)
ANA_PERTURB
Option to perturb tangent linear and adjoint state initial conditions at specified spatial (i,j,k) location. This is used to determine the correctness of the tangent linear and adjoint models by computing the inner product at the specified location. This inner product must be symmetric within roundoff (A - AT = 0).
parameter = user(1:8)
parent = ADJOINT, TANGENT
required = SANITY_CHECK
related = INNER_PRODUCT
routine = analytical.F (ana_perturb)
ANA_PSOURCE
Option to set point sources and sinks with analytical expressions. Usually, river runoff are represented as a point source.
variable = Isrc, Jsrc, Lsrc, Dsrc
variable = Qbar, Qshape, Qsrc, Tsrc
required = Q_PSOURCE, TS_PSOURCE, UV_PSOURCE
routine = analytical.F (ana_psource)
ANA_RAIN
Option to set rain fall rate with an analytical expression.
variable = rain
required = BULK_FLUXES
related = EMINUSP
routine = analytical.F (ana_rain)
ANA_SEDIMENT
Option to set cohesive and non-cohesive sediment initial conditions with analytical expressions. It also initializes sediment bed layer properties (thickness, age, porosity), sediment fraction and mass of each size class in each bed layer, and exposed sediment layer properties (mean grain diameter, mean grain density, mean settling velocity, mean critical erosion stress, ripple length and height, bed wave excursion amplitude, and several bottom roughnesses).
variable = t(:,:,:,:,idsed(1:NST))
variable = bed, bed_frac, bed_mass, bottom
parent = SOLVE3D
required = SEDIMENT
related = BBL_MODEL, SED_BIODIFF
routine = analytical.F (ana_sediment)
ANA_SMFLUX
Option to set kinematic, surface momentum flux boundary condition (wind stress) with analytical expressions.
variable = sustr, svstr
routine = analytical.F (ana_smflux)
ANA_SPFLUX
Option to set passive tracers surface flux with analytical expressions (usually zero, no flux).
variable = stflx(:,:,NAT+1:NT(ng))
related = BIOLOGY, SEDIMENT
routine = analytical.F (ana_spflux)
ANA_SPINNING
Option to set time-variable rotation force as the sum of Coriolis and centripetal accelerations. This option is used in polar coordinates (annulus grid) applications.
variable = f, fomn
related = LAB_CANYON
routine = analytical.F (ana_spinning)
ALBEDO
Option to set kinematic, surface solar shortwave radiation flux with an analytical expression.
variable = srflx
related = ALBEDO, DIURNAL_SRFLUX
routine = analytical.F (ana_srflux)
ANA_SSFLUX
Option to set kinematic surface freshwater flux (E-P) using an analytical expression.
variable = stflx(:,:,isalt)
parent = SOLVE3D
related = ANA_SPFLUX, ANA_STFLUX
conflict = EMINUSP
routine =
ANA_SSH
Option to set sea surface height climatology with an analytical expression.
variable = ssh
required = ZCLIMATOLOGY
routine = analytical.F (ana_ssh)
ANA_SSS
Option to set sea surface salinity with an analytical expression.
variable = sss
required = SALINITY
related = SCORRECTION, SRELAXATION
routine = analytical.F (ana_sss)
ANA_SST
Option to set sea surface temperature with an analytical expression. It also sets surface net heat flux sensitivity to sea surface temperature. Both fields are used for surface net heat flux correction.
variable = dqdt, sst
related = QCORRECTION
routine = analytical.F (ana_sst), set_vbc.F
ANA_STFLUX
Option to set kinematic surface net flux of tracers using analytical expressions.
variable = stflx(:,:,1:NT)
parent = SOLVE3D
related = ANA_SPFLUX, ANA_SSFLUX
conflict =
routine =
ANA_TAIR
Option to set surface air temperature with an analytical expression
variable = Tair
parent = SOLVE3D
required = ALBEDO, BULK_FLUXES, ECOSIM
related = ANA_SRFLUX
routine = analytical.F (ana_tair)
ANA_TCLIMA
Option to set tracer climatology with analytical expressions.
variable = tclm
parent = SOLVE3D
required = TCLIMATOLOGY
related = TCLM_NUDGING
routine = analytical.F (ana_tclima)
ANA_TOBC
Option to set tracers open boundary conditions using analytical expressions.
variable = t_east, t_north, t_south, t_west
required = OBC
routine = analytical.F (ana_tobc)
ANA_VMIX
Option to set vertical mixing coefficients for momentum and tracers with analytical expressions.
variable = Akt(:,:,:,1:NAT), Akv
parent = SOLVE3D
conflict = BVF_MIXING, GLS_MIXING, LMD_MIXING, MY25_MIXING
routine = analytical.F (ana_vmix)
ANA_WINDS
Option to set surface wind vector components with analytical expressions.
variable = Uwind, Vwind
required = BULK_FLUXES, ECOSIM
routine = analytical.F (ana_winds)
ANA_WWAVE
Option to set wind-induced wave fields with analytical expressions. It currently, sets values for wave direction, height, length, top and bottom periods, and dissipation.
variable = Dwave, Hwave, Lwave, Pwave_top, Pwave_bot, wave_dissip
required = BBL_MODEL
related = WAVES_HEIGHT, WAVES_LENGTH, WAVES_TOP_PERIOD, WAVES_BOT_PERIOD
related = TKE_WAVEDISS
routine = analytical.F (ana_wwave)
ASSIMILATION
Internal option defined when any of the optimal interpolation assimilation options is activated.
related = ASSIMILATION_SSH, ASSIMILATION_SST, ASSIMILATION_T, ASSIMILATION_UV, ASSIMILATION_UVsur
conflict = NUDGING, IS4DVAR, S4DVAR, W4DPSAS, W4DVAR
routine = globaldefs.h
ASSIMILATION_SSH
Option to assimilate sea surface height observations (altimetry) using optimal interpolation.
variable = EdatSSH, EobsSSH, SSHdat, SSHobs
parent = ASSIMILATION
related = ASSIMILATION_SST, ASSIMILATION_T, ASSIMILATION_UV, ASSIMILATION_UVsur
conflict = NUDGING_SSH
routine = oi_update.F
ASSIMILATION_SST
Option to assimilate sea surface temperature observations using optimal interpolation.
variable = EdatSST, EobsSST, SSTdat, SSTobs
parent = ASSIMILATION
related = ASSIMILATION_SSH, ASSIMILATION_T, ASSIMILATION_UV, ASSIMILATION_UVsur
conflict = NUDGING_SST
routine = oi_update.F
ASSIMILATION_T
Option to assimilate tracer-type observations (temperature, salinity) using optimal interpolation.
variable = EdatT, EobsT, Tdat, Tobs
parent = ASSIMILATION
related = ASSIMILATION_SSH, ASSIMILATION_SST, ASSIMILATION_UV, ASSIMILATION_UVsur
conflict = NUDGING_T
routine = oi_update.F
ASSIMILATION_UV
Option to assimilate 3D momentum (u,v) observations using optimal interpolation.
variable = EdatUV, EobsUV, UVdat, UVobs
parent = ASSIMILATION
related = ASSIMILATION_SSH, ASSIMILATION_SST, ASSIMILATION_T, ASSIMILATION_UVsur
conflict = NUDGING_UV
routine = oi_update.F
ASSIMILATION_UVsur
Option to assimilate surface momentum (u,v) observations (CODAR) using optimal interpolation.
variable = EdatVsur, EobsVsur, Usurdat, Usur, Vsurdat, Vsur
parent = ASSIMILATION
related = ASSIMILATION_SSH, ASSIMILATION_SST, ASSIMILATION_T, ASSIMILATION_UV
conflict = NUDGING_UVsur
routine = oi_update.F
ASSUMED_SHAPE
Internal option to declare all global arrays as assumed-shape where their size, bounds, and shape are associated with pointers. Imported arrays with dummy arguments that takes the shape of the actual argument passes to it. If not activated, all the arrays are of explicit-shape. In some computers the explicit-shape arrays slow doen performace because the arrays are copied when passed as argument.
routine = globaldefs.h
AVERAGES
Option to write out time-averaged fields into output NetCDF file.
parameter = nAVG, ndefAVG, ntsAVG
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_AKS
Option to write out time-averaged vertical diffusion of salinity into output NetCDF file. Use this option when any of the vertical mixing parameterizations is activated.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES
related = AVERAGES_AKT, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_AKT
Option to write out time-averaged vertical diffusion of temperature into output NetCDF file. Use this option when any of the vertical mixing parameterizations is activated.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES
related = AVERAGES_AKS, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_AKV
Option to write out time-averaged vertical viscosity into output NetCDF file. Use this option when any of the vertical mixing parameterizations is activated.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_BEDLOAD
Option to write out time-averaged bed load components into output NetCDF file.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES, BEDLOAD, SEDIMENT
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_AKV, AVERAGES_FLUXES, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_FLUXES
Option to write out time-averaged surface momentum stress and several fields associated with surface heat and freshwater fluxes.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_NEARSHORE, AVERAGES_QUADRATIC, BULK_FLUXES
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_NEARSHORE
Option to write out time-averaged nearshore stresses variables.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES, NEARSHORE_MELLOR
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_QUADRATIC
routine = def_avg.F, set_avg.F, wrt_AVG.F
AVERAGES_QUADRATIC
Option to write out time-averaged variables needed to compute eddy fluxes. These quadratic variables include <H u / n>, <H v / m>, <H u T / n>, <H v T / m>, <T T>, <u T>, <v T>, <u u>, <v v>, <ubar ubar>, <vbar vbar>, and <zeta zeta>.
parameter = nAVG, ndefAVG, ntsAVG
parent = AVERAGES
required = AVERAGES
related = AVERAGES_AKS, AVERAGES_AKT, AVERAGES_AKV, AVERAGES_BEDLOAD, AVERAGES_FLUXES, AVERAGES_NEARSHORE
routine = def_avg.F, set_avg.F, wrt_AVG.F
A4DVAR_TOY
Idealized data assimilation example to run 4DVar weak constraint data assimilation algorithms.
parameter = Ninner, Nouter
required = W4DPSAS or W4DVAR
related = CONVOLVE, RPM_RELAXATION
routine = s4dvar.in, w4dpsas_ocean, w4dvar_ocean.h

B

BACKGROUND
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BALANCE_OPERATOR
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BASIN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BEDLOAD
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BENCHMARK1
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BENCHMARK2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BENCHMARK3
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BIOLOGY
Internal option defined when any of the biological models is activated.
related = BIO_FASHAM, ECOSIM, NEMURO, NPZD_FRANKS, NPZD_POWELL
routine = biology.F
BIO_FASHAM
Option to activate Fasham-type, nitrogen-based biological model (Fasham et al., 1990; Fennel et al., 2006)
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX, BIO_SEDIMENT, CARBON, DENITRIFICATION, DIAGNOSTICS_BIO, OXYGEN, TALK_PROGNOSTIC
conflict = ECOSIM, NEMURO, NPZD_FRANKS, NPZD_POWELL
routine = fasham.h
input = bioFasham.in
BIO_SEDIMENT
Option to restore fallen particulate material to the nutrient pool in Fasham-type model.
parent = BIO_FASHAM
routine = fasham.h
BIO_TOY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BL_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BODYFORCE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BULK_FLUXES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
BVF_MIXING
Option to
parameter =
parent =
required =
related =
conflict =
routine =

C

CANUTO_A
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CANUTO_B
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CANYON
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CARBON
Option to include carbon constituents in Fasham-type biological model. Currently, four carbon-based tracer are added to include large detritus (iLDeC), small detritus (iSDeC), total inorganic carbon (iTIC_), and total alkalinity (iTAlk).
parent = BIO_FASHAM
required = OXYGEN
routine = fasham.h
CELERITY_READ
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CELERITY_WRITE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CHARNOK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CHECKPOINTING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CLOUDS
Internal option indicating that cloud data is needed.
required = ALBEDO, ECOSIM, LONGWAVE
related = BULK_FLUXES, ANA_SRFLUX
routine = globaldefs.h
CONVOLUTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CONVOLVE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
COOL_SKIN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
COUPLING_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CORRELATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
COSINE2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CRAIG_BANNER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CURVGRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =

D

DAMEE_4
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DEBUGGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DENITRIFICATION
Option to include denitrification processes in Fasham-type biological model.
parent = BIO_FASHAM
routine = fasham.h
DIAGNOSTICS
Internal option to compute and write balance term diagnostics for tracers and momentum.
related = DIAGNOSTICS_BIO, DIAGNOSTICS_TS, DIAGNOSTICS_UV
routine = set_diags.F, wrt_diags.F
DIAGNOSTICS_BIO
Option to compute and write biological diagnostic terms in Fasham-type model.
parent = BIO_FASHAM
related = DIAGNOSTICS_TS, DIAGNOSTICS_UV
routine = fasham.h, wrt_diags.F
DIAGNOSTICS_TS
Option to compute and write diagnostic terms for tracer equations balances.
related = DIAGNOSTICS_BIO, DIAGNOSTICS_UV
routine = set_diags.F, step3d_t.F, wrt_diags.F
DIAGNOSTICS_UV
Option to compute and write diagnostic terms for momentum equations balances.
related = DIAGNOSTICS_BIO, DIAGNOSTICS_TS
routine = set_diags.F, step2d.F, step3d_t.F, wrt_diags.F
DIFF_GRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DIURNAL_SRFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DJ_GRADPS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DOUBLE_GYRE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
DOUBLE_PRECISION
Option to
parameter =
parent =
required =
related =
conflict =
routine =

E

EAST_FSCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_FSCHAPMAN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_FSGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_FSNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_FSRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2FLATHER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M2REDUCED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M3CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M3GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M3NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_M3RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_KGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_KRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_TCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_TGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_TNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_TRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EAST_VOLCONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EASTERN_WALL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ECOSIM
Option to activate Bio-optical EcoSim (Bissett et al., 1999a, b) model.
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX
conflict = BIO_FASHAM, NEMURO, NPZD_FRANKS, NPZD_POWELL
routine = ecosim.h
input = ecosim.in
EMINUSP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ENSEMBLE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ENERGY1_NORM
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ENERGY2_NORM
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ENERGY3_NORM
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ESTUARY_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
EW_PERIODIC
Option to
parameter =
parent =
required =
related =
conflict =
routine =

F

FLOATS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FLOAT_VWALK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FLT_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FORCING_SV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FORWARD_MIXING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FORWARD_READ
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FORWARD_RHS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FORWARD_WRITE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FSOBC_REDUCED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FT_EIGENMODES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
FULL_GRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =

G

GLS_MIXING
Option to activate Generic Length Scale vertical mixing parameterization (Warner et al., 2005).
related = CANUTO_A, CANUTO_B
conflict = MY25_MIXING, LMD_MIXING
routine = gls_corstep.F, gls_prestep.F, ocean.in
GRADIENT_CHECK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
GRAV_ADJ
Option to
parameter =
parent =
required =
related =
conflict =
routine =

H

I

ICESHELF
Option to
parameter =
parent =
required =
related =
conflict =
routine =
IMPLICIT_VCONV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
IOM
Option to
parameter =
parent =
required =
related =
conflict =
routine =
IMPULSE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
INLINE_2DIO
Option to
parameter =
parent =
required =
related =
conflict =
routine =
INNER_PRODUCT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
IS4DVAR
Option to
parameter =
parent =
required =
related =
conflict =
routine =

J

K

KANTHA_CLAYSON
Option to
parameter =
parent =
required =
related =
conflict =
routine =
KELVIN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
K_C2ADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
K_C4ADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =

L

LAB_CANYON
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LAKE_SIGNELL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_BKPP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_CONVEC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_DDMIX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_MIXING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_NONLOCAL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_RIMIX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_SKPP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LMD_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LONGWAVE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
LONGWAVE_OUT
Option to
parameter =
parent =
required =
related =
conflict =
routine =

M

MAX_SLOPE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIN_STRAT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
M2CLIMATOLOGY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
M2CLM_NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
M3CLIMATOLOGY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
M3CLM_NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MASKING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MB_BBL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MB_CALC_ZNOT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MB_ZOBIO
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MB_Z0BL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MB_Z0RIP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIX_ISO_TS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIX_ISO_TS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIX_S_TS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIX_GEO_UV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MIX_S_UV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MPI
Option to
parameter =
parent =
required =
related =
conflict =
routine =
MY25_MIXING
Option to
parameter =
parent =
required =
related =
conflict =
routine =

N

NEMURO
Option to activate NEMURO model.
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX
conflict = BIO_FASHAM, ECOSIM, NPZD_FRANKS, NPZD_POWELL
routine = nemuro.h
input = nemuro.in
NLM_OUTER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NONLINEAR
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NONLIN_EOS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_FSCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_FSCHAPMAN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_FSGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_FSNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_FSRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2FLATHER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M2REDUCED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M3CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M3GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M3NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_M3RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_KGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_KRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_TCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_TGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_TNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_TRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTH_VOLCONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NORTHERN_WALL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NO_WRITE_GRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NPZD_FRANKS
Option to activate Franks et al. (1986) NPZD biological model.
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX
conflict = BIO_FASHAM, ECOSIM, NEMURO, NPZD_POWELL
routine = npzd_Franks.h
input = npzd_Franks.in
NPZD_POWELL
Option to activate Powell et al. (2006) NPZD biological model.
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX
conflict = BIO_FASHAM, ECOSIM, NEMURO, NPZD_FRANKS
routine = npzd_Powell.h
input = npzd_Powell.in
NS_PERIODIC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NUDGING_SSH
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NUDGING_SST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NUDGING_T
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NUDGING_UV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
NUDGING_UVsur
Option to
parameter =
parent =
required =
related =
conflict =
routine =
N2NORM_PROFILE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
N2S2_HORAVG
Option to
parameter =
parent =
required =
related =
conflict =
routine =

O

OBC
Internal option indicating open boundary conditions.
related = EAST_FSOBC, EAST_M2OBC, EAST_M3OBC, EAST_TOBC
related = WEST_FSOBC, WEST_M2OBC, WEST_M3OBC, WEST_TOBC
related = NORTH_FSOBC, NORTH_M2OBC, NORTH_M3OBC, NORTH_TOBC
related = SOUTH_FSOBC, SOUTH_M2OBC, SOUTH_M3OBC, SOUTH_TOBC
routine = globaldefs.h
OBSERVATIONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
OCMIP_OXYGEN_SC
Option to use the Keeling et al. (1998) formulae for the Schmit number to model O2 gas exchange. If deactivated, the formulation of Wanninkhof (1992) is used instead.
parent = BIO_FASHAM
required = OXYGEN
routine = fasham.h
OPT_OBSERVATIONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
OPT_PERTURBATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
OUT_DOUBLE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
OVERFLOW
Option to
parameter =
parent =
required =
related =
conflict =
routine =
OXYGEN
Option to include oxygen dynamics in Fasham-type biological model. Currently, an additional tracer is added for dissolved oxygen concentration (iOxyg).
parent = BIO_FASHAM
routine = fasham.h
_OPENMP
Option to
parameter =
parent =
required =
related =
conflict =
routine =

P

PERFECT_RESTART
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PICARD_TEST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PJ_GRADP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PJ_GRADPQ2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PJ_GRADPQ4
Option to
parameter =
parent =
required =
related =
conflict =
routine =
POWER_LAW
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PROFILE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
PSEUDOSPECTRA
Option to
parameter =
parent =
required =
related =
conflict =
routine =

Q

QCORRECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
Q_PSOURCE
Option to activate/deactivate point sources/sinks of momentum. This option is used to specify the mass transport in the vertical, such as precipitation or groundwater discharge.
variable = Dsrc(1:Nsrc), Qsrc(1:Nsrc,k)
related = ANA_PSOURCE, TS_PSOURCE
confict =
routine = step2d.F, step3d_uv.F

R

RADIATION_2D
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RAMP_TIDES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
READ_WATER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RIVERPLUME1
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RIVERPLUME2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RIVER_BIOLOGY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RIVER_SEDIMENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RI_HORAVG
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RI_VERAVG
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RHO_SURF
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RPM_DRIVER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
RST_SINGLE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
R_SYMMETRY
Option to
parameter =
parent =
required =
related =
conflict =
routine =

S

SALINITY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SANITY_CHECK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SCORRECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SEAMOUNT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SEDIMENT
Option to activate cohesive and non-cohesive sediment model (Warner et al., 2006).
related = ANA_BPFLUX, ANA_SEDIMENT, ANA_SPFLUX
related = BEDLOAD, RIVER_SEDIMENT, SED_DENS, SED_MORPH, SUSPLOAD
routine = sediment.F, sediment.in
SED_DENS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SED_MORPH
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SED_TEST1
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SED_TOY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SG_BBL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SG_CALC_SNOT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SG_LOGINT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOLAR_SOURCE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOLITON
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOLVE3D
Option to activate/deactivate 3D model configuration. If activated, ROMS solves 3D (baroclinic) primitive equations. If deactivated, ROMS solves vertically-integrated, shallow water (barotropic) equations.
routine = main2d.F, main3d.F
SOUTH_FSCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_FSCHAPMAN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_FSGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_FSNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_FSRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2FLATHER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M2REDUCED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M3CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M3GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M3NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_M3RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_KGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_KRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_TCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_TGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_TNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_TRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTH_VOLCONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SOUTHERN_WALL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SO_SEMI
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SO_SEMI_WHITE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SO_TRACE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SPLINES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SPHERICAL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SPONGE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SRELAXATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SSH_TIDES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SSW_BBL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SSW_CALC_ZNOT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SSW_LOGINT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
STATIONS
Option to activate writing out station data
parameter =
parent =
required =
related =
conflict =
routine = stations.in
STATIONS_CGRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =
STOCHASTIC_OPT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SUSPLOAD
Option to
parameter =
parent =
required =
related =
conflict =
routine =
S4DVAR
Option to
parameter =
parent =
required =
related =
conflict =
routine =

T

TALK_PROGNOSTIC
Option to activate prognostic computation of alkalinity.
parent = BIO_FASHAM
required = CARBON
routine = fasham.h
TANGENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TCLIMATOLOGY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TCLM_NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TKE_DIF2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TKE_DIF4
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TLM_CHECK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TLM_DRIVER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
THREE_GHOST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TL_IOMS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_MPDATA
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_A4HADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_A4VADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_C2HADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_C2VADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_C4HADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_C4VADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_DIF2
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_DIF4
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_FIXED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_PSOURCE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_SVADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
TS_U3HADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
T_PASSIVE
Option to
parameter =
parent =
required =
related =
conflict =
routine =

U

UPWELLING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
UV_ADV
Option to activate/deactivate horizontal and vertical advection of momentum. If no additional options are specified, the default is to discretize the horizontal momentum with a third-order upstream bias advection scheme with velocity dependent hyper-viscosity and the vertical momentum with a fourth-order, centered differences scheme. Since there is some implicit viscosity associated with the default discretization, the user may avoid adding an explicity vicosity to the solution to suppress excisive smoothing.
routine = step2d.F, rhs3d.F
UV_BAROCLINIC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
UV_COR
Option to activate/deactivate Coriolis acceleration term in momentum equations.
routine = step2d.F, rhs3d.F
UV_C2ADVECTION
Option to use second-order, centered, finite differences in advection of momentum.
parent = UV_ADV
conflit = UV_C4ADVECTION
UV_C4ADVECTION
Option to use fourth-order, centered, finite differences in advection of momentum.
parent = UV_ADV
conflit = UV_C2ADVECTION
UV_LDRAG
Option to activate/deactivate linear bottom friction of momentum.
parameter = rdrg(ng)
confict = BBL_MODEL, UV_LOGDRAG, UV_QDRAG
routine = set_vbc.F
UV_LOGDRAG
Option to activate/deactivate logarithmic bottom friction of momentum.
parameter = Zob(ng)
required = SOLVE3D
confict = BBL_MODEL, UV_LDRAG, UV_QDRAG
routine = set_vbc.F
UV_PSOURCE
Option to activate/deactivate point sources/sinks of momentum. This option is used to specify the mass transport in river runoff.
variable = Dsrc(1:Nsrc), Qsrc(1:Nsrc,k)
related = ANA_PSOURCE, TS_PSOURCE
confict = BBL_MODEL, UV_LOGDRAG, UV_QDRAG
routine = step2d.F, step3d_uv.F
UV_QDRAG
Option to activate/deactivate quadratic bottom friction of momentum.
parameter = rdrg2(ng)
confict = BBL_MODEL, UV_LDRAG, UV_LOGDRAG
routine = set_vbc.F
UV_SADVECTION
Option to use conservative, parabolic splines discretization of momentum vertical advection. This scheme requires high vertical resolution so it is recommended to use this option in shallow, coastal applications.
parent = UV_ADV
conflit = UV_C2ADVECTION, UV_C4ADVECTION
UV_TIDES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
UV_U3HADVECTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
UV_VIS2
Option to activate/deactivate horizontal, harmonic viscosity of momentum. The hamonic mixing of momentum can be applied along terrain-following or geopotential levels. In ROMS, the viscosity is derived from the horizontal divergence of the deviatory stress tensor (Wajsowicz, 1993).
parameter = visc2(ng)
variable = visc2_p(:,:), visc2_r(:,:)
required = MIX_S_UV, MIX_GEO_UV
related = VISC_GRID
routine = uv3dmix2_s.h, uv3dmix2_geo.h, uv3dmix.F
UV_VIS4
Option to activate/deactivate horizontal, biharmonic viscosity of momentum. The bihamonic mixing of momentum can be applied along terrain-following or geopotential levels. In ROMS, the viscosity is derived from the horizontal divergence of the deviatory stress tensor (Wajsowicz, 1993).
parameter = visc4(ng)
variable = visc4_p(:,:), visc4_r(:,:)
required = MIX_S_UV, MIX_GEO_UV
related = VISC_GRID
routine = uv3dmix4_s.h, uv3dmix4_geo.h, uv3dmix.F

V

VAR_RHO_2D
Option to
parameter =
parent =
required =
related =
conflict =
routine =
VCONVOLUTION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
VERIFICATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
VISC_GRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =

W

WEAK_CONSTRAINT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEDDELL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_FSCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_FSCHAPMAN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_FSGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_FSNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_FSRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2FLATHER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M2REDUCED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M3CLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M3GRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M3NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_M3RADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_KGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_KRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_TCLAMPED
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_TGRADIENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_TNUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_TRADIATION
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WEST_VOLCONS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WESTERN_WALL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WET_DRY
Option to activate wetting and drying.
parameter = Dcrit
variable = rmask_wet, umask_wet, vmask_wet
routine = step2d.F
WINDBASIN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WIND_WAVES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WJ_GRADP
Option to
parameter =
parent =
required =
related =
conflict =
routine =
WRITE_WATER
Option to
parameter =
parent =
required =
related =
conflict =
routine =
W4DPSAS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
W4DVAR
Option to
parameter =
parent =
required =
related =
conflict =
routine =

X

Y

Z

ZCLIMATOLOGY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ZCLM_NUDGING
Option to
parameter =
parent =
required =
related =
conflict =
routine =