| 1 |
C $Header: /u/gcmpack/MITgcm/pkg/exf/EXF_OPTIONS.h,v 1.18 2010/11/23 18:55:54 jmc Exp $ |
| 2 |
C $Name: $ |
| 3 |
|
| 4 |
#ifndef EXF_OPTIONS_H |
| 5 |
#define EXF_OPTIONS_H |
| 6 |
#include "PACKAGES_CONFIG.h" |
| 7 |
#include "AD_CONFIG.h" |
| 8 |
|
| 9 |
#ifdef ALLOW_EXF |
| 10 |
|
| 11 |
#include "CPP_OPTIONS.h" |
| 12 |
|
| 13 |
#ifdef ALLOW_AUTODIFF_TAMC |
| 14 |
|
| 15 |
C When compile for AD mode, |
| 16 |
C this package is currently configured by ECCO_CPPOPTIONS.h |
| 17 |
C which is directly included in CPP_OPTIONS.h |
| 18 |
|
| 19 |
#else /* ndef ALLOW_AUTODIFF_TAMC */ |
| 20 |
|
| 21 |
C CPP flags controlling which code is included in the files that |
| 22 |
C will be compiled. |
| 23 |
C |
| 24 |
|
| 25 |
c pkg/exf CPP options: |
| 26 |
c -------------------- |
| 27 |
c |
| 28 |
c > ( EXF_VERBOSE ) < replaced with run-time, logical parameter "exf_verbose". |
| 29 |
c |
| 30 |
c >>> ALLOW_ATM_WIND <<< |
| 31 |
c If defined, 10-m wind fields can be read-in from files. |
| 32 |
c |
| 33 |
c >>> ALLOW_ATM_TEMP <<< |
| 34 |
c If defined, atmospheric temperature and specific |
| 35 |
c humidity fields can be read-in from files. |
| 36 |
c |
| 37 |
c >>> ALLOW_DOWNWARD_RADIATION <<< |
| 38 |
c If defined, downward long-wave and short-wave radiation |
| 39 |
c can be read-in form files or computed from lwflux and swflux. |
| 40 |
c |
| 41 |
c >>> ALLOW_ZENITHANGLE <<< |
| 42 |
c If defined, ocean albedo varies with the zenith angle, and |
| 43 |
c incoming fluxes at the top of the atmosphere are computed |
| 44 |
c |
| 45 |
c >>> ALLOW_BULKFORMULAE <<< |
| 46 |
c Allows the use of bulk formulae in order to estimate |
| 47 |
c turbulent and radiative fluxes at the ocean surface. |
| 48 |
c |
| 49 |
c >>> EXF_READ_EVAP <<< |
| 50 |
c If defined, evaporation fields are read-in, rather than |
| 51 |
c computed from atmospheric state. |
| 52 |
c |
| 53 |
c >>> ALLOW_RUNOFF <<< |
| 54 |
c If defined, river and glacier runoff can be read-in from files. |
| 55 |
c |
| 56 |
c >>> ATMOSPHERIC_LOADING <<< |
| 57 |
c If defined, atmospheric pressure can be read-in from files. |
| 58 |
c WARNING: this flag is set (define/undef) in CPP_OPTIONS.h |
| 59 |
c and cannot be changed here (in EXF_OPTIONS) |
| 60 |
c |
| 61 |
c >>> ICE_AREAMASK <<< |
| 62 |
c If defined, fractional ice-covered area MASK can be read-in from files. |
| 63 |
c |
| 64 |
c >>> ALLOW_CLIMSST_RELAXATION <<< |
| 65 |
c Allow the relaxation to a monthly climatology of sea surface |
| 66 |
c temperature, e.g. the Reynolds climatology. |
| 67 |
c |
| 68 |
c >>> ALLOW_CLIMSSS_RELAXATION <<< |
| 69 |
c Allow the relaxation to a monthly climatology of sea surface |
| 70 |
c salinity, e.g. the Levitus climatology. |
| 71 |
c |
| 72 |
c >>> USE_EXF_INTERPOLATION <<< |
| 73 |
c Allows specification of arbitrary Cartesian input grids. |
| 74 |
c |
| 75 |
c ==================================================================== |
| 76 |
c |
| 77 |
c The following CPP options: |
| 78 |
c |
| 79 |
c ALLOW_ATM_WIND (WIND) |
| 80 |
c ALLOW_ATM_TEMP (TEMP) |
| 81 |
c ALLOW_DOWNWARD_RADIATION (DOWN) |
| 82 |
c ALLOW_BULKFORMULAE (BULK) |
| 83 |
c EXF_READ_EVAP (EVAP) |
| 84 |
c |
| 85 |
c permit the ocean-model forcing configurations listed in the |
| 86 |
c table below. The first configuration is the default, |
| 87 |
c flux-forced, ocean model. The next four are stand-alone |
| 88 |
c configurations that use pkg/exf, open-water bulk formulae to |
| 89 |
c compute the missing surface fluxes from atmospheric variables. |
| 90 |
c The last four configurations can be used in conjunction with |
| 91 |
c pkg/seaice to model ice-covered regions. The forcing fields |
| 92 |
c in the rightmost column are defined in exf_fields. |
| 93 |
c |
| 94 |
c |
| 95 |
c WIND |TEMP |DOWN |BULK |EVAP | actions |
| 96 |
c -----|-----|-----|-----|-----|------------------------------------- |
| 97 |
c | | | | | |
| 98 |
c - | - | - | - | - | Read-in ustress, vstress, hflux, |
| 99 |
c | | | | | swflux, and sflux. |
| 100 |
c | | | | | |
| 101 |
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh, |
| 102 |
c | | | | | swdown, lwdown, precip, and runoff. |
| 103 |
c | | | | | Compute ustress, vstress, hflux, |
| 104 |
c | | | | | swflux, and sflux. |
| 105 |
c | | | | | |
| 106 |
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh, |
| 107 |
c | | | | | swflux, lwflux, precip, and runoff. |
| 108 |
c | | | | | Compute ustress, vstress, hflux, |
| 109 |
c | | | | | and sflux. |
| 110 |
c | | | | | |
| 111 |
c def | - | - | def | - | Read-in uwind, vwind, hflux, |
| 112 |
c | | | | | swflux, and sflux. |
| 113 |
c | | | | | Compute ustress and vstress. |
| 114 |
c | | | | | |
| 115 |
c - | def | - | def | - | Read-in ustress, vstress, atemp, |
| 116 |
c | | | | | aqh, swflux, lwflux, precip, and |
| 117 |
c | | | | | runoff. Compute hflux and sflux. |
| 118 |
c | | | | | |
| 119 |
c def | def | - | - | def | Read-in uwind, vwind, atemp, aqh, |
| 120 |
c | | | | | swflux, lwflux, precip, runoff, |
| 121 |
c | | | | | and evap. |
| 122 |
c | | | | | |
| 123 |
c def | def | - | def | - | Read-in uwind, vwind, atemp, aqh, |
| 124 |
c | | | | | swflux, lwflux, precip, and runoff. |
| 125 |
c | | | | | Compute open-water ustress, vstress, |
| 126 |
c | | | | | hflux, swflux, and evap. |
| 127 |
c | | | | | |
| 128 |
c def | def | def | - | def | Read-in uwind, vwind, atemp, aqh, |
| 129 |
c | | | | | swdown, lwdown, precip, runoff, |
| 130 |
c | | | | | and evap. |
| 131 |
c | | | | | |
| 132 |
c def | def | def | def | - | Read-in uwind, vwind, atemp, aqh, |
| 133 |
c | | | | | swdown, lwdown, precip, and runoff. |
| 134 |
c | | | | | Compute open-water ustress, vstress, |
| 135 |
c | | | | | hflux, swflux, and evap. |
| 136 |
c |
| 137 |
c ==================================================================== |
| 138 |
|
| 139 |
C Bulk formulae related flags. |
| 140 |
#define ALLOW_ATM_TEMP |
| 141 |
#define ALLOW_ATM_WIND |
| 142 |
#define ALLOW_DOWNWARD_RADIATION |
| 143 |
#define ALLOW_RUNOFF |
| 144 |
#if (defined (ALLOW_ATM_TEMP) || \ |
| 145 |
defined (ALLOW_ATM_WIND)) |
| 146 |
# define ALLOW_BULKFORMULAE |
| 147 |
# undef ALLOW_BULK_LARGEYEAGER04 |
| 148 |
#endif |
| 149 |
|
| 150 |
C Zenith Angle/Albedo related flags. |
| 151 |
#ifdef ALLOW_DOWNWARD_RADIATION |
| 152 |
# undef ALLOW_ZENITHANGLE |
| 153 |
#endif |
| 154 |
|
| 155 |
C Use ocean_emissivity*lwdwon in lwFlux. This flag should always be define |
| 156 |
C but is not because of backward compatibility |
| 157 |
#ifdef ALLOW_DOWNWARD_RADIATION |
| 158 |
# undef EXF_LWDOWN_WITH_EMISSIVITY |
| 159 |
#endif |
| 160 |
|
| 161 |
C Relaxation to monthly climatologies. |
| 162 |
#define ALLOW_CLIMSST_RELAXATION |
| 163 |
#define ALLOW_CLIMSSS_RELAXATION |
| 164 |
|
| 165 |
C Use spatial interpolation to interpolate |
| 166 |
C forcing files from input grid to model grid. |
| 167 |
#undef USE_EXF_INTERPOLATION |
| 168 |
C runoff is a special case for which one might want to bypass |
| 169 |
C interpolation from an input grid |
| 170 |
#ifdef USE_EXF_INTERPOLATION |
| 171 |
# undef USE_NO_INTERP_RUNOFF |
| 172 |
#endif |
| 173 |
|
| 174 |
#define EXF_INTERP_USE_DYNALLOC |
| 175 |
#if ( defined (EXF_INTERP_USE_DYNALLOC) & defined (USING_THREADS) ) |
| 176 |
# define EXF_IREAD_USE_GLOBAL_POINTER |
| 177 |
#endif |
| 178 |
|
| 179 |
#endif /* ndef ALLOW_AUTODIFF_TAMC */ |
| 180 |
#endif /* ALLOW_EXF */ |
| 181 |
#endif /* EXF_OPTIONS_H */ |
Parent Directory
| 
Revision Log
| 
Revision Graph