/[MITgcm]/MITgcm/verification/lab_sea/code/SEAICE_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/verification/lab_sea/code/SEAICE_OPTIONS.h

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

revision 1.18 by heimbach, Sat Mar 5 18:09:22 2011 UTC revision 1.31 by dimitri, Sat Dec 22 00:52:05 2012 UTC
# Line 2  C $Header$ Line 2  C $Header$
2  C $Name$  C $Name$
3    
4  C     *==========================================================*  C     *==========================================================*
5  C     | SEAICE_OPTIONS.h                                         |  C     | SEAICE_OPTIONS.h
6  C     | o CPP options file for sea ice package.                  |  C     | o CPP options file for sea ice package.
7  C     *==========================================================*  C     *==========================================================*
8  C     | Use this file for selecting options within the sea ice   |  C     | Use this file for selecting options within the sea ice
9  C     | package.                                                 |  C     | package.
10  C     *==========================================================*  C     *==========================================================*
11    
12  #ifndef SEAICE_OPTIONS_H  #ifndef SEAICE_OPTIONS_H
# Line 14  C     *================================= Line 14  C     *=================================
14  #include "PACKAGES_CONFIG.h"  #include "PACKAGES_CONFIG.h"
15  #include "CPP_OPTIONS.h"  #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.  C--   Write "text-plots" of certain fields in STDOUT for debugging.
21  #undef SEAICE_DEBUG  #undef SEAICE_DEBUG
22    
# Line 31  C     in a separate external package, fo Line 34  C     in a separate external package, fo
34  C     modified for sea-ice effects by pkg/seaice.  C     modified for sea-ice effects by pkg/seaice.
35  #define SEAICE_EXTERNAL_FLUXES  #define SEAICE_EXTERNAL_FLUXES
36    
37  C--   By default, the sea-ice package uses 2-category thermodynamics.  C--   This CPP flag has been retired.  The number of ice categories
38  C     When this flag is set, an 8-category calculation of ice  C     used to solve for seaice flux is now specified by run-time
39  C     thermodynamics is carried out in groatb.F  C     parameter SEAICE_multDim.
40  C     Note the pickup_seaice.* generated by this option differ  C     Note: be aware of pickup_seaice.* compatibility issues when
41  C     from those generated with the default 2-category model.  C     restarting a simulation with a different number of categories.
42  C     Therefore it is not possible to switch between the two  c#define SEAICE_MULTICATEGORY
43  C     in the middle of an integration.  
44  #undef SEAICE_MULTICATEGORY  C--   run with sea Ice Thickness Distribution (ITD);
45    C     set number of categories (nITD) in SEAICE_SIZE.h
46    #undef SEAICE_ITD
47    
48  C--   Use the Old version of seaice_growth (close to cvs version 1.70)  C--   Use the Old version of seaice_growth (close to cvs version 1.70)
49  C     otherwise, use the merged version (with some of Ian Fenty s code)  C     otherwise, use the merged version (with some of Ian Fenty s code)
50  #define SEAICE_GROWTH_LEGACY  #undef SEAICE_GROWTH_LEGACY
51    
52  C--   options only available in the merged version (from Ian Fenty s code)  C--   Since the missing sublimation term is now included
53  #ifndef SEAICE_GROWTH_LEGACY  C     this flag is needed for backward compatibility
54  C-    to switch on/off open-water freezing contribution to thickness tendency:  #undef SEAICE_DISABLE_SUBLIM
55  #define SEAICE_DO_OPEN_WATER_GROWTH  
56  C-    to switch on/off ocean heat contribution to seaice cover reduction:  C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
57  #define SEAICE_OCN_MELT_ACT_ON_AREA  #undef SEAICE_DISABLE_HEATCONSFIX
58    
59    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    #undef SEAICE_VARIABLE_SALINITY
64    
65    C--   Tracers of ice and/or ice cover.
66    #define 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  #endif
71    
 C--   Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)  
 C     otherwise, use Ian Fenty s version  
 #define SEAICE_SOLVE4TEMP_LEGACY  
   
 C--   By default the freezing point of water is set to the value of  
 C     the parameter SEAICE_freeze (=-1.96 by default). To use a  
 C     simple linear dependence of the freezing point on salinity,  
 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     option defined the parameter SEAICE_freeze has no effect.  
 #define SEAICE_VARIABLE_FREEZING_POINT  
   
 C--   Allow SEAICEuseFlooding, which converts snow to ice if submerged.  
 #define ALLOW_SEAICE_FLOODING  
   
 C--   By default sea ice is fresh.  Set following flag for salty ice.  
 #define SEAICE_SALINITY  
   
 C--   Track sea ice age.  
 #define SEAICE_AGE  
   
72  C--   By default the seaice model is discretized on a B-Grid (for  C--   By default the seaice model is discretized on a B-Grid (for
73  C     historical reasons). Define the following flag to use a new  C     historical reasons). Define the following flag to use a new
74  C     (not thoroughly) test version on a C-grid  C     (not thoroughly) test version on a C-grid
# Line 80  C     (not thoroughly) test version on a Line 76  C     (not thoroughly) test version on a
76    
77  C--   Only for the C-grid version it is possible to  C--   Only for the C-grid version it is possible to
78  #ifdef SEAICE_CGRID  #ifdef SEAICE_CGRID
79    C     enable JFNK code by defining the following flag
80    # undef SEAICE_ALLOW_JFNK
81    C     enable LSR to use global (multi-tile) tri-diagonal solver
82    # undef SEAICE_GLOBAL_3DIAG_SOLVER
83  C     enable EVP code by defining the following flag  C     enable EVP code by defining the following flag
84  # define SEAICE_ALLOW_EVP  # define SEAICE_ALLOW_EVP
85  # ifdef SEAICE_ALLOW_EVP  # ifdef SEAICE_ALLOW_EVP
86  C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit  C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
87  C--   viscosities from below and above in seaice_evp  C     from below and above in seaice_evp: not necessary, and not recommended
88  C--   not necessary, and not recommended  #  undef SEAICE_ALLOW_CLIPZETA
 #  define SEAICE_ALLOW_CLIPZETA  
89  # endif /* SEAICE_ALLOW_EVP */  # endif /* SEAICE_ALLOW_EVP */
90    C     regularize zeta to zmax with a smooth tanh-function instead
91    C     of a min(zeta,zmax). This improves convergence of iterative
92    C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
93    # undef SEAICE_ZETA_SMOOTHREG
94  C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)  C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
95  # undef SEAICE_ALLOW_TEM  # undef SEAICE_ALLOW_TEM
96  #else /* not SEAICE_CGRID, but old B-grid */  #else /* not SEAICE_CGRID, but old B-grid */
# Line 100  C--   By default for B-grid dynamics sol Line 103  C--   By default for B-grid dynamics sol
103  C     indirectly via geostrophic velocities. Define following CPP  C     indirectly via geostrophic velocities. Define following CPP
104  C     in order to use ETAN instead.  C     in order to use ETAN instead.
105  # define EXPLICIT_SSH_SLOPE  # define EXPLICIT_SSH_SLOPE
106    C--   Defining this flag turns on FV-discretization of the B-grid LSOR solver.
107    C     It is smoother and includes all metric terms, similar to C-grid solvers.
108    C     It is here for completeness, but its usefulness is unclear.
109    # undef SEAICE_LSRBNEW
110  #endif /* SEAICE_CGRID */  #endif /* SEAICE_CGRID */
111    
112  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;
113    C     currently only relevant for SEAICE_GROWTH_LEGACY
114  #undef SEAICE_CAP_HEFF  #undef SEAICE_CAP_HEFF
115  C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box  C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
116  #undef SEAICE_CAP_ICELOAD  #undef SEAICE_CAP_ICELOAD
117  C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,  C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
118  C--   not recommended  C     not recommended
119  #define SEAICE_ALLOW_CLIPVELS  #undef SEAICE_ALLOW_CLIPVELS
120    C--   When set cap the sublimation latent heat flux in solve4temp according
121    C     to the available amount of ice+snow. Otherwise this term is treated
122    C     like all of the others -- residuals heat and fw stocks are passed to
123    C     the ocean at the end of seaice_growth in a conservative manner.
124    C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
125    #undef SEAICE_CAP_SUBLIM
126    
127  C     enable free drift code  C--   Enable free drift code
128  #define SEAICE_ALLOW_FREEDRIFT  #define SEAICE_ALLOW_FREEDRIFT
129    
130    #endif /* ALLOW_SEAICE */
131  #endif /* SEAICE_OPTIONS_H */  #endif /* SEAICE_OPTIONS_H */
132    
133  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.18  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22