/[MITgcm]/MITgcm/pkg/exf/EXF_OPTIONS.h
ViewVC logotype

Annotation of /MITgcm/pkg/exf/EXF_OPTIONS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph

Revision 1.4 - (hide annotations) (download)
Tue Nov 25 16:07:03 2003 UTC (20 years, 7 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint52l_pre, checkpoint52e_pre, hrcube4, checkpoint52j_post, checkpoint52e_post, hrcube_1, branch-netcdf, checkpoint52d_pre, checkpoint52l_post, checkpoint52k_post, checkpoint52d_post, checkpoint52f_post, checkpoint52c_post, hrcube5, checkpoint52i_post, checkpoint52j_pre, checkpoint52i_pre, checkpoint52h_pre, checkpoint52f_pre, hrcube_2, hrcube_3
Branch point for: netcdf-sm0
Changes since 1.3: +7 -3 lines
File MIME type: text/plain 
Fixing OPTIONS files for use of exf:
o ALLOW_ECCO not needed
o ECCO_CPPOPTIONS.h should not be included from
  EXF_OPTIONS.h/CAL_OPTIONS.h, but from CPP_OPTIONS.h
  as has been the case in the past
o All cal/exf related options are currently set in
  single header file. Should remain so until we
  agree on a consistent new policy.
1 heimbach 1.4 C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_OPTIONS.h,v 1.3 2003/11/23 23:24:54 dimitri Exp $
2 edhill 1.2 C $Name: $
3    
4     #ifndef EXF_OPTIONS_H
5     #define EXF_OPTIONS_H
6     #include "PACKAGES_CONFIG.h"
7     #ifdef ALLOW_EXF
8    
9     #include "CPP_OPTIONS.h"
10    
11     C Despite the comments below, this package is currently configured by
12     C ECCO_CPPOPTIONS.h and so you should not customize this file.
13 heimbach 1.4
14     CPH >>>>>> THIS SHOULD BE INCLUDED BY CPP_OPTIONS.h <<<<<<
15     CPH >>>>>> TO AVOID ORDERING OF HEADERS TO MATTER <<<<<<
16     CPH >>>>>> UNTIL WE DECIDE ON CONSISTENT CHANGE IN <<<<<<
17     CPH >>>>>> POLICY <<<<<<
18     CPH#include "ECCO_CPPOPTIONS.h"
19 edhill 1.2
20     C CPP flags controlling which code is included in the files that
21     C will be compiled.
22     C
23    
24     c pkg/exf CPP options:
25     c --------------------
26     c
27     c >>> INCLUDE_EXTERNAL_FORCING_PACKAGE <<<
28     c Include this package into the setup.
29     c
30     c >>> EXF_VERBOSE <<<
31     c Do a bit more printout for the log file than usual.
32     c
33     c >>> ALLOW_ATM_WIND <<<
34     c If defined, 10-m wind fields can be read-in from files.
35     c
36     c >>> ALLOW_ATM_TEMP <<<
37     c If defined, atmospheric temperature and specific
38     c humidity fields can be read-in from files.
39     c
40     c >>> ALLOW_DOWNWARD_RADIATION <<<
41     c If defined, downward long-wave and short-wave radiation
42     c can be read-in form files or computed from lwflux and swflux.
43     c
44     c >>> ALLOW_BULKFORMULAE <<<
45     c Allows the use of bulk formulae in order to estimate
46     c turbulent and radiative fluxes at the ocean's surface.
47     c
48     c >>> EXF_READ_EVAP <<<
49     c If defined, evaporation fields are read-in, rather than
50     c computed from atmospheric state.
51     c
52     c >>> ALLOW_RUNOFF <<<
53     c If defined, river and glacier runoff can be read-in from files.
54     c
55     c >>> ATMOSPHERIC_LOADING <<<
56     c If defined, atmospheric pressure can be read-in from files.
57     c
58     c >>> ALLOW_CLIM_CYCLIC <<<
59     c If defined, relaxation file record numbers are assumed 1 to
60     c 12 corresponding to Jan. through Dec. Otherwise relaxation
61     c file record numbers are specified in data.exf_clim
62     c
63     c >>> ALLOW_CLIMTEMP_RELAXATION <<<
64     c Allow the relaxation to a monthly climatology of potential
65     c temperature, e.g. the Levitus climatology.
66     c
67     c >>> ALLOW_CLIMSALT_RELAXATION <<<
68     c Allow the relaxation to a monthly climatology of salinity,
69     c e.g. the Levitus climatology.
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 ====================================================================
145    
146     #endif /* ALLOW_EXF */
147     #endif /* EXF_OPTIONS_H */
  ViewVC Help
Powered by ViewVC 1.1.22