/[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.37 by mlosch,
Mon Oct 26 08:38:53 2009 UTC
+revision 1.67 by mlosch,
Sun Oct 28 10:25:40 2012 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--   The actual number of ice categories used to solve for seaice flux is
- C     When this flag is set, an 8-category calculation of ice
+ C     now a run-time parameter (SEAICE_multDim).
- C     thermodynamics is carried out in groatb.F
+ C     This CPP-flag will be completely removed soon (no longer in main code);
- C     Note the pickup_seaice.* generated by this option differ
+ C     it is just used to set default number of categories, i.e., =1 if undef,
- C     from those generated with the default 2-category model.
+ C     or =MULTDIM if defined (MULTDIM=7 in default SEAICE_SIZE.h).
- C     Therefore it is not possible to switch between the two
+ C     Note: be aware of pickup_seaice.* compatibility issues when restarting
- C     in the middle of an integration.
+ C     a simulation with a different number of categories.
- #undef SEAICE_MULTICATEGORY
+ c#define SEAICE_MULTICATEGORY
- C--   By default the freezing point of water is set to the value of
+ C--   Use the Old version of seaice_growth (close to cvs version 1.70)
- C     the parameter SEAICE_freeze (=-1.96 by default). To use a
+ C     otherwise, use the merged version (with some of Ian Fenty s code)
- C     simple linear dependence of the freezing point on salinity,
+ #undef SEAICE_GROWTH_LEGACY
- C     set the following flag (pressure is assumed to have no effect,
- C     which is a good assumption for the top 20 meters). With this
+ C--   Since the missing sublimation term is now included
- C     option defined the parameter SEAICE_freeze has no effect.
+ C     this flag is needed for backward compatibility
- #undef SEAICE_VARIABLE_FREEZING_POINT
+ #undef SEAICE_DISABLE_SUBLIM
- C--   Allow SEAICEuseFlooding, which converts snow to ice if submerged.
+ C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
- #define ALLOW_SEAICE_FLOODING
+ #undef SEAICE_DISABLE_HEATCONSFIX
- C--   By default sea ice is fresh.  Set following flag for salty ice.
+ C--   Default is constant seaice salinity (SEAICE_salt0); Define the following
- #undef SEAICE_SALINITY
+ C     flag to consider (space & time) variable salinity: advected and forming
+ 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--   Track sea ice age.
+ C--   By default the seaice model is discretized on a B-Grid (for
- #undef SEAICE_AGE
- 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 JFNK code by defining the following flag
+ # define SEAICE_ALLOW_JFNK
  C     enable EVP code by defining the following flag
- #define SEAICE_ALLOW_EVP
+ # define SEAICE_ALLOW_EVP
- #ifdef 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
- #undef SEAICE_ALLOW_CLIPZETA
+ # endif /* SEAICE_ALLOW_EVP */
- #endif /* SEAICE_ALLOW_EVP */
+ 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
+ # undef SEAICE_ALLOW_TEM
  #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.
  C     Define following CPP flag for B-grid ice-ocean stress coupling.
- #define SEAICE_BICE_STRESS
+ # define SEAICE_BICE_STRESS
  C--   By default for B-grid dynamics solver surface tilt is obtained
  C     indirectly via geostrophic velocities. Define following CPP
  C     in order to use ETAN instead.
- #define EXPLICIT_SSH_SLOPE
+ # 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 use MAX_HEFF to cap seaice thickness in seaice_growth;
+ C     currently only relevant for SEAICE_GROWTH_LEGACY
  #undef SEAICE_CAP_HEFF
+ C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
+ #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
+ CToM<<<
+ C--   run with sea ice thickness distribution;
+ C     set number of categories (nITD) in SIZE.h
+ #undef SEAICE_ITD
+ C
+ C--   SEAICE_ITD replaces SEAICE_MULTICATEGORY
+ #ifdef SEAICE_ITD
+ #undef SEAICE_MULTICATEGORY
+ #endif
+ C>>>ToM
+ #endif /* ALLOW_SEAICE */
  #endif /* SEAICE_OPTIONS_H */
  CEH3 ;;; Local Variables: ***

 Legend:



Removed from v.1.37
 


changed lines


 
Added in v.1.67
 Legend:



Removed from v.1.37
 


changed lines


 
Added in v.1.67
-Removed from v.1.37
+Added in v.1.67

	ViewVC Help
Powered by ViewVC 1.1.22