| 1 | dimitri | 1.41 | C $Header: /u/gcmpack/MITgcm/model/inc/CPP_OPTIONS.h,v 1.40 2007/04/27 15:34:54 jmc Exp $ | 
| 2 | jmc | 1.15 | C $Name:  $ | 
| 3 | adcroft | 1.17 |  | 
| 4 | edhill | 1.25 | #ifndef CPP_OPTIONS_H | 
| 5 |  |  | #define CPP_OPTIONS_H | 
| 6 |  |  |  | 
| 7 | edhill | 1.23 | C CPP flags controlling particular source code features | 
| 8 | adcroft | 1.10 |  | 
| 9 | edhill | 1.23 | C o Shortwave heating as extra term in external_forcing.F | 
| 10 | jmc | 1.31 | C Note: this should be a run-time option | 
| 11 |  |  | #undef SHORTWAVE_HEATING | 
| 12 | cnh | 1.6 |  | 
| 13 | dimitri | 1.41 | C o Include/exclude Duffy et al. (GRL 1999) salt plume scheme | 
| 14 |  |  | #undef ALLOW_SALT_PLUME | 
| 15 |  |  |  | 
| 16 | cnh | 1.6 | C o Include/exclude phi_hyd calculation code | 
| 17 |  |  | #define INCLUDE_PHIHYD_CALCULATION_CODE | 
| 18 |  |  |  | 
| 19 |  |  | C o Include/exclude call to S/R CONVECT | 
| 20 |  |  | #define INCLUDE_CONVECT_CALL | 
| 21 |  |  |  | 
| 22 |  |  | C o Include/exclude call to S/R CALC_DIFFUSIVITY | 
| 23 |  |  | #define INCLUDE_CALC_DIFFUSIVITY_CALL | 
| 24 | jmc | 1.30 |  | 
| 25 | dimitri | 1.39 | C o Allow latitudinally varying BryanLewis79 vertical diffusivity | 
| 26 |  |  | #undef ALLOW_BL79_LAT_VARY | 
| 27 |  |  |  | 
| 28 | dimitri | 1.38 | C o Allow full 3D specification of vertical diffusivity | 
| 29 |  |  | #undef ALLOW_3D_DIFFKR | 
| 30 |  |  |  | 
| 31 | jmc | 1.30 | C o Include/exclude Implicit vertical advection code | 
| 32 |  |  | #define INCLUDE_IMPLVERTADV_CODE | 
| 33 | adcroft | 1.8 |  | 
| 34 | jmc | 1.33 | C o Include/exclude AdamsBashforth-3rd-Order code | 
| 35 |  |  | #undef ALLOW_ADAMSBASHFORTH_3 | 
| 36 |  |  |  | 
| 37 | edhill | 1.24 | C o Include/exclude nonHydrostatic code | 
| 38 |  |  | #undef ALLOW_NONHYDROSTATIC | 
| 39 | edhill | 1.23 |  | 
| 40 |  |  | C o Include pressure loading code | 
| 41 |  |  | #define ATMOSPHERIC_LOADING | 
| 42 | adcroft | 1.11 |  | 
| 43 | jmc | 1.40 | C o exclude/allow external forcing-fields load | 
| 44 |  |  | C   this allows to read & do simple linear time interpolation of oceanic | 
| 45 |  |  | C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them. | 
| 46 |  |  | #undef EXCLUDE_FFIELDS_LOAD | 
| 47 |  |  |  | 
| 48 | adcroft | 1.18 | C o Use "Exact Convervation" of fluid in Free-Surface formulation | 
| 49 |  |  | C   so that d/dt(eta) is exactly equal to - Div.Transport | 
| 50 | edhill | 1.23 | #define EXACT_CONSERV | 
| 51 | adcroft | 1.18 |  | 
| 52 |  |  | C o Allow the use of Non-Linear Free-Surface formulation | 
| 53 |  |  | C   this implies that surface thickness (hFactors) vary with time | 
| 54 | edhill | 1.24 | #undef NONLIN_FRSURF | 
| 55 | adcroft | 1.7 |  | 
| 56 | mlosch | 1.35 | C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when | 
| 57 |  |  | C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) | 
| 58 |  |  | C *only for use on a lat-lon grid* | 
| 59 |  |  | C   Setting this flag here affects both momentum and tracer equation unless | 
| 60 |  |  | C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). | 
| 61 |  |  | C   The definition of the flag is commented to avoid interference with | 
| 62 |  |  | C   such other header files. | 
| 63 | mlosch | 1.36 | C   The preferred method is specifying a value for viscAhGrid or viscA4Grid | 
| 64 |  |  | C   in data which is then automatically scaled by the grid size; | 
| 65 |  |  | C   the old method of specifying viscAh/viscA4 and this flag is provided | 
| 66 |  |  | C   for completeness only (and for use with the adjoint). | 
| 67 | mlosch | 1.35 | C#define ISOTROPIC_COS_SCALING | 
| 68 |  |  |  | 
| 69 |  |  | C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. | 
| 70 |  |  | C *only for use on a lat-lon grid* | 
| 71 |  |  | C   Has no effect if ISOTROPIC_COS_SCALING is undefined. | 
| 72 |  |  | C   Has no effect on vector invariant momentum equations. | 
| 73 |  |  | C   Setting this flag here affects both momentum and tracer equation unless | 
| 74 |  |  | C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). | 
| 75 |  |  | C   The definition of the flag is commented to avoid interference with | 
| 76 |  |  | C   such other header files. | 
| 77 |  |  | C#define COSINEMETH_III | 
| 78 |  |  |  | 
| 79 | adcroft | 1.7 | C o Use "OLD" UV discretisation near boundaries (*not* recommended) | 
| 80 |  |  | C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F | 
| 81 |  |  | C          because the old code did not have no-slip BCs | 
| 82 |  |  | #undef  OLD_ADV_BCS | 
| 83 | dimitri | 1.22 |  | 
| 84 | dimitri | 1.37 | C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F | 
| 85 |  |  | C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO | 
| 86 |  |  | C   is still useful with, e.g., single-domain curvilinear configurations. | 
| 87 |  |  | #undef OLD_GRID_IO | 
| 88 |  |  |  | 
| 89 | cnh | 1.6 | C o Execution environment support options | 
| 90 | adcroft | 1.3 | #include "CPP_EEOPTIONS.h" | 
| 91 | heimbach | 1.13 |  | 
| 92 |  |  | C o Include/exclude code specific to the ECCO/SEALION version. | 
| 93 | heimbach | 1.29 | C   AUTODIFF or EXF package. | 
| 94 |  |  | C   Currently controled by a single header file | 
| 95 |  |  | C   For this to work, PACKAGES_CONFIG.h needs to be included! | 
| 96 |  |  | cph#if (defined (ALLOW_AUTODIFF) || \ | 
| 97 |  |  | cph     defined (ALLOW_ECCO) || \ | 
| 98 |  |  | cph     defined (ALLOW_EXF)) | 
| 99 |  |  | cph# include "ECCO_CPPOPTIONS.h" | 
| 100 |  |  | cph#endif | 
| 101 | edhill | 1.25 |  | 
| 102 |  |  | #endif /* CPP_OPTIONS_H */ | 
| 103 |  |  |  |