high_res_cube/code-mods/EXF_OPTIONS.h

C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/EXF_OPTIONS.h,v 1.4 2007/12/23 06:04:43 dimitri Exp $
C $Name:  $

#ifndef EXF_OPTIONS_H
#define EXF_OPTIONS_H
#include "PACKAGES_CONFIG.h"
#include "AD_CONFIG.h"

#ifdef ALLOW_EXF

#include "CPP_OPTIONS.h"

#ifdef ALLOW_AUTODIFF_TAMC

C When compile for AD mode,
C this package is currently configured by ECCO_CPPOPTIONS.h
C which is directly included in CPP_OPTIONS.h

#else /* ndef ALLOW_AUTODIFF_TAMC */

C CPP flags controlling which code is included in the files that
C will be compiled.
C

c   pkg/exf CPP options:
c   --------------------
c
c   >>> EXF_VERBOSE <<<
c       Do a bit more printout for the log file than usual.
c
c   >>> ALLOW_ATM_WIND <<<
c       If defined, 10-m wind fields can be read-in from files.
c
c   >>> ALLOW_ATM_TEMP <<<
c       If defined, atmospheric temperature and specific
c       humidity fields can be read-in from files.
c
c   >>> ALLOW_DOWNWARD_RADIATION <<<
c       If defined, downward long-wave and short-wave radiation
c       can be read-in form files or computed from lwflux and swflux.
c
c   >>> ALLOW_ZENITHANGLE <<<
c       If defined, ocean albedo varies with the zenith angle, and
c       incoming fluxes at the top of the atmosphere are computed
c
c   >>> ALLOW_BULKFORMULAE <<<
c       Allows the use of bulk formulae in order to estimate
c       turbulent and radiative fluxes at the ocean surface.
c
c   >>> EXF_READ_EVAP <<<
c       If defined, evaporation fields are read-in, rather than
c       computed from atmospheric state.
c
c   >>> ALLOW_RUNOFF <<<
c       If defined, river and glacier runoff can be read-in from files.
c
c   >>> ATMOSPHERIC_LOADING <<<
c       If defined, atmospheric pressure can be read-in from files.
c   WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
c            and cannot be changed here (in EXF_OPTIONS)
c
c   >>> ICE_AREAMASK <<<
c       If defined, fractional ice-covered area MASK can be read-in from files.
c
c   >>> ALLOW_CLIMSST_RELAXATION <<<
c       Allow the relaxation to a monthly climatology of sea surface
c       temperature, e.g. the Reynolds climatology.
c
c   >>> ALLOW_CLIMSSS_RELAXATION <<<
c       Allow the relaxation to a monthly climatology of sea surface
c       salinity, e.g. the Levitus climatology.
c
c   >>> USE_EXF_INTERPOLATION <<<
c       Allows specification of arbitrary Cartesian input grids.
c
c   ====================================================================
c
c       The following CPP options:
c
c          ALLOW_ATM_WIND              (WIND)
c          ALLOW_ATM_TEMP              (TEMP)
c          ALLOW_DOWNWARD_RADIATION    (DOWN)
c          ALLOW_BULKFORMULAE          (BULK)
c          EXF_READ_EVAP               (EVAP)
c
c       permit the ocean-model forcing configurations listed in the
c       table below.  The first configuration is the default,
c       flux-forced, ocean model.  The next four are stand-alone
c       configurations that use pkg/exf, open-water bulk formulae to
c       compute the missing surface fluxes from atmospheric variables.
c       The last four configurations can be used in conjunction with
c       pkg/seaice to model ice-covered regions.  The forcing fields
c       in the rightmost column are defined in exf_fields.
c
c
c    WIND |TEMP |DOWN |BULK |EVAP |            actions
c    -----|-----|-----|-----|-----|-------------------------------------
c         |     |     |     |     |
c      -  |  -  |  -  |  -  |  -  | Read-in ustress, vstress, hflux,
c         |     |     |     |     | swflux, and sflux.
c         |     |     |     |     |
c     def | def | def | def |  -  | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swdown, lwdown, precip, and runoff.
c         |     |     |     |     | Compute ustress, vstress, hflux,
c         |     |     |     |     | swflux, and sflux.
c         |     |     |     |     |
c     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swflux, lwflux, precip, and runoff.
c         |     |     |     |     | Compute ustress, vstress, hflux,
c         |     |     |     |     | and sflux.
c         |     |     |     |     |
c     def |  -  |  -  | def |  -  | Read-in uwind, vwind, hflux,
c         |     |     |     |     | swflux, and sflux.
c         |     |     |     |     | Compute ustress and vstress.
c         |     |     |     |     |
c      -  | def |  -  | def |  -  | Read-in ustress, vstress, atemp,
c         |     |     |     |     | aqh, swflux, lwflux, precip, and
c         |     |     |     |     | runoff.  Compute hflux and sflux.
c         |     |     |     |     |
c     def | def |  -  |  -  | def | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swflux, lwflux, precip, runoff,
c         |     |     |     |     | and evap.
c         |     |     |     |     |
c     def | def |  -  | def |  -  | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swflux, lwflux, precip, and runoff.
c         |     |     |     |     | Compute open-water ustress, vstress,
c         |     |     |     |     | hflux, swflux, and evap.
c         |     |     |     |     |
c     def | def | def |  -  | def | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swdown, lwdown, precip, runoff,
c         |     |     |     |     | and evap.
c         |     |     |     |     |
c     def | def | def | def |  -  | Read-in uwind, vwind, atemp, aqh,
c         |     |     |     |     | swdown, lwdown, precip, and runoff.
c         |     |     |     |     | Compute open-water ustress, vstress,
c         |     |     |     |     | hflux, swflux, and evap.
c
c   ====================================================================

C   Do more printout for the protocol file than usual.
#undef EXF_VERBOSE

C   Bulk formulae related flags.
#define  ALLOW_ATM_TEMP
#define  ALLOW_ATM_WIND
#define  ALLOW_DOWNWARD_RADIATION
#define  ALLOW_RUNOFF
#if (defined (ALLOW_ATM_TEMP) || \
     defined (ALLOW_ATM_WIND))
# define ALLOW_BULKFORMULAE
# undef ALLOW_BULK_LARGEYEAGER04
#endif

C   Zenith Angle/Albedo related flags.
#ifdef ALLOW_DOWNWARD_RADIATION
# undef ALLOW_ZENITHANGLE
#endif

C   Relaxation to monthly climatologies.
#define ALLOW_CLIMSST_RELAXATION
#define ALLOW_CLIMSSS_RELAXATION

C   Use spatial interpolation to interpolate
C   forcing files from input grid to model grid.
#define USE_EXF_INTERPOLATION
C   runoff is a special case for which one might want to bypass
C   interpolation from an input grid
#ifdef USE_EXF_INTERPOLATION
# undef USE_NO_INTERP_RUNOFF
#endif

#define EXF_INTERP_USE_DYNALLOC
#if ( defined (EXF_INTERP_USE_DYNALLOC) & defined (USING_THREADS) )
# define EXF_IREAD_USE_GLOBAL_POINTER
#endif

#endif /* ndef ALLOW_AUTODIFF_TAMC */
#endif /* ALLOW_EXF */
#endif /* EXF_OPTIONS_H */
1	C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/EXF_OPTIONS.h,v 1.4 2007/12/23 06:04:43 dimitri Exp $
2	C $Name: $
3
4	#ifndef EXF_OPTIONS_H
5	#define EXF_OPTIONS_H
6	#include "PACKAGES_CONFIG.h"
7	#include "AD_CONFIG.h"
8
9	#ifdef ALLOW_EXF
10
11	#include "CPP_OPTIONS.h"
12
13	#ifdef ALLOW_AUTODIFF_TAMC
14
15	C When compile for AD mode,
16	C this package is currently configured by ECCO_CPPOPTIONS.h
17	C which is directly included in CPP_OPTIONS.h
18
19	#else /* ndef ALLOW_AUTODIFF_TAMC */
20
21	C CPP flags controlling which code is included in the files that
22	C will be compiled.
23	C
24
25	c pkg/exf CPP options:
26	c --------------------
27	c
28	c >>> EXF_VERBOSE <<<
29	c Do a bit more printout for the log file than usual.
30	c
31	c >>> ALLOW_ATM_WIND <<<
32	c If defined, 10-m wind fields can be read-in from files.
33	c
34	c >>> ALLOW_ATM_TEMP <<<
35	c If defined, atmospheric temperature and specific
36	c humidity fields can be read-in from files.
37	c
38	c >>> ALLOW_DOWNWARD_RADIATION <<<
39	c If defined, downward long-wave and short-wave radiation
40	c can be read-in form files or computed from lwflux and swflux.
41	c
42	c >>> ALLOW_ZENITHANGLE <<<
43	c If defined, ocean albedo varies with the zenith angle, and
44	c incoming fluxes at the top of the atmosphere are computed
45	c
46	c >>> ALLOW_BULKFORMULAE <<<
47	c Allows the use of bulk formulae in order to estimate
48	c turbulent and radiative fluxes at the ocean surface.
49	c
50	c >>> EXF_READ_EVAP <<<
51	c If defined, evaporation fields are read-in, rather than
52	c computed from atmospheric state.
53	c
54	c >>> ALLOW_RUNOFF <<<
55	c If defined, river and glacier runoff can be read-in from files.
56	c
57	c >>> ATMOSPHERIC_LOADING <<<
58	c If defined, atmospheric pressure can be read-in from files.
59	c WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
60	c and cannot be changed here (in EXF_OPTIONS)
61	c
62	c >>> ICE_AREAMASK <<<
63	c If defined, fractional ice-covered area MASK can be read-in from files.
64	c
65	c >>> ALLOW_CLIMSST_RELAXATION <<<
66	c Allow the relaxation to a monthly climatology of sea surface
67	c temperature, e.g. the Reynolds climatology.
68	c
69	c >>> ALLOW_CLIMSSS_RELAXATION <<<
70	c Allow the relaxation to a monthly climatology of sea surface
71	c salinity, e.g. the Levitus climatology.
72	c
73	c >>> USE_EXF_INTERPOLATION <<<
74	c Allows specification of arbitrary Cartesian input grids.
75	c
76	c ====================================================================
77	c
78	c The following CPP options:
79	c
80	c ALLOW_ATM_WIND (WIND)
81	c ALLOW_ATM_TEMP (TEMP)
82	c ALLOW_DOWNWARD_RADIATION (DOWN)
83	c ALLOW_BULKFORMULAE (BULK)
84	c EXF_READ_EVAP (EVAP)
85	c
86	c permit the ocean-model forcing configurations listed in the
87	c table below. The first configuration is the default,
88	c flux-forced, ocean model. The next four are stand-alone
89	c configurations that use pkg/exf, open-water bulk formulae to
90	c compute the missing surface fluxes from atmospheric variables.
91	c The last four configurations can be used in conjunction with
92	c pkg/seaice to model ice-covered regions. The forcing fields
93	c in the rightmost column are defined in exf_fields.
94	c
95	c
96	c WIND \|TEMP \|DOWN \|BULK \|EVAP \| actions
97	c -----\|-----\|-----\|-----\|-----\|-------------------------------------
98	c \| \| \| \| \|
99	c - \| - \| - \| - \| - \| Read-in ustress, vstress, hflux,
100	c \| \| \| \| \| swflux, and sflux.
101	c \| \| \| \| \|
102	c def \| def \| def \| def \| - \| Read-in uwind, vwind, atemp, aqh,
103	c \| \| \| \| \| swdown, lwdown, precip, and runoff.
104	c \| \| \| \| \| Compute ustress, vstress, hflux,
105	c \| \| \| \| \| swflux, and sflux.
106	c \| \| \| \| \|
107	c def \| def \| - \| def \| - \| Read-in uwind, vwind, atemp, aqh,
108	c \| \| \| \| \| swflux, lwflux, precip, and runoff.
109	c \| \| \| \| \| Compute ustress, vstress, hflux,
110	c \| \| \| \| \| and sflux.
111	c \| \| \| \| \|
112	c def \| - \| - \| def \| - \| Read-in uwind, vwind, hflux,
113	c \| \| \| \| \| swflux, and sflux.
114	c \| \| \| \| \| Compute ustress and vstress.
115	c \| \| \| \| \|
116	c - \| def \| - \| def \| - \| Read-in ustress, vstress, atemp,
117	c \| \| \| \| \| aqh, swflux, lwflux, precip, and
118	c \| \| \| \| \| runoff. Compute hflux and sflux.
119	c \| \| \| \| \|
120	c def \| def \| - \| - \| def \| Read-in uwind, vwind, atemp, aqh,
121	c \| \| \| \| \| swflux, lwflux, precip, runoff,
122	c \| \| \| \| \| and evap.
123	c \| \| \| \| \|
124	c def \| def \| - \| def \| - \| Read-in uwind, vwind, atemp, aqh,
125	c \| \| \| \| \| swflux, lwflux, precip, and runoff.
126	c \| \| \| \| \| Compute open-water ustress, vstress,
127	c \| \| \| \| \| hflux, swflux, and evap.
128	c \| \| \| \| \|
129	c def \| def \| def \| - \| def \| Read-in uwind, vwind, atemp, aqh,
130	c \| \| \| \| \| swdown, lwdown, precip, runoff,
131	c \| \| \| \| \| and evap.
132	c \| \| \| \| \|
133	c def \| def \| def \| def \| - \| Read-in uwind, vwind, atemp, aqh,
134	c \| \| \| \| \| swdown, lwdown, precip, and runoff.
135	c \| \| \| \| \| Compute open-water ustress, vstress,
136	c \| \| \| \| \| hflux, swflux, and evap.
137	c
138	c ====================================================================
139
140	C Do more printout for the protocol file than usual.
141	#undef EXF_VERBOSE
142
143	C Bulk formulae related flags.
144	#define ALLOW_ATM_TEMP
145	#define ALLOW_ATM_WIND
146	#define ALLOW_DOWNWARD_RADIATION
147	#define ALLOW_RUNOFF
148	#if (defined (ALLOW_ATM_TEMP) \|\| \
149	defined (ALLOW_ATM_WIND))
150	# define ALLOW_BULKFORMULAE
151	# undef ALLOW_BULK_LARGEYEAGER04
152	#endif
153
154	C Zenith Angle/Albedo related flags.
155	#ifdef ALLOW_DOWNWARD_RADIATION
156	# undef ALLOW_ZENITHANGLE
157	#endif
158
159	C Relaxation to monthly climatologies.
160	#define ALLOW_CLIMSST_RELAXATION
161	#define ALLOW_CLIMSSS_RELAXATION
162
163	C Use spatial interpolation to interpolate
164	C forcing files from input grid to model grid.
165	#define USE_EXF_INTERPOLATION
166	C runoff is a special case for which one might want to bypass
167	C interpolation from an input grid
168	#ifdef USE_EXF_INTERPOLATION
169	# undef USE_NO_INTERP_RUNOFF
170	#endif
171
172	#define EXF_INTERP_USE_DYNALLOC
173	#if ( defined (EXF_INTERP_USE_DYNALLOC) & defined (USING_THREADS) )
174	# define EXF_IREAD_USE_GLOBAL_POINTER
175	#endif
176
177	#endif /* ndef ALLOW_AUTODIFF_TAMC */
178	#endif /* ALLOW_EXF */
179	#endif /* EXF_OPTIONS_H */