| 1 |
mlosch |
1.81 |
C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE_OPTIONS.h,v 1.80 2016/06/14 20:36:07 jmc Exp $ |
| 2 |
jmc |
1.17 |
C $Name: $ |
| 3 |
heimbach |
1.2 |
|
| 4 |
jmc |
1.41 |
C *==========================================================* |
| 5 |
jmc |
1.55 |
C | SEAICE_OPTIONS.h |
| 6 |
|
|
C | o CPP options file for sea ice package. |
| 7 |
jmc |
1.41 |
C *==========================================================* |
| 8 |
jmc |
1.55 |
C | Use this file for selecting options within the sea ice |
| 9 |
|
|
C | package. |
| 10 |
jmc |
1.41 |
C *==========================================================* |
| 11 |
heimbach |
1.2 |
|
| 12 |
edhill |
1.7 |
#ifndef SEAICE_OPTIONS_H |
| 13 |
|
|
#define SEAICE_OPTIONS_H |
| 14 |
|
|
#include "PACKAGES_CONFIG.h" |
| 15 |
heimbach |
1.2 |
#include "CPP_OPTIONS.h" |
| 16 |
jmc |
1.55 |
|
| 17 |
jmc |
1.52 |
#ifdef ALLOW_SEAICE |
| 18 |
jmc |
1.55 |
C Package-specific Options & Macros go here |
| 19 |
heimbach |
1.2 |
|
| 20 |
dimitri |
1.3 |
C-- Write "text-plots" of certain fields in STDOUT for debugging. |
| 21 |
heimbach |
1.2 |
#undef SEAICE_DEBUG |
| 22 |
|
|
|
| 23 |
dimitri |
1.3 |
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 |
heimbach |
1.2 |
#define SEAICE_ALLOW_DYNAMICS |
| 29 |
dimitri |
1.3 |
|
| 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 |
dimitri |
1.28 |
#define SEAICE_EXTERNAL_FLUXES |
| 36 |
heimbach |
1.2 |
|
| 37 |
jmc |
1.80 |
C-- Exclude Wind-Stress common block (in SEAICE.h). This option |
| 38 |
|
|
C should ALWAYS been left undef (just listed here for the record) |
| 39 |
|
|
#undef SEAICE_EXCLUDE_WIND_STRESS |
| 40 |
|
|
|
| 41 |
dimitri |
1.71 |
C-- This CPP flag has been retired. The number of ice categories |
| 42 |
|
|
C used to solve for seaice flux is now specified by run-time |
| 43 |
|
|
C parameter SEAICE_multDim. |
| 44 |
|
|
C Note: be aware of pickup_seaice.* compatibility issues when |
| 45 |
|
|
C restarting a simulation with a different number of categories. |
| 46 |
jmc |
1.64 |
c#define SEAICE_MULTICATEGORY |
| 47 |
dimitri |
1.5 |
|
| 48 |
jmc |
1.68 |
C-- run with sea Ice Thickness Distribution (ITD); |
| 49 |
|
|
C set number of categories (nITD) in SEAICE_SIZE.h |
| 50 |
|
|
#undef SEAICE_ITD |
| 51 |
|
|
|
| 52 |
gforget |
1.60 |
C-- Since the missing sublimation term is now included |
| 53 |
|
|
C this flag is needed for backward compatibility |
| 54 |
|
|
#undef SEAICE_DISABLE_SUBLIM |
| 55 |
|
|
|
| 56 |
jmc |
1.64 |
C-- Suspected missing term in coupled ocn-ice heat budget (to be confirmed) |
| 57 |
|
|
#undef SEAICE_DISABLE_HEATCONSFIX |
| 58 |
gforget |
1.61 |
|
| 59 |
jmc |
1.64 |
C-- Default is constant seaice salinity (SEAICE_salt0); Define the following |
| 60 |
|
|
C flag to consider (space & time) variable salinity: advected and forming |
| 61 |
|
|
C seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity. |
| 62 |
|
|
C- Note: SItracer also offers an alternative way to handle variable salinity. |
| 63 |
ifenty |
1.49 |
#undef SEAICE_VARIABLE_SALINITY |
| 64 |
dimitri |
1.27 |
|
| 65 |
gforget |
1.51 |
C-- Tracers of ice and/or ice cover. |
| 66 |
|
|
#undef ALLOW_SITRACER |
| 67 |
|
|
#ifdef ALLOW_SITRACER |
| 68 |
|
|
C-- To try avoid 'spontaneous generation' of tracer maxima by advdiff. |
| 69 |
|
|
# define ALLOW_SITRACER_ADVCAP |
| 70 |
|
|
#endif |
| 71 |
|
|
|
| 72 |
torge |
1.74 |
C-- Enable grease ice parameterization |
| 73 |
jmc |
1.80 |
C The grease ice parameterization delays formation of solid |
| 74 |
|
|
C sea ice from frazil ice by a time constant and provides a |
| 75 |
|
|
C dynamic calculation of the initial solid sea ice thickness |
| 76 |
|
|
C HO as a function of winds, currents and available grease ice |
| 77 |
|
|
C volume. Grease ice does not significantly reduce heat loss |
| 78 |
|
|
C from the ocean in winter and area covered by grease is thus |
| 79 |
torge |
1.74 |
C handled like open water. |
| 80 |
|
|
C (For details see Smedsrud and Martin, 2014, Ann.Glac.) |
| 81 |
|
|
C Set SItrName(1) = 'grease' in namelist SEAICE_PARM03 in data.seaice |
| 82 |
|
|
C then output SItr01 is SItrNameLong(1) = 'grease ice volume fraction', |
| 83 |
|
|
C with SItrUnit(1) = '[0-1]', which needs to be multiplied by SIheff |
| 84 |
|
|
C to yield grease ice volume. Additionally, the actual grease ice |
| 85 |
|
|
C layer thickness (diagnostic SIgrsLT) can be saved. |
| 86 |
|
|
#undef SEAICE_GREASE |
| 87 |
|
|
C-- grease ice uses SItracer: |
| 88 |
|
|
#ifdef SEAICE_GREASE |
| 89 |
|
|
# define ALLOW_SITRACER |
| 90 |
|
|
# define ALLOW_SITRACER_ADVCAP |
| 91 |
|
|
#endif |
| 92 |
|
|
|
| 93 |
jmc |
1.41 |
C-- By default the seaice model is discretized on a B-Grid (for |
| 94 |
mlosch |
1.14 |
C historical reasons). Define the following flag to use a new |
| 95 |
|
|
C (not thoroughly) test version on a C-grid |
| 96 |
jmc |
1.17 |
#define SEAICE_CGRID |
| 97 |
mlosch |
1.14 |
|
| 98 |
jmc |
1.41 |
C-- Only for the C-grid version it is possible to |
| 99 |
mlosch |
1.15 |
#ifdef SEAICE_CGRID |
| 100 |
mlosch |
1.81 |
C enable advection of sea ice momentum |
| 101 |
|
|
# undef SEAICE_ALLOW_MOM_ADVECTION |
| 102 |
mlosch |
1.65 |
C enable JFNK code by defining the following flag |
| 103 |
|
|
# define SEAICE_ALLOW_JFNK |
| 104 |
mlosch |
1.78 |
C enable Krylov code by defining the following flag |
| 105 |
|
|
# define SEAICE_ALLOW_KRYLOV |
| 106 |
jmc |
1.69 |
C enable LSR to use global (multi-tile) tri-diagonal solver |
| 107 |
|
|
# undef SEAICE_GLOBAL_3DIAG_SOLVER |
| 108 |
mlosch |
1.31 |
C enable EVP code by defining the following flag |
| 109 |
dimitri |
1.38 |
# define SEAICE_ALLOW_EVP |
| 110 |
|
|
# ifdef SEAICE_ALLOW_EVP |
| 111 |
jmc |
1.64 |
C-- When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities |
| 112 |
|
|
C from below and above in seaice_evp: not necessary, and not recommended |
| 113 |
dimitri |
1.38 |
# undef SEAICE_ALLOW_CLIPZETA |
| 114 |
mlosch |
1.67 |
# endif /* SEAICE_ALLOW_EVP */ |
| 115 |
mlosch |
1.77 |
C smooth regularization (without max-function) of delta for |
| 116 |
|
|
C better differentiability |
| 117 |
|
|
# undef SEAICE_DELTA_SMOOTHREG |
| 118 |
jmc |
1.68 |
C regularize zeta to zmax with a smooth tanh-function instead |
| 119 |
mlosch |
1.65 |
C of a min(zeta,zmax). This improves convergence of iterative |
| 120 |
|
|
C solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP |
| 121 |
mlosch |
1.67 |
# undef SEAICE_ZETA_SMOOTHREG |
| 122 |
mlosch |
1.31 |
C allow the truncated ellipse rheology (runtime flag SEAICEuseTEM) |
| 123 |
dimitri |
1.38 |
# undef SEAICE_ALLOW_TEM |
| 124 |
mlosch |
1.73 |
C Use LSR vector code; not useful on non-vector machines, because it |
| 125 |
|
|
C slows down convergence considerably, but the extra iterations are |
| 126 |
|
|
C more than made up by the much faster code on vector machines. For |
| 127 |
|
|
C the only regularly test vector machine these flags a specified |
| 128 |
|
|
C in the build options file SUPER-UX_SX-8_sxf90_awi, so that we comment |
| 129 |
|
|
C them out here. |
| 130 |
mlosch |
1.76 |
# undef SEAICE_VECTORIZE_LSR |
| 131 |
|
|
C Use zebra-method (alternate lines) for line-successive-relaxation |
| 132 |
|
|
C This modification improves the convergence of the vector code |
| 133 |
|
|
C dramatically, so that is may actually be useful in general, but |
| 134 |
|
|
C that needs to be tested. Can be used without vectorization options. |
| 135 |
mlosch |
1.79 |
# undef SEAICE_LSR_ZEBRA |
| 136 |
|
|
C Use parameterisation of grounding ice for a better representation |
| 137 |
|
|
C of fastice in shallow seas |
| 138 |
|
|
# undef SEAICE_ALLOW_BOTTOMDRAG |
| 139 |
mlosch |
1.33 |
#else /* not SEAICE_CGRID, but old B-grid */ |
| 140 |
|
|
C-- By default for B-grid dynamics solver wind stress under sea-ice is |
| 141 |
|
|
C set to the same value as it would be if there was no sea-ice. |
| 142 |
|
|
C Define following CPP flag for B-grid ice-ocean stress coupling. |
| 143 |
dimitri |
1.38 |
# define SEAICE_BICE_STRESS |
| 144 |
mlosch |
1.33 |
|
| 145 |
|
|
C-- By default for B-grid dynamics solver surface tilt is obtained |
| 146 |
|
|
C indirectly via geostrophic velocities. Define following CPP |
| 147 |
|
|
C in order to use ETAN instead. |
| 148 |
dimitri |
1.38 |
# define EXPLICIT_SSH_SLOPE |
| 149 |
jmc |
1.64 |
C-- Defining this flag turns on FV-discretization of the B-grid LSOR solver. |
| 150 |
|
|
C It is smoother and includes all metric terms, similar to C-grid solvers. |
| 151 |
|
|
C It is here for completeness, but its usefulness is unclear. |
| 152 |
mlosch |
1.54 |
# undef SEAICE_LSRBNEW |
| 153 |
jmc |
1.16 |
#endif /* SEAICE_CGRID */ |
| 154 |
mlosch |
1.15 |
|
| 155 |
jmc |
1.41 |
C-- When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box |
| 156 |
|
|
#undef SEAICE_CAP_ICELOAD |
| 157 |
mlosch |
1.36 |
C-- When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s, |
| 158 |
jmc |
1.64 |
C not recommended |
| 159 |
mlosch |
1.36 |
#undef SEAICE_ALLOW_CLIPVELS |
| 160 |
jmc |
1.64 |
C-- When set cap the sublimation latent heat flux in solve4temp according |
| 161 |
|
|
C to the available amount of ice+snow. Otherwise this term is treated |
| 162 |
|
|
C like all of the others -- residuals heat and fw stocks are passed to |
| 163 |
|
|
C the ocean at the end of seaice_growth in a conservative manner. |
| 164 |
|
|
C SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case. |
| 165 |
gforget |
1.60 |
#undef SEAICE_CAP_SUBLIM |
| 166 |
dimitri |
1.24 |
|
| 167 |
jmc |
1.64 |
C-- Enable free drift code |
| 168 |
gforget |
1.40 |
#undef SEAICE_ALLOW_FREEDRIFT |
| 169 |
|
|
|
| 170 |
gforget |
1.75 |
C-- pkg/seaice cost functions compile flags |
| 171 |
|
|
c >>> Sea-ice volume (requires pkg/cost) |
| 172 |
|
|
#undef ALLOW_COST_ICE |
| 173 |
|
|
c >>> Sea-ice misfit to obs (requires pkg/cost and ecco) |
| 174 |
|
|
#undef ALLOW_SEAICE_COST_SMR_AREA |
| 175 |
|
|
|
| 176 |
jmc |
1.52 |
#endif /* ALLOW_SEAICE */ |
| 177 |
edhill |
1.7 |
#endif /* SEAICE_OPTIONS_H */ |
| 178 |
edhill |
1.12 |
|
| 179 |
|
|
CEH3 ;;; Local Variables: *** |
| 180 |
|
|
CEH3 ;;; mode:fortran *** |
| 181 |
|
|
CEH3 ;;; End: *** |
Parent Directory
| 
Revision Log
| 
Revision Graph