pkg/exf/EXF_OPTIONS.h

C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_OPTIONS.h,v 1.7 2006/01/02 21:17:01 heimbach Exp $
C $Name:  $

#ifndef EXF_OPTIONS_H
#define EXF_OPTIONS_H
#include "PACKAGES_CONFIG.h"
#ifdef ALLOW_EXF

#include "CPP_OPTIONS.h"

C Despite the comments below, this package is currently configured by
C ECCO_CPPOPTIONS.h and so you should not customize this file.

CPH >>>>>> THIS SHOULD BE INCLUDED BY CPP_OPTIONS.h <<<<<<
CPH >>>>>> TO AVOID ORDERING OF HEADERS TO MATTER   <<<<<<
CPH >>>>>> UNTIL WE DECIDE ON CONSISTENT CHANGE IN  <<<<<<
CPH >>>>>> POLICY                                   <<<<<<
CPH#include "ECCO_CPPOPTIONS.h"

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   >>> INCLUDE_EXTERNAL_FORCING_PACKAGE <<<
c       Include this package into the setup.
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_BULKFORMULAE <<<
c       Allows the use of bulk formulae in order to estimate
c       turbulent and radiative fluxes at the ocean's 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   >>> 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   ====================================================================

#ifdef USING_THREADS
#define EXF_IREAD_USE_GLOBAL_POINTER
#endif

#endif /* ALLOW_EXF */
#endif /* EXF_OPTIONS_H */
1	jmc	1.8	C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_OPTIONS.h,v 1.7 2006/01/02 21:17:01 heimbach 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	jmc	1.8	c WARNING: this flag is set (define/undef) in CPP_OPTIONS.h
58			c and cannot be changed here (in EXF_OPTIONS)
59	edhill	1.2	c
60			c >>> ALLOW_CLIMSST_RELAXATION <<<
61			c Allow the relaxation to a monthly climatology of sea surface
62			c temperature, e.g. the Reynolds climatology.
63			c
64			c >>> ALLOW_CLIMSSS_RELAXATION <<<
65			c Allow the relaxation to a monthly climatology of sea surface
66			c salinity, e.g. the Levitus climatology.
67			c
68			c >>> USE_EXF_INTERPOLATION <<<
69			c Allows specification of arbitrary Cartesian input grids.
70			c
71			c ====================================================================
72			c
73			c The following CPP options:
74			c
75			c ALLOW_ATM_WIND (WIND)
76			c ALLOW_ATM_TEMP (TEMP)
77			c ALLOW_DOWNWARD_RADIATION (DOWN)
78			c ALLOW_BULKFORMULAE (BULK)
79			c EXF_READ_EVAP (EVAP)
80			c
81			c permit the ocean-model forcing configurations listed in the
82			c table below. The first configuration is the default,
83			c flux-forced, ocean model. The next four are stand-alone
84			c configurations that use pkg/exf, open-water bulk formulae to
85			c compute the missing surface fluxes from atmospheric variables.
86			c The last four configurations can be used in conjunction with
87			c pkg/seaice to model ice-covered regions. The forcing fields
88			c in the rightmost column are defined in exf_fields.
89			c
90			c
91			c WIND \|TEMP \|DOWN \|BULK \|EVAP \| actions
92			c -----\|-----\|-----\|-----\|-----\|-------------------------------------
93			c \| \| \| \| \|
94			c - \| - \| - \| - \| - \| Read-in ustress, vstress, hflux,
95			c \| \| \| \| \| swflux, and sflux.
96			c \| \| \| \| \|
97			c def \| def \| def \| def \| - \| Read-in uwind, vwind, atemp, aqh,
98			c \| \| \| \| \| swdown, lwdown, precip, and runoff.
99			c \| \| \| \| \| Compute ustress, vstress, hflux,
100			c \| \| \| \| \| swflux, and sflux.
101			c \| \| \| \| \|
102			c def \| def \| - \| def \| - \| Read-in uwind, vwind, atemp, aqh,
103			c \| \| \| \| \| swflux, lwflux, precip, and runoff.
104			c \| \| \| \| \| Compute ustress, vstress, hflux,
105			c \| \| \| \| \| and sflux.
106			c \| \| \| \| \|
107			c def \| - \| - \| def \| - \| Read-in uwind, vwind, hflux,
108			c \| \| \| \| \| swflux, and sflux.
109			c \| \| \| \| \| Compute ustress and vstress.
110			c \| \| \| \| \|
111			c - \| def \| - \| def \| - \| Read-in ustress, vstress, atemp,
112			c \| \| \| \| \| aqh, swflux, lwflux, precip, and
113			c \| \| \| \| \| runoff. Compute hflux and sflux.
114			c \| \| \| \| \|
115			c def \| def \| - \| - \| def \| Read-in uwind, vwind, atemp, aqh,
116			c \| \| \| \| \| swflux, lwflux, precip, runoff,
117			c \| \| \| \| \| and evap.
118			c \| \| \| \| \|
119			c def \| def \| - \| def \| - \| Read-in uwind, vwind, atemp, aqh,
120			c \| \| \| \| \| swflux, lwflux, precip, and runoff.
121			c \| \| \| \| \| Compute open-water ustress, vstress,
122			c \| \| \| \| \| hflux, swflux, and evap.
123			c \| \| \| \| \|
124			c def \| def \| def \| - \| def \| Read-in uwind, vwind, atemp, aqh,
125			c \| \| \| \| \| swdown, lwdown, precip, runoff,
126			c \| \| \| \| \| and evap.
127			c \| \| \| \| \|
128			c def \| def \| def \| def \| - \| Read-in uwind, vwind, atemp, aqh,
129			c \| \| \| \| \| swdown, lwdown, precip, and runoff.
130			c \| \| \| \| \| Compute open-water ustress, vstress,
131			c \| \| \| \| \| hflux, swflux, and evap.
132			c
133			c ====================================================================
134
135	cnh	1.6	#ifdef USING_THREADS
136			#define EXF_IREAD_USE_GLOBAL_POINTER
137			#endif
138
139	edhill	1.2	#endif /* ALLOW_EXF */
140			#endif /* EXF_OPTIONS_H */