Difference between revisions of "Functionals"

From WikiROMS
Jump to navigationJump to search
Line 13: Line 13:
<section begin=ana_btflux.h />;<span id="ana_btflux.h"></span>[[ana_btflux.h]]
<section begin=ana_btflux.h />;<span id="ana_btflux.h"></span>[[ana_btflux.h]]
:For providing analytic bottom flux on tracers (usually zero).
:For providing analytic bottom flux on tracers (usually zero).
:'''cpp flag = '''[[Options#ANA_BTFLUX | ANA_BTFLUX]] <section end=ana_btflux.h />
:'''cpp flag = '''[[Options#ANA_BTFLUX | ANA_BTFLUX]]
:'''cpp flag = '''[[Options#SEDIMENT | SEDIMENT]] <section end=ana_btflux.h />


<section begin=ana_cloud.h />;<span id="ana_cloud.h"></span>[[ana_cloud.h]]
<section begin=ana_cloud.h />;<span id="ana_cloud.h"></span>[[ana_cloud.h]]
:For providing analytic atmospheric cloud fraction.
:For providing analytic atmospheric cloud fraction.
:'''cpp flag = '''[[Options#ANA_CLOUD | ANA_CLOUD]]  <section end=ana_cloud.h />
:'''cpp flag = '''[[Options#ANA_CLOUD | ANA_CLOUD]]
:'''cpp flag = '''[[Options#CLOUDS | CLOUDS]]  <section end=ana_cloud.h />
 
<section begin=ana_diag.h />;<span id="ana_diag.h"></span>[[ana_diag.h]]
:For providing specialized diagnostics during runtime.
:'''cpp flag = '''[[Options#ANA_DIAG | ANA_DIAG]]  <section end=ana_diag.h />
 
<section begin=ana_fsobc.h />;<span id="ana_fsobc.h"></span>[[ana_fsobc.h]]
:For providing analytic free surface boundary conditions.
:'''cpp flag = '''[[Options#ANA_FSOBC | ANA_FSOBC]]  <section end=ana_fsobc.h />
 
<section begin=ana_grid.h />;<span id="ana_grid.h"></span>[[ana_grid.h]]
:For providing analytic grid information.
:'''cpp flag = '''[[Options#ANA_GRID | ANA_GRID]]  <section end=ana_grid.h />
 
<section begin=ana_hmixcoef.h />;<span id="ana_hmixcoef.h"></span>[[ana_hmixcoef.h]]
:For providing analytic atmospheric cloud fraction.
:'''cpp flag = '''[[Options#VISC_GRID | VISC_GRID]]
:'''cpp flag = '''[[Options#DIFF_GRID | DIFF_GRID]]
:'''cpp flag = '''[[Options#SPONGE | SPONGE]] <section end=ana_hmixcoef.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_initial.h />;<span id="ana_initial.h"></span>[[ana_initial.h]]
:For providing analytic initial conditions.
:'''cpp flag = '''[[Options#ANA_INITIAL | ANA_INITIAL]]  <section end=ana_initial.h />
 
<section begin=ana_m2clima.h />;<span id="ana_m2clima.h"></span>[[ana_m2clima.h]]
:For providing analytic 2-D momentum climatology.
:'''cpp flag = '''[[Options#ANA_M2CLIMA | ANA_m2CLIMA]]
:'''cpp flag = '''[[Options#M2CLIMATOLOGY | M2CLIMATOLOGY]]  <section end=ana_m2clima.h />
 
<section begin=ana_m2obc.h />;<span id="ana_m2obc.h"></span>[[ana_m2obc.h]]
:For providing analytic 2-D momentum open boundary conditions.
:'''cpp flag = '''[[Options#ANA_M2OBC | ANA_M2OBC]]  <section end=ana_m2obc.h />
 
<section begin=ana_m3clima.h />;<span id="ana_m3clima.h"></span>[[ana_m3clima.h]]
:For providing analytic 3-D momentum climatology.
:'''cpp flag = '''[[Options#ANA_M3CLIMA | ANA_M3CLIMA]]  <section end=ana_m3clima.h />
 
<section begin=ana_m3obc.h />;<span id="ana_m3obc.h"></span>[[ana_m3obc.h]]
:For providing analytic 3-D momentum open boundary conditions.
:'''cpp flag = '''[[Options#ANA_M3OBC | ANA_M3OBC]]  <section end=ana_m3obc.h />
 
<section begin=ana_mask.h />;<span id="ana_mask.h"></span>[[ana_mask.h]]
:For providing analytic land masks.
:'''cpp flag = '''[[Options#ANA_GRID | ANA_GRID]]
:'''cpp flag = '''[[Options#MASKING | MASKING]]  <section end=ana_mask.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />
 
<section begin=ana_humid.h />;<span id="ana_humid.h"></span>[[ana_humid.h]]
:For providing analytic atmospheric humidity.
:'''cpp flag = '''[[Options#ANA_HUMID | ANA_HUMID]]  <section end=ana_humid.h />






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_mask.h
ana_nudgcoef.h
ana_nudgcoef.h

Revision as of 23:42, 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
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 providing analytic atmospheric cloud fraction.
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_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID
ana_humid.h
For providing analytic atmospheric humidity.
cpp flag = ANA_HUMID


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