Difference between revisions of "Functionals"

From WikiROMS
Jump to navigationJump to search
(First draft)   (change visibility)
 
Line 1: Line 1:
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 they require 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]].
The directory '''ROMS/Functionals''' contains the source file [[Sourc#analytical.F | 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 [[Functionals#ana_grid.h | ana_grid.h]]. The version of [[Functionals#ana_grid.h | 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]].
 
==
 
<section begin=ana_biology.h />;<span id="ana_biology.h"></span>[[ana_biology.h]]
:For providing analytic initial conditions for the biological tracers.
:'''cpp flag = '''[[Options#ANA_BIOLOGY | ANA_BIOLOGY]]  <section end=ana_biology.h />
 
<section begin=ana_bmflux.h />;<span id="ana_bmflux.h"></span>[[ana_bmflux.h]]
:For providing spacially varying roughness (z0) for bottom momentum stresses.
:'''cpp flag = '''[[Options#ANA_BMFLUX | ANA_BMFLUX]]  <section end=ana_bmflux.h />
 
<section begin=ana_btflux.h />;<span id="ana_btflux.h"></span>[[ana_btflux.h]]
:For providing analytic bottom flux on tracers (usually zero).
:'''cpp flag = '''[[Options#ANA_BTFLUX | ANA_BTFLUX]]  <section end=ana_btflux.h />
 
<section begin=ana_cloud.h />;<span id="ana_cloud.h"></span>[[ana_cloud.h]]
:For providing analytic atmospheric cloud fraction.
:'''cpp flag = '''[[Options#ANA_CLOUD | ANA_CLOUD]]  <section end=ana_cloud.h />
 
 


ana_biology.h
ana_bmflux.h
ana_btflux.h
ana_cloud.h
ana_diag.h
ana_diag.h
ana_fsobc.h
ana_fsobc.h

Revision as of 23:24, 4 June 2008

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.

==

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
ana_cloud.h
For providing analytic atmospheric cloud fraction.
cpp flag = ANA_CLOUD


ana_diag.h ana_fsobc.h ana_grid.h ana_hmixcoef.h ana_humid.h ana_initial.h ana_m2clima.h ana_m2obc.h ana_m3clima.h ana_m3obc.h ana_mask.h ana_nudgcoef.h ana_pair.h ana_passive.h ana_perturb.h ana_psource.h ana_rain.h ana_scope.h ana_sediment.h ana_smflux.h ana_specir.h ana_spinning.h ana_srflux.h ana_ssh.h ana_sss.h ana_sst.h ana_stflux.h ana_tair.h ana_tclima.h ana_tobc.h ana_vmix.h ana_winds.h ana_wwave.h