Options

From WikiROMS
Revision as of 21:16, 23 November 2006 by Arango (talk | contribs)
Jump to navigationJump to search

CPP Options

This wikipage includes all ROMS CPP options in alphabetic order. A single long page is built to facilitate printing. Each option has a unique anchor tag to facilitate linking from any wikipage. The following attributes have been identified to aid in the description of ROMS CPP options:

  • conflit: indicates mutually exclusive options.
  • parameter: important standard input parameter(s) or state array(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.


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.
parameter = ssh, zeta_east, zeta_north, zeta_south, zeta_west
required = SSH_TIDES
related = EAST_FSOBC, NORTH_FSOBC, SOUTH_FSOBC, WEST_FSOBC, M2CLIMATOLOGY
routine = set_tides.F
ADD_M2OBC
Option to add tidal currents to 2D momentum climatology, if any, and open boundary conditions data.
parameter = ubarclm, ubar_east, ubar_north, ubar_south, ubar_west, vbarclm, vbar_east, vbar_north, vbar_south, vbar_west
required = UV_TIDES
related = EAST_M2OBC, NORTH_M2OBC, SOUTH_M2OBC, WEST_M2OBC, M2CLIMATOLOGY
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
parameter =
parent =
required =
related =
conflict =
routine =
ALBEDO
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_BIOLOGY
Option to initialize any of the biological models with analytical expressions.
related = BIOLOGY
routine = analytical.F (ana_biology)
ANA_BPFLUX
Option to set passive tracers bottom flux with analytical expressions (usually zero, no flux).
related = BIOLOGY, SEDIMENT
routine = analytical.F (ana_bpflux)
ANA_BSFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_BTFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_CLOUD
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_DIAG
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_FSOBC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_GRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_HUMIDITY
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_INITIAL
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_M2CLIMA
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_M2OBC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_M3CLIMA
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_M3OBC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_MASK
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_PAIR
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_PASSIVE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_PERTURB
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_PSOURCE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_RAIN
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SEDIMENT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SMFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SPFLUX
Option to set passive tracers surface flux with analytical expressions (usually zero, no flux).
related = BIOLOGY, SEDIMENT
routine = analytical.F (ana_spflux)
ANA_SPINNING
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SSH
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SSS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_SSFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_STFLUX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_TCLIMA
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_TOBC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_VMIX
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_WINDS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ANA_WWAVE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSIMILATION_SSH
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSIMILATION_SST
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSIMILATION_T
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSIMILATION_UV
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSIMILATION_UVsur
Option to
parameter =
parent =
required =
related =
conflict =
routine =
ASSUMED_SHAPE
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES_AKS
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES_AKT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES_BEDLOAD
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES_FLUXES
Option to
parameter =
parent =
required =
related =
conflict =
routine =
AVERAGES_QUADRATIC
Option to
parameter =
parent =
required =
related =
conflict =
routine =
A4DVAR_TOY
Option to
parameter =
parent =
required =
related =
conflict =
routine =

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, 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, NPZD_FRANKS, NPZD_POWELL
routine = fasham.h, 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_A
Option to
parameter =
parent =
required =
related =
conflict =
routine =
CANYON_B
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 =
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, NPZD_FRANKS, NPZD_POWELL
routine = ecosim.h, 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

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, NPZD_POWELL
routine = npzd_Franks.h, npzd_Franks.in
NPZD_POWELL
Option to activate Powell et al. (1986) NPZD biological model.
related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SPFLUX
conflict = BIO_FASHAM, ECOSIM, NPZD_FRANKS
routine = npzd_Powell.h, 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

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

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 =

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, 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
parameter =
parent =
required =
related =
conflict =
routine =
STATIONS_CGRID
Option to
parameter =
parent =
required =
related =
conflict =
routine =
STOCHASTIC_OPT
Option to
parameter =
parent =
required =
related =
conflict =
routine =
S4DVAR
Option to
parameter =
parent =
required =
related =
conflict =
routine =
SUSPLOAD
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.
parameter = 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), 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), 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 =
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 =
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 =
Retrieved from "https://www.myroms.org/wiki/index.php?title=Options&oldid=1917"