/[MITgcm]/MITgcm_contrib/verification_other/global_oce_llc90/code/EXF_OPTIONS.h
ViewVC logotype

Annotation of /MITgcm_contrib/verification_other/global_oce_llc90/code/EXF_OPTIONS.h

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


Revision 1.2 - (hide annotations) (download)
Mon Oct 20 03:29:00 2014 UTC (10 years, 9 months ago) by gforget
Branch: MAIN
CVS Tags: checkpoint66b, checkpoint66a, checkpoint65z, checkpoint65y, checkpoint65r, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u
Changes since 1.1: +22 -5 lines
File MIME type: text/plain
- replace ECCO_CPPOPTIONS.h with separate
  AUTODIFF_OPTIONS.h, CTRL_OPTIONS.h, ECCO_OPTIONS.h

1 gforget 1.2 C $Header: /u/gcmpack/MITgcm_contrib/gael/verification/global_oce_llc90/code/EXF_OPTIONS.h,v 1.1 2012/08/24 16:33:53 gforget Exp $
2 gforget 1.1 C $Name: $
3    
4 gforget 1.2 CBOP
5     C !ROUTINE: EXF_OPTIONS.h
6     C !INTERFACE:
7     C #include "EXF_OPTIONS.h"
8    
9     C !DESCRIPTION:
10     C *==================================================================*
11     C | CPP options file for EXternal Forcing (EXF) package:
12     C | Control which optional features to compile in this package code.
13     C *==================================================================*
14     CEOP
15    
16 gforget 1.1 #ifndef EXF_OPTIONS_H
17     #define EXF_OPTIONS_H
18     #include "PACKAGES_CONFIG.h"
19     #include "CPP_OPTIONS.h"
20    
21     #ifdef ALLOW_EXF
22 gforget 1.2 #ifdef ECCO_CPPOPTIONS_H
23    
24     C-- When multi-package option-file ECCO_CPPOPTIONS.h is used (directly included
25     C in CPP_OPTIONS.h), this option file is left empty since all options that
26     C are specific to this package are assumed to be set in ECCO_CPPOPTIONS.h
27    
28     #else /* ndef ECCO_CPPOPTIONS_H */
29 gforget 1.1
30 gforget 1.2 C-- Package-specific Options & Macros go here
31 gforget 1.1
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 ====================================================================
145    
146     C Bulk formulae related flags.
147     #define ALLOW_ATM_TEMP
148     #define ALLOW_ATM_WIND
149     #define ALLOW_DOWNWARD_RADIATION
150     #define ALLOW_RUNOFF
151     #if (defined (ALLOW_ATM_TEMP) || defined (ALLOW_ATM_WIND))
152     # define ALLOW_BULKFORMULAE
153     # define ALLOW_BULK_LARGEYEAGER04
154     #endif
155    
156     C Zenith Angle/Albedo related flags.
157     #ifdef ALLOW_DOWNWARD_RADIATION
158     # define ALLOW_ZENITHANGLE
159     # undef ALLOW_ZENITHANGLE_BOUNDSWDOWN
160     #endif
161    
162     C Use ocean_emissivity*lwdwon in lwFlux. This flag should be define
163     C unless to reproduce old results (obtained with inconsistent old code)
164     #ifdef ALLOW_DOWNWARD_RADIATION
165     # define EXF_LWDOWN_WITH_EMISSIVITY
166     #endif
167    
168     C Relaxation to monthly climatologies.
169     #define ALLOW_CLIMSST_RELAXATION
170     #define ALLOW_CLIMSSS_RELAXATION
171    
172     C Use spatial interpolation to interpolate
173     C forcing files from input grid to model grid.
174     #define USE_EXF_INTERPOLATION
175     C for interpolated vector fields, rotate towards model-grid axis
176     C using old rotation formulae (instead of grid-angles)
177     #undef EXF_USE_OLD_VEC_ROTATION
178     C for interpolation around N & S pole, use the old formulation
179     C (no pole symmetry, single vector-comp interp, reset to 0 zonal-comp @ N.pole)
180     #undef EXF_USE_OLD_INTERP_POLE
181    
182     #define EXF_INTERP_USE_DYNALLOC
183     #if ( defined (EXF_INTERP_USE_DYNALLOC) && defined (USING_THREADS) )
184     # define EXF_IREAD_USE_GLOBAL_POINTER
185     #endif
186    
187 gforget 1.2 #endif /* ndef ECCO_CPPOPTIONS_H */
188 gforget 1.1 #endif /* ALLOW_EXF */
189     #endif /* EXF_OPTIONS_H */

  ViewVC Help
Powered by ViewVC 1.1.22