/[MITgcm]/MITgcm/pkg/seaice/SEAICE_OPTIONS.h

Diff of /MITgcm/pkg/seaice/SEAICE_OPTIONS.h

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

-revision 1.38 by dimitri,
Mon Mar  1 23:46:13 2010 UTC
+revision 1.81 by mlosch,
Fri Apr 28 17:20:33 2017 UTC
 Line 1
  C $Header$
  C $Name$
- C     /==========================================================\
+ C     *==========================================================*
- C     | SEAICE_OPTIONS.h                                         |
+ C     | SEAICE_OPTIONS.h
- C     | o CPP options file for sea ice package.                  |
+ C     | o CPP options file for sea ice package.
- C     |==========================================================|
+ C     *==========================================================*
- C     | Use this file for selecting options within the sea ice   |
+ C     | Use this file for selecting options within the sea ice
- C     | package.                                                 |
+ C     | package.
- C     \==========================================================/
+ C     *==========================================================*
  #ifndef SEAICE_OPTIONS_H
  #define SEAICE_OPTIONS_H
  #include "PACKAGES_CONFIG.h"
  #include "CPP_OPTIONS.h"
+ #ifdef ALLOW_SEAICE
+ C     Package-specific Options & Macros go here
  C--   Write "text-plots" of certain fields in STDOUT for debugging.
  #undef SEAICE_DEBUG
-Line 31 
 C     in a separate external package, fo
+Line 34 
 C     in a separate external package, fo
  C     modified for sea-ice effects by pkg/seaice.
  #define SEAICE_EXTERNAL_FLUXES
- C--   By default, the sea-ice package uses 2-category thermodynamics.
+ C--   Exclude Wind-Stress common block (in SEAICE.h). This option
- C     When this flag is set, an 8-category calculation of ice
+ C     should ALWAYS been left undef (just listed here for the record)
- C     thermodynamics is carried out in groatb.F
+ #undef SEAICE_EXCLUDE_WIND_STRESS
- C     Note the pickup_seaice.* generated by this option differ
- C     from those generated with the default 2-category model.
+ C--   This CPP flag has been retired.  The number of ice categories
- C     Therefore it is not possible to switch between the two
+ C     used to solve for seaice flux is now specified by run-time
- C     in the middle of an integration.
+ C     parameter SEAICE_multDim.
- #undef SEAICE_MULTICATEGORY
+ C     Note: be aware of pickup_seaice.* compatibility issues when
+ C     restarting a simulation with a different number of categories.
- C--   By default the freezing point of water is set to the value of
+ c#define SEAICE_MULTICATEGORY
- C     the parameter SEAICE_freeze (=-1.96 by default). To use a
- C     simple linear dependence of the freezing point on salinity,
+ C--   run with sea Ice Thickness Distribution (ITD);
- C     set the following flag (pressure is assumed to have no effect,
+ C     set number of categories (nITD) in SEAICE_SIZE.h
- C     which is a good assumption for the top 20 meters). With this
+ #undef SEAICE_ITD
- C     option defined the parameter SEAICE_freeze has no effect.
- #undef SEAICE_VARIABLE_FREEZING_POINT
+ C--   Since the missing sublimation term is now included
+ C     this flag is needed for backward compatibility
- C--   Allow SEAICEuseFlooding, which converts snow to ice if submerged.
+ #undef SEAICE_DISABLE_SUBLIM
- #define ALLOW_SEAICE_FLOODING
+ C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
- C--   By default sea ice is fresh.  Set following flag for salty ice.
+ #undef SEAICE_DISABLE_HEATCONSFIX
- #undef SEAICE_SALINITY
+ C--   Default is constant seaice salinity (SEAICE_salt0); Define the following
- C--   Track sea ice age.
+ C     flag to consider (space & time) variable salinity: advected and forming
- #undef SEAICE_AGE
+ C     seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
+ C- Note: SItracer also offers an alternative way to handle variable salinity.
+ #undef SEAICE_VARIABLE_SALINITY
+ C--   Tracers of ice and/or ice cover.
+ #undef ALLOW_SITRACER
+ #ifdef ALLOW_SITRACER
+ C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff.
+ # define ALLOW_SITRACER_ADVCAP
+ #endif
+ C--   Enable grease ice parameterization
+ C     The grease ice parameterization delays formation of solid
+ C     sea ice from frazil ice by a time constant and provides a
+ C     dynamic calculation of the initial solid sea ice thickness
+ C     HO as a function of winds, currents and available grease ice
+ C     volume. Grease ice does not significantly reduce heat loss
+ C     from the ocean in winter and area covered by grease is thus
+ C     handled like open water.
+ C     (For details see Smedsrud and Martin, 2014, Ann.Glac.)
+ C     Set SItrName(1) = 'grease' in namelist SEAICE_PARM03 in data.seaice
+ C     then output SItr01 is SItrNameLong(1) = 'grease ice volume fraction',
+ C     with SItrUnit(1) = '[0-1]', which needs to be multiplied by SIheff
+ C     to yield grease ice volume. Additionally, the actual grease ice
+ C     layer thickness (diagnostic SIgrsLT) can be saved.
+ #undef SEAICE_GREASE
+ C--   grease ice uses SItracer:
+ #ifdef SEAICE_GREASE
+ # define ALLOW_SITRACER
+ # define ALLOW_SITRACER_ADVCAP
+ #endif
  C--   By default the seaice model is discretized on a B-Grid (for
  C     historical reasons). Define the following flag to use a new
  C     (not thoroughly) test version on a C-grid
  #define SEAICE_CGRID
  C--   Only for the C-grid version it is possible to
  #ifdef SEAICE_CGRID
+ C     enable advection of sea ice momentum
+ # undef SEAICE_ALLOW_MOM_ADVECTION
+ C     enable JFNK code by defining the following flag
+ # define SEAICE_ALLOW_JFNK
+ C     enable Krylov code by defining the following flag
+ # define SEAICE_ALLOW_KRYLOV
+ C     enable LSR to use global (multi-tile) tri-diagonal solver
+ # undef SEAICE_GLOBAL_3DIAG_SOLVER
  C     enable EVP code by defining the following flag
  # define SEAICE_ALLOW_EVP
  # ifdef SEAICE_ALLOW_EVP
- C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit
+ C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
- C--   viscosities from below and above in seaice_evp
+ C     from below and above in seaice_evp: not necessary, and not recommended
- C--   not necessary, and not recommended
  #  undef SEAICE_ALLOW_CLIPZETA
  # endif /* SEAICE_ALLOW_EVP */
+ C     smooth regularization (without max-function) of delta for
+ C     better differentiability
+ # undef SEAICE_DELTA_SMOOTHREG
+ C     regularize zeta to zmax with a smooth tanh-function instead
+ C     of a min(zeta,zmax). This improves convergence of iterative
+ C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
+ # undef SEAICE_ZETA_SMOOTHREG
  C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
  # undef SEAICE_ALLOW_TEM
+ C     Use LSR vector code; not useful on non-vector machines, because it
+ C     slows down convergence considerably, but the extra iterations are
+ C     more than made up by the much faster code on vector machines. For
+ C     the only regularly test vector machine these flags a specified
+ C     in the build options file SUPER-UX_SX-8_sxf90_awi, so that we comment
+ C     them out here.
+ # undef SEAICE_VECTORIZE_LSR
+ C     Use zebra-method (alternate lines) for line-successive-relaxation
+ C     This modification improves the convergence of the vector code
+ C     dramatically, so that is may actually be useful in general, but
+ C     that needs to be tested. Can be used without vectorization options.
+ # undef SEAICE_LSR_ZEBRA
+ C     Use parameterisation of grounding ice for a better representation
+ C     of fastice in shallow seas
+ # undef SEAICE_ALLOW_BOTTOMDRAG
  #else /* not SEAICE_CGRID, but old B-grid */
  C--   By default for B-grid dynamics solver wind stress under sea-ice is
  C     set to the same value as it would be if there was no sea-ice.
-Line 84 
 C--   By default for B-grid dynamics sol
+Line 146 
 C--   By default for B-grid dynamics sol
  C     indirectly via geostrophic velocities. Define following CPP
  C     in order to use ETAN instead.
  # define EXPLICIT_SSH_SLOPE
+ C--   Defining this flag turns on FV-discretization of the B-grid LSOR solver.
+ C     It is smoother and includes all metric terms, similar to C-grid solvers.
+ C     It is here for completeness, but its usefulness is unclear.
+ # undef SEAICE_LSRBNEW
  #endif /* SEAICE_CGRID */
- C--   When set use MAX_HEFF to cap sea ice thickness in seaice_growth
+ C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
- #undef SEAICE_CAP_HEFF
+ #undef SEAICE_CAP_ICELOAD
  C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
- C--   not recommended
+ C     not recommended
  #undef SEAICE_ALLOW_CLIPVELS
+ C--   When set cap the sublimation latent heat flux in solve4temp according
+ C     to the available amount of ice+snow. Otherwise this term is treated
+ C     like all of the others -- residuals heat and fw stocks are passed to
+ C     the ocean at the end of seaice_growth in a conservative manner.
+ C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
+ #undef SEAICE_CAP_SUBLIM
+ C--   Enable free drift code
+ #undef SEAICE_ALLOW_FREEDRIFT
+ C--   pkg/seaice cost functions compile flags
+ c       >>> Sea-ice volume (requires pkg/cost)
+ #undef ALLOW_COST_ICE
+ c       >>> Sea-ice misfit to obs (requires pkg/cost and ecco)
+ #undef ALLOW_SEAICE_COST_SMR_AREA
+ #endif /* ALLOW_SEAICE */
  #endif /* SEAICE_OPTIONS_H */
  CEH3 ;;; Local Variables: ***

 Legend:



Removed from v.1.38
 


changed lines


 
Added in v.1.81
 Legend:



Removed from v.1.38
 


changed lines


 
Added in v.1.81
-Removed from v.1.38
+Added in v.1.81

	ViewVC Help
Powered by ViewVC 1.1.22