Skip to content

Commit a8dfe25

Browse files
gaelforgetgaelforget
committed
bring up to date (almost...)
1 parent ebfd926 commit a8dfe25

File tree

1 file changed

+134
-115
lines changed

1 file changed

+134
-115
lines changed

‎code/EXF_OPTIONS.h

Lines changed: 134 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -29,137 +29,153 @@ C are specific to this package are assumed to be set in ECCO_CPPOPTIONS.h
2929

3030
C-- Package-specific Options & Macros go here
3131

32-
c pkg/exf CPP options:
33-
c --------------------
34-
c
35-
c > ( EXF_VERBOSE ) < replaced with run-time, logical parameter "exf_verbose".
36-
c
37-
c >>> ALLOW_ATM_WIND <<<
38-
c If defined, 10-m wind fields can be read-in from files.
39-
c
40-
c >>> ALLOW_ATM_TEMP <<<
41-
c If defined, atmospheric temperature and specific
42-
c humidity fields can be read-in from files.
43-
c
44-
c >>> ALLOW_DOWNWARD_RADIATION <<<
45-
c If defined, downward long-wave and short-wave radiation
46-
c can be read-in form files or computed from lwflux and swflux.
47-
c
48-
c >>> ALLOW_ZENITHANGLE <<<
49-
c If defined, ocean albedo varies with the zenith angle, and
50-
c incoming fluxes at the top of the atmosphere are computed
51-
c
52-
c >>> ALLOW_BULKFORMULAE <<<
53-
c Allows the use of bulk formulae in order to estimate
54-
c turbulent and radiative fluxes at the ocean surface.
55-
c
56-
c >>> EXF_READ_EVAP <<<
57-
c If defined, evaporation fields are read-in, rather than
58-
c computed from atmospheric state.
59-
c
60-
c >>> ALLOW_RUNOFF <<<
61-
c If defined, river and glacier runoff can be read-in from files.
62-
c
63-
c >>> ATMOSPHERIC_LOADING <<<
64-
c If defined, atmospheric pressure can be read-in from files.
65-
c WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
66-
c and cannot be changed here (in EXF_OPTIONS)
67-
c
68-
c >>> ICE_AREAMASK <<<
69-
c If defined, fractional ice-covered area MASK can be read-in from files.
70-
c
71-
c >>> ALLOW_CLIMSST_RELAXATION <<<
72-
c Allow the relaxation to a monthly climatology of sea surface
73-
c temperature, e.g. the Reynolds climatology.
74-
c
75-
c >>> ALLOW_CLIMSSS_RELAXATION <<<
76-
c Allow the relaxation to a monthly climatology of sea surface
77-
c salinity, e.g. the Levitus climatology.
78-
c
79-
c >>> USE_EXF_INTERPOLATION <<<
80-
c Allows specification of arbitrary Cartesian input grids.
81-
c
82-
c ====================================================================
83-
c
84-
c The following CPP options:
85-
c
86-
c ALLOW_ATM_WIND (WIND)
87-
c ALLOW_ATM_TEMP (TEMP)
88-
c ALLOW_DOWNWARD_RADIATION (DOWN)
89-
c ALLOW_BULKFORMULAE (BULK)
90-
c EXF_READ_EVAP (EVAP)
91-
c
92-
c permit the ocean-model forcing configurations listed in the
93-
c table below. The first configuration is the default,
94-
c flux-forced, ocean model. The next four are stand-alone
95-
c configurations that use pkg/exf, open-water bulk formulae to
96-
c compute the missing surface fluxes from atmospheric variables.
97-
c The last four configurations can be used in conjunction with
98-
c pkg/seaice to model ice-covered regions. The forcing fields
99-
c in the rightmost column are defined in exf_fields.
100-
c
101-
c
102-
c WIND |TEMP |DOWN |BULK |EVAP | actions
103-
c -----|-----|-----|-----|-----|-------------------------------------
104-
c | | | | |
105-
c - | - | - | - | - | Read-in ustress, vstress, hflux,
106-
c | | | | | swflux, and sflux.
107-
c | | | | |
108-
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
109-
c | | | | | swdown, lwdown, precip, and runoff.
110-
c | | | | | Compute ustress, vstress, hflux,
111-
c | | | | | swflux, and sflux.
112-
c | | | | |
113-
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
114-
c | | | | | swflux, lwflux, precip, and runoff.
115-
c | | | | | Compute ustress, vstress, hflux,
116-
c | | | | | and sflux.
117-
c | | | | |
118-
c def | - | - | def | - | Read-in uwind, vwind, hflux,
119-
c | | | | | swflux, and sflux.
120-
c | | | | | Compute ustress and vstress.
121-
c | | | | |
122-
c - | def | - | def | - | Read-in ustress, vstress, atemp,
123-
c | | | | | aqh, swflux, lwflux, precip, and
124-
c | | | | | runoff. Compute hflux and sflux.
125-
c | | | | |
126-
c def | def | - | - | def | Read-in uwind, vwind, atemp, aqh,
127-
c | | | | | swflux, lwflux, precip, runoff,
128-
c | | | | | and evap.
129-
c | | | | |
130-
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
131-
c | | | | | swflux, lwflux, precip, and runoff.
132-
c | | | | | Compute open-water ustress, vstress,
133-
c | | | | | hflux, swflux, and evap.
134-
c | | | | |
135-
c def | def | def | - | def | Read-in uwind, vwind, atemp, aqh,
136-
c | | | | | swdown, lwdown, precip, runoff,
137-
c | | | | | and evap.
138-
c | | | | |
139-
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
140-
c | | | | | swdown, lwdown, precip, and runoff.
141-
c | | | | | Compute open-water ustress, vstress,
142-
c | | | | | hflux, swflux, and evap.
143-
c
144-
c ====================================================================
32+
C pkg/exf CPP options:
33+
C --------------------
34+
C
35+
C > ( EXF_VERBOSE ) < replaced with run-time, logical parameter "exf_verbose".
36+
C
37+
C >>> ALLOW_ATM_WIND <<<
38+
C If defined, 10-m wind fields can be read-in from files.
39+
C
40+
C >>> ALLOW_ATM_TEMP <<<
41+
C If defined, atmospheric temperature and specific
42+
C humidity fields can be read-in from files.
43+
C
44+
C >>> ALLOW_DOWNWARD_RADIATION <<<
45+
C If defined, downward long-wave and short-wave radiation
46+
C can be read-in form files or computed from lwflux and swflux.
47+
C
48+
C >>> ALLOW_ZENITHANGLE <<<
49+
C If defined, ocean albedo varies with the zenith angle, and
50+
C incoming fluxes at the top of the atmosphere are computed
51+
C
52+
C >>> ALLOW_BULKFORMULAE <<<
53+
C Allows the use of bulk formulae in order to estimate
54+
C turbulent and radiative fluxes at the ocean surface.
55+
C
56+
C >>> EXF_READ_EVAP <<<
57+
C If defined, evaporation fields are read-in, rather than
58+
C computed from atmospheric state.
59+
C
60+
C >>> ALLOW_RUNOFF <<<
61+
C If defined, river and glacier runoff can be read-in from files.
62+
C
63+
C >>> ALLOW_SALTFLX <<<
64+
C If defined, upward salt flux can be read-in from files.
65+
C
66+
C >>> ALLOW_RUNOFTEMP <<<
67+
C If defined, river and glacier runoff temperature
68+
C can be read-in from files.
69+
C
70+
C >>> ATMOSPHERIC_LOADING <<<
71+
C If defined, atmospheric pressure can be read-in from files.
72+
C WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
73+
C and cannot be changed here (in EXF_OPTIONS)
74+
C
75+
C >>> EXF_SEAICE_FRACTION <<<
76+
C If defined, seaice fraction can be read-in from files (areaMaskFile)
77+
C
78+
C >>> ALLOW_CLIMSST_RELAXATION <<<
79+
C Allow the relaxation to a monthly climatology of sea surface
80+
C temperature, e.g. the Reynolds climatology.
81+
C
82+
C >>> ALLOW_CLIMSSS_RELAXATION <<<
83+
C Allow the relaxation to a monthly climatology of sea surface
84+
C salinity, e.g. the Levitus climatology.
85+
C
86+
C >>> USE_EXF_INTERPOLATION <<<
87+
C Allows specification of arbitrary Cartesian input grids.
88+
C
89+
C >>> EXF_CALC_ATMRHO
90+
C Calculate the local atm density as function of temp, humidity
91+
C and pressure
92+
C
93+
C ====================================================================
94+
C
95+
C The following CPP options:
96+
C
97+
C ALLOW_ATM_WIND (WIND)
98+
C ALLOW_ATM_TEMP (TEMP)
99+
C ALLOW_DOWNWARD_RADIATION (DOWN)
100+
C ALLOW_BULKFORMULAE (BULK)
101+
C EXF_READ_EVAP (EVAP)
102+
C
103+
C permit the ocean-model forcing configurations listed in the
104+
C table below. The first configuration is the default,
105+
C flux-forced, ocean model. The next four are stand-alone
106+
C configurations that use pkg/exf, open-water bulk formulae to
107+
C compute the missing surface fluxes from atmospheric variables.
108+
C The last four configurations can be used in conjunction with
109+
C pkg/seaice to model ice-covered regions. The forcing fields
110+
C in the rightmost column are defined in exf_fields.
111+
C
112+
C
113+
C WIND |TEMP |DOWN |BULK |EVAP | actions
114+
C -----|-----|-----|-----|-----|-------------------------------------
115+
C | | | | |
116+
C - | - | - | - | - | Read-in ustress, vstress, hflux,
117+
C | | | | | swflux, and sflux.
118+
C | | | | |
119+
C def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
120+
C | | | | | swdown, lwdown, precip, and runoff.
121+
C | | | | | Compute ustress, vstress, hflux,
122+
C | | | | | swflux, and sflux.
123+
C | | | | |
124+
C def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
125+
C | | | | | swflux, lwflux, precip, and runoff.
126+
C | | | | | Compute ustress, vstress, hflux,
127+
C | | | | | and sflux.
128+
C | | | | |
129+
C def | - | - | def | - | Read-in uwind, vwind, hflux,
130+
C | | | | | swflux, and sflux.
131+
C | | | | | Compute ustress and vstress.
132+
C | | | | |
133+
C - | def | - | def | - | Read-in ustress, vstress, atemp,
134+
C | | | | | aqh, swflux, lwflux, precip, and
135+
C | | | | | runoff. Compute hflux and sflux.
136+
C | | | | |
137+
C def | def | - | - | def | Read-in uwind, vwind, atemp, aqh,
138+
C | | | | | swflux, lwflux, precip, runoff,
139+
C | | | | | and evap.
140+
C | | | | |
141+
C def | def | - | def | - | Read-in uwind, vwind, atemp, aqh,
142+
C | | | | | swflux, lwflux, precip, and runoff.
143+
C | | | | | Compute open-water ustress, vstress,
144+
C | | | | | hflux, swflux, and evap.
145+
C | | | | |
146+
C def | def | def | - | def | Read-in uwind, vwind, atemp, aqh,
147+
C | | | | | swdown, lwdown, precip, runoff,
148+
C | | | | | and evap.
149+
C | | | | |
150+
C def | def | def | def | - | Read-in uwind, vwind, atemp, aqh,
151+
C | | | | | swdown, lwdown, precip, and runoff.
152+
C | | | | | Compute open-water ustress, vstress,
153+
C | | | | | hflux, swflux, and evap.
154+
C
155+
C ====================================================================
145156

146157
C Bulk formulae related flags.
147158
#define ALLOW_ATM_TEMP
148159
#define ALLOW_ATM_WIND
149160
#define ALLOW_DOWNWARD_RADIATION
150161
#define ALLOW_RUNOFF
162+
#undef ALLOW_RUNOFTEMP
163+
#define ALLOW_SALTFLX
151164
#if (defined (ALLOW_ATM_TEMP) || defined (ALLOW_ATM_WIND))
152165
# define ALLOW_BULKFORMULAE
153166
# define ALLOW_BULK_LARGEYEAGER04
154167
#endif
168+
#if (defined (ALLOW_ATM_TEMP) && defined (ATMOSPHERIC_LOADING))
169+
# undef EXF_CALC_ATMRHO
170+
#endif
155171

156172
C Zenith Angle/Albedo related flags.
157173
#ifdef ALLOW_DOWNWARD_RADIATION
158174
# define ALLOW_ZENITHANGLE
159-
# undef ALLOW_ZENITHANGLE_BOUNDSWDOWN
175+
# undef ALLOW_ZENITHANGLE_BOUNDSWDOWN
160176
#endif
161177

162-
C Use ocean_emissivity*lwdwon in lwFlux. This flag should be define
178+
C Use ocean_emissivity*lwdown in lwFlux. This flag should be defined
163179
C unless to reproduce old results (obtained with inconsistent old code)
164180
#ifdef ALLOW_DOWNWARD_RADIATION
165181
# define EXF_LWDOWN_WITH_EMISSIVITY
@@ -169,6 +185,9 @@ C Relaxation to monthly climatologies.
169185
#define ALLOW_CLIMSST_RELAXATION
170186
#define ALLOW_CLIMSSS_RELAXATION
171187

188+
C Allows to read-in seaice fraction from files (areaMaskFile)
189+
#undef EXF_SEAICE_FRACTION
190+
172191
C Use spatial interpolation to interpolate
173192
C forcing files from input grid to model grid.
174193
#define USE_EXF_INTERPOLATION

0 commit comments

Comments
 (0)