/[MITgcm]/MITgcm_contrib/high_res_cube/cube92up/code/EXF_OPTIONS.h
ViewVC logotype

Annotation of /MITgcm_contrib/high_res_cube/cube92up/code/EXF_OPTIONS.h

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


Revision 1.1 - (hide annotations) (download)
Wed Dec 12 01:13:19 2012 UTC (12 years, 7 months ago) by dimitri
Branch: MAIN
CVS Tags: HEAD
File MIME type: text/plain
towards llc4320 configuration

1 dimitri 1.1 C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/cube92/code/EXF_OPTIONS.h,v 1.1 2012/12/06 02:01:50 dimitri Exp $
2     C $Name: $
3    
4     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     #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     #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    
30     C-- Package-specific Options & Macros go here
31    
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     # undef ALLOW_BULK_LARGEYEAGER04
154     #endif
155    
156     C Zenith Angle/Albedo related flags.
157     #ifdef ALLOW_DOWNWARD_RADIATION
158     # undef ALLOW_ZENITHANGLE
159     #endif
160    
161     C Use ocean_emissivity*lwdwon in lwFlux. This flag should be define
162     C unless to reproduce old results (obtained with inconsistent old code)
163     #ifdef ALLOW_DOWNWARD_RADIATION
164     # define EXF_LWDOWN_WITH_EMISSIVITY
165     #endif
166    
167     C Relaxation to monthly climatologies.
168     #define ALLOW_CLIMSST_RELAXATION
169     #define ALLOW_CLIMSSS_RELAXATION
170    
171     C Use spatial interpolation to interpolate
172     C forcing files from input grid to model grid.
173     #define USE_EXF_INTERPOLATION
174     C for interpolated vector fields, rotate towards model-grid axis
175     C using old rotation formulae (instead of grid-angles)
176     #undef EXF_USE_OLD_VEC_ROTATION
177     C for interpolation around N & S pole, use the old formulation
178     C (no pole symmetry, single vector-comp interp, reset to 0 zonal-comp @ N.pole)
179     #undef EXF_USE_OLD_INTERP_POLE
180    
181     #define EXF_INTERP_USE_DYNALLOC
182     #if ( defined (EXF_INTERP_USE_DYNALLOC) && defined (USING_THREADS) )
183     # define EXF_IREAD_USE_GLOBAL_POINTER
184     #endif
185    
186     #endif /* ndef ECCO_CPPOPTIONS_H */
187     #endif /* ALLOW_EXF */
188     #endif /* EXF_OPTIONS_H */

  ViewVC Help
Powered by ViewVC 1.1.22