| 1 | C $Header: /u/gcmpack/MITgcm_contrib/high_res_cube/code-mods/SEAICE_OPTIONS.h,v 1.18 2011/05/19 06:25:18 dimitri Exp $ | 
| 2 | C $Name:  $ | 
| 3 |  | 
| 4 | C     *==========================================================* | 
| 5 | C     | SEAICE_OPTIONS.h | 
| 6 | C     | o CPP options file for sea ice package. | 
| 7 | C     *==========================================================* | 
| 8 | C     | Use this file for selecting options within the sea ice | 
| 9 | C     | package. | 
| 10 | C     *==========================================================* | 
| 11 |  | 
| 12 | #ifndef SEAICE_OPTIONS_H | 
| 13 | #define SEAICE_OPTIONS_H | 
| 14 | #include "PACKAGES_CONFIG.h" | 
| 15 | #include "CPP_OPTIONS.h" | 
| 16 |  | 
| 17 | #ifdef ALLOW_SEAICE | 
| 18 | C     Package-specific Options & Macros go here | 
| 19 |  | 
| 20 | C--   Write "text-plots" of certain fields in STDOUT for debugging. | 
| 21 | #undef SEAICE_DEBUG | 
| 22 |  | 
| 23 | C--   Allow sea-ice dynamic code. | 
| 24 | C     This option is provided to allow use of TAMC | 
| 25 | C     on the thermodynamics component of the code only. | 
| 26 | C     Sea-ice dynamics can also be turned off at runtime | 
| 27 | C     using variable SEAICEuseDYNAMICS. | 
| 28 | #define SEAICE_ALLOW_DYNAMICS | 
| 29 |  | 
| 30 | C--   By default, the sea-ice package uses its own integrated bulk | 
| 31 | C     formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over | 
| 32 | C     open-ocean.  When this flag is set, these variables are computed | 
| 33 | C     in a separate external package, for example, pkg/exf, and then | 
| 34 | C     modified for sea-ice effects by pkg/seaice. | 
| 35 | #define SEAICE_EXTERNAL_FLUXES | 
| 36 |  | 
| 37 | C--   By default, the sea-ice package uses 2-category thermodynamics. | 
| 38 | C     When this flag is set, an 8-category calculation of ice | 
| 39 | C     thermodynamics is carried out in groatb.F | 
| 40 | C     Note the pickup_seaice.* generated by this option differ | 
| 41 | C     from those generated with the default 2-category model. | 
| 42 | C     Therefore it is not possible to switch between the two | 
| 43 | C     in the middle of an integration. | 
| 44 | #define SEAICE_MULTICATEGORY | 
| 45 |  | 
| 46 | C--   Use the Old version of seaice_growth (close to cvs version 1.70) | 
| 47 | C     otherwise, use the merged version (with some of Ian Fenty s code) | 
| 48 | #undef SEAICE_GROWTH_LEGACY | 
| 49 |  | 
| 50 | C--   Since the missing sublimation term is now included | 
| 51 | C     this flag is needed for backward compatibility | 
| 52 | #undef SEAICE_DISABLE_SUBLIM | 
| 53 |  | 
| 54 | C--   Suspected missing term in coupled ocn-ice heat budget (to be further tested) | 
| 55 | #undef SEAICE_DISABLE_HEATCONSFIX | 
| 56 |  | 
| 57 | C--   options only available in the merged version | 
| 58 | #ifndef SEAICE_GROWTH_LEGACY | 
| 59 | C-    to ensure heat conservation in the coupled ocean-seaice system | 
| 60 | # undef SEAICE_HEAT_CONSERV_FIX | 
| 61 | C-    to preclude infinitesimal ice concentrations: | 
| 62 | # undef ALLOW_PRECLUDE_INFINITESIMAL_AREA | 
| 63 | #endif | 
| 64 |  | 
| 65 | C--   By default sea ice is fresh.  Set following flag for salty ice. | 
| 66 | #define SEAICE_VARIABLE_SALINITY | 
| 67 |  | 
| 68 | C--   Tracers of ice and/or ice cover. | 
| 69 | #undef ALLOW_SITRACER | 
| 70 | #ifdef ALLOW_SITRACER | 
| 71 | C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff. | 
| 72 | # define ALLOW_SITRACER_ADVCAP | 
| 73 | #endif | 
| 74 |  | 
| 75 | C--   By default the seaice model is discretized on a B-Grid (for | 
| 76 | C     historical reasons). Define the following flag to use a new | 
| 77 | C     (not thoroughly) test version on a C-grid | 
| 78 | #define SEAICE_CGRID | 
| 79 |  | 
| 80 | C--   Only for the C-grid version it is possible to | 
| 81 | #ifdef SEAICE_CGRID | 
| 82 | C     enable EVP code by defining the following flag | 
| 83 | # define SEAICE_ALLOW_EVP | 
| 84 | # ifdef SEAICE_ALLOW_EVP | 
| 85 | C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit | 
| 86 | C--   viscosities from below and above in seaice_evp | 
| 87 | C--   not necessary, and not recommended | 
| 88 | #  undef SEAICE_ALLOW_CLIPZETA | 
| 89 | # endif /* SEAICE_ALLOW_EVP */ | 
| 90 | C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM) | 
| 91 | # undef SEAICE_ALLOW_TEM | 
| 92 | #else /* not SEAICE_CGRID, but old B-grid */ | 
| 93 | C--   By default for B-grid dynamics solver wind stress under sea-ice is | 
| 94 | C     set to the same value as it would be if there was no sea-ice. | 
| 95 | C     Define following CPP flag for B-grid ice-ocean stress coupling. | 
| 96 | # define SEAICE_BICE_STRESS | 
| 97 |  | 
| 98 | C--   By default for B-grid dynamics solver surface tilt is obtained | 
| 99 | C     indirectly via geostrophic velocities. Define following CPP | 
| 100 | C     in order to use ETAN instead. | 
| 101 | # define EXPLICIT_SSH_SLOPE | 
| 102 | C--   Defining this flag turns on a FV-discretization of the B-grid LSOR | 
| 103 | C     solver. It is smoother and includes all metric terms, similar to the | 
| 104 | C     C-grid solver. It is here for completeness, but its usefulness is | 
| 105 | C     unclear. | 
| 106 | # undef SEAICE_LSRBNEW | 
| 107 | #endif /* SEAICE_CGRID */ | 
| 108 |  | 
| 109 | C--   When set use MAX_HEFF to cap sea ice thickness in seaice_growth | 
| 110 | #undef SEAICE_CAP_HEFF | 
| 111 | C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box | 
| 112 | #undef SEAICE_CAP_ICELOAD | 
| 113 | C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s, | 
| 114 | C--   not recommended | 
| 115 | #undef SEAICE_ALLOW_CLIPVELS | 
| 116 | C--   When set cap the sublimation latent heat flux in solve4temp | 
| 117 | C     according to the available amount of ice+snow. Otherwise this | 
| 118 | C     term is treated like all of the others -- residuals heat and | 
| 119 | C     fw stocks are passed to the ocean at the end of seaice_growth | 
| 120 | C     in a conservative manner. SEAICE_CAP_SUBLIM is not needed | 
| 121 | C     as of now, but kept just in case. | 
| 122 | #undef SEAICE_CAP_SUBLIM | 
| 123 |  | 
| 124 | C     enable free drift code | 
| 125 | #undef SEAICE_ALLOW_FREEDRIFT | 
| 126 |  | 
| 127 | #endif /* ALLOW_SEAICE */ | 
| 128 | #endif /* SEAICE_OPTIONS_H */ | 
| 129 |  | 
| 130 | CEH3 ;;; Local Variables: *** | 
| 131 | CEH3 ;;; mode:fortran *** | 
| 132 | CEH3 ;;; End: *** |