Functionals

From WikiROMS
Jump to: navigation, search
Functionals

The directory ROMS/Functionals contains the source file analytical.F as well as a number of files of the form ana_xxx.h. Each of these include files contains the analytic expressions for its respective functionality. For instance, a simple box grid can be represented analytically internal to the model more easily than preparing a grid file with some outside program. Those expressions will be found inside ana_grid.h. The version of ana_grid.h found in the ROMS/Functionals directory contains everything for the example problems distributed with ROMS (unless it requires an external grid file). If you choose to build analytic grids for your own applications, it is recommended that you use that in User/Functionals instead, or provide a version in some third location pointed to by MY_ANALYTICAL_DIR.

Include files

ana_biology.h
For providing analytic initial conditions for the biological tracers.
cpp flag = ANA_BIOLOGY
ana_bmflux.h
For providing spacially varying roughness (z0) for bottom momentum stresses.
cpp flag = ANA_BMFLUX
ana_btflux.h
For providing analytic bottom flux on tracers (usually zero).
cpp flag = ANA_BTFLUX
cpp flag = SEDIMENT
ana_cloud.h
For providing analytic atmospheric cloud fraction.
cpp flag = ANA_CLOUD
cpp flag = CLOUDS
ana_diag.h
For providing specialized diagnostics during runtime.
cpp flag = ANA_DIAG
ana_fsobc.h
For providing analytic free surface boundary conditions.
cpp flag = ANA_FSOBC
ana_grid.h
For providing analytic grid information.
cpp flag = ANA_GRID
ana_hmixcoef.h
For rescaling horizontal mixing coefficients according to the grid size.
cpp flag = VISC_GRID
cpp flag = DIFF_GRID
cpp flag = SPONGE
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_initial.h
For providing analytic initial conditions.
cpp flag = ANA_INITIAL
ana_m2clima.h
For providing analytic 2-D momentum climatology.
cpp flag = ANA_M2CLIMA
cpp flag = M2CLIMATOLOGY
ana_m2obc.h
For providing analytic 2-D momentum open boundary conditions.
cpp flag = ANA_M2OBC
ana_m3clima.h
For providing analytic 3-D momentum climatology.
cpp flag = ANA_M3CLIMA
ana_m3obc.h
For providing analytic 3-D momentum open boundary conditions.
cpp flag = ANA_M3OBC
ana_mask.h
For providing analytic land masks.
cpp flag = ANA_GRID
cpp flag = MASKING
ana_nudgcoef.h
For providing analytic nudging coefficient timescales.
cpp flag = NUDGING_COFF
ana_pair.h
For providing analytic atmospheric pressure.
cpp flag = ANA_PAIR
ana_passive.h
For providing analytic passive tracer initial conditions.
cpp flag = ANA_PASSIVE
cpp flag = T_PASSIVE
ana_perturb.h
For providing perturbations to the initial conditions.
cpp flag = ANA_PERTURB
ana_psource.h
For providing analytic point source parameters.
cpp flag = ANA_PSOURCE
cpp flag = TS_PSOURCE
cpp flag = UV_PSOURCE
ana_rain.h
For providing analytic atmospheric rainfall rates.
cpp flag = ANA_RAIN
ana_scope.h
For providing analytic adjoint sensitivity spatial scope masking arrays.
cpp flag = ANA_GRID
ana_sediment.h
For providing analytic initial conditions for the sediments and bed conditions.
cpp flag = ANA_SEDIMENT
ana_smflux.h
For providing analytic surface momentum flux (wind stress).
cpp flag = ANA_SMFLUX
ana_specir.h
For providing analytic calculation of spectral downwelling irradiance.
cpp flag = ECOSIM
ana_spinning.h
For providing analytic time variable rotation forces.
cpp flag = ANA_SPINNING
ana_srflux.h
For providing analytic incoming shortwave radiation.
cpp flag = ANA_SRFLUX
cpp flag = DIURNAL_SRFLUX
ana_ssh.h
For providing analytic sea surface height climatology.
cpp flag = ANA_SSH
cpp flag = ZCLIMATOLOGY
ana_sss.h
For providing analytic sea surface salinity.
cpp flag = ANA_SSS
cpp flag = SALINITY
cpp flag = SCORRECTION
cpp flag = SRELAXATION
ana_sst.h
For providing analytic atmospheric rainfall rates.
cpp flag = ANA_SST
cpp flag = QCORRECTION
ana_stflux.h
For providing analytic surface tracer fluxes.
cpp flag = ANA_STFLUX
cpp flag = ANA_SSFLUX
cpp flag = ANA_SPFLUX
ana_tair.h
For providing analytic air temperatures.
cpp flag = ANA_TAIR
ana_tclima.h
For providing analytic atmospheric rainfall rates.
cpp flag = ANA_TCLIMA
cpp flag = TCLIMATOLOGY
ana_tobc.h
For providing analytic tracer open boundary conditions.
cpp flag = ANA_TOBC
ana_vmix.h
For providing analytic vertical mixing coefficients.
cpp flag = ANA_VMIX
ana_winds.h
For providing analytic atmospheric winds.
cpp flag = ANA_WINDS
ana_wwave.h
For providing analytic wind-induced surface waves (amplitude, direction, and period).
cpp flag = ANA_WWAVE