Options: Difference between revisions
From WikiROMS
Jump to navigationJump to search
No edit summary (change visibility) |
No edit summary (change visibility) |
||
| Line 36: | Line 36: | ||
==<span class="alphabet">A</span>== | ==<span class="alphabet">A</span>== | ||
;<span id="ANA_BIOLOGY"></span>'''ANA_BIOLOGY''' | |||
:Option to initialize any of the biological models with analytical expressions. | |||
:'''related = ''' [[#BIOLOGY | BIOLOGY]] | |||
:'''routine = ''' [[analytical.F]] (ana_biology) | |||
;<span id="ANA_BPFLUX"></span>'''ANA_BPFLUX''' | |||
:Option to set passive tracers bottom flux with analytical expressions (usually zero, no flux). | |||
:'''related = ''' [[#BIOLOGY | BIOLOGY]], [[#SEDIMENT | SEDIMENT]] | |||
:'''routine = ''' [[analytical.F]] (ana_bpflux) | |||
;<span id="ANA_SPFLUX"></span>'''ANA_SPFLUX''' | |||
:Option to set passive tracers surface flux with analytical expressions (usually zero, no flux). | |||
:'''related = ''' [[#BIOLOGY | BIOLOGY]], [[#SEDIMENT | SEDIMENT]] | |||
:'''routine = ''' [[analytical.F]] (ana_spflux) | |||
==<span class="alphabet">B</span>== | ==<span class="alphabet">B</span>== | ||
| Line 49: | Line 64: | ||
:'''conflict = ''' [[#ECOSIM | ECOSIM]], [[#NPZD_FRANKS | NPZD_FRANKS]], [[#NPZD_POWELL | NPZD_POWELL]] | :'''conflict = ''' [[#ECOSIM | ECOSIM]], [[#NPZD_FRANKS | NPZD_FRANKS]], [[#NPZD_POWELL | NPZD_POWELL]] | ||
:'''routine = ''' [[fasham.h]], [[bioFasham.in]] | :'''routine = ''' [[fasham.h]], [[bioFasham.in]] | ||
;<span id="BIO_SEDIMENT"></span>'''BIO_SEDIMENT''' | |||
:Option to restore fallen particulate material to the nutrient pool in Fasham-type model. | |||
:'''parent = ''' [[#BIO_FASHAM | BIO_FASHAM]] | |||
:'''routine = ''' [[fasham.h]] | |||
==<span class="alphabet">C</span>== | ==<span class="alphabet">C</span>== | ||
;<span id="CARBON"></span>'''CARBON''' | |||
:Option to include carbon constituents in Fasham-type biological model. Currently, four carbon-based tracer are added to include large detritus ([[Variables#iLDeC|iLDeC]]), small detritus ([[Variables#iSDeC|iSDeC]]), total inorganic carbon ([[Variables#iTIC_|iTIC_]]), and total alkalinity ([[Variables#iTAlk|iTAlk]]). | |||
:'''parent = ''' [[#BIO_FASHAM | BIO_FASHAM]] | |||
:'''routine = ''' [[fasham.h]] | |||
==<span class="alphabet">D</span>== | ==<span class="alphabet">D</span>== | ||
;<span id="DENITRIFICATION"></span>'''DENITRIFICATION''' | |||
:Option to include denitrification processes in Fasham-type biological model. | |||
:'''parent = ''' [[#BIO_FASHAM | BIO_FASHAM]] | |||
:'''routine = ''' [[fasham.h]] | |||
;<span id="DIAGNOSTICS"></span>'''DIAGNOSTICS''' | |||
:Internal option to compute and write balance term diagnostics for tracers and momentum. | |||
:'''related = ''' [[#DIAGNOSTICS_BIO | DIAGNOSTICS_BIO]], [[#DIAGNOSTICS_TS | DIAGNOSTICS_TS]], [[#DIAGNOSTICS_UV | DIAGNOSTICS_UV]] | |||
:'''routine = ''' [[set_diags.F]], [[wrt_diags.F]] | |||
;<span id="DIAGNOSTICS_BIO"></span>'''DIAGNOSTICS_BIO''' | |||
:Option to compute and write biological diagnostic terms in Fasham-type model. | |||
:'''parent = ''' [[#BIO_FASHAM | BIO_FASHAM]] | |||
:'''related = ''' [[#DIAGNOSTICS | DIAGNOSTICS]] | |||
:'''routine = ''' [[fasham.h]], [[wrt_diags.F]] | |||
;<span id="DIAGNOSTICS_TS"></span>'''DIAGNOSTICS_TS''' | |||
:Option to compute and write diagnostic terms for tracer equations balances. | |||
:'''related = ''' [[#DIAGNOSTICS_BIO | DIAGNOSTICS_BIO]], [[#DIAGNOSTICS_UV | DIAGNOSTICS_UV]] | |||
:'''routine = ''' [[set_diags.F]], [[step3d_t.F]], [[wrt_diags.F]] | |||
;<span id="DIAGNOSTICS_UV"></span>'''DIAGNOSTICS_UV''' | |||
:Option to compute and write diagnostic terms for momentum equations balances. | |||
:'''related = ''' [[#DIAGNOSTICS_BIO | DIAGNOSTICS_BIO]], [[#DIAGNOSTICS_TS | DIAGNOSTICS_TS]] | |||
:'''routine = ''' [[set_diags.F]], [[step2d.F]], [[step3d_t.F]], [[wrt_diags.F]] | |||
==<span class="alphabet">E</span>== | ==<span class="alphabet">E</span>== | ||
Revision as of 03:38, 17 November 2006
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.
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
- 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_SPFLUX
- Option to set passive tracers surface flux with analytical expressions (usually zero, no flux).
- related = BIOLOGY, SEDIMENT
- routine = analytical.F (ana_spflux)
B
- 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
C
- 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
- routine = fasham.h
D
- 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
- 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
E
- ECOSIM
- Option to activate Bio-optical EcoSim (Bisset et al., 1999a, b) model.
- related = ANA_BIOLOGY, ANA_BPFLUX, ANA_SP_FLUX
- conflict = BIO_FASHAM, NPZD_FRANKS, NPZD_POWELL
- routine = ecosim.h, ecosim.in
F
G
H
I
J
K
L
M
N
- NPZ_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
- NPZ_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
O
P
Q
R
S
- 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.
T
U
- 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_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_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_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(:,:)
- related = MIX_S_UV, MIX_GEO_UV, 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(:,:)
- related = MIX_S_UV, MIX_GEO_UV, VISC_GRID
- routine = uv3dmix4_s.h, uv3dmix4_geo.h, uv3dmix.F
- UV_LOGDRAG
- Option to activate/deactivate logarithmic bottom friction of momentum.
- parameter = Zob(ng)
- related = SOLVE3D
- confict = BBL_MODEL, UV_LDRAG, UV_QDRAG
- routine = set_vbc.F
- 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_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
