/[MITgcm]/MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/verification/1D_ocean_ice_column/code/SEAICE_OPTIONS.h

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

revision 1.1 by ifenty, Mon Mar 28 15:50:50 2011 UTC revision 1.16 by jmc, Thu Nov 15 20:12:02 2012 UTC
# Line 1  Line 1 
1  C $Header$  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
13  #define SEAICE_OPTIONS_H  #define SEAICE_OPTIONS_H
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--   The actual number of ice categories used to solve for seaice flux is
38  C     When this flag is set, an 8-category calculation of ice  C     now a run-time parameter (SEAICE_multDim).
39  C     thermodynamics is carried out in groatb.F  C     This CPP-flag will be completely removed soon (no longer in main code);
40  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,
41  C     from those generated with the default 2-category model.  C     or =MULTDIM if defined (MULTDIM=7 in default SEAICE_SIZE.h).
42  C     Therefore it is not possible to switch between the two  C     Note: be aware of pickup_seaice.* compatibility issues when restarting
43  C     in the middle of an integration.  C     a simulation with a different number of categories.
44  #undef SEAICE_MULTICATEGORY  #undef SEAICE_MULTICATEGORY
 #undef SEAICE_MODIFY_GROWTH_ADJ  
 #undef SEAICE_SIMPLIFY_GROWTH_ADJ  
45    
46  c     Use the McPhee Ocean-Ice heat flux  C--   run with sea Ice Thickness Distribution (ITD);
47  #define MCPHEE_OCEAN_ICE_HEAT_FLUX  C     set number of categories (nITD) in SEAICE_SIZE.h
48  #define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR  #undef SEAICE_ITD
   
 #define FENTY_DELTA_HEFF_OPEN_WATER_FLUXES  
 #define FENTY_OPEN_WATER_FLUXES_MELT_ICE  
   
 #define FENTY_AREA_EXPANSION_CONTRACTION  
   
 #undef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET  
49    
50    C--   SEAICE_ITD replaces SEAICE_MULTICATEGORY
51    #ifdef SEAICE_ITD
52    #undef SEAICE_MULTICATEGORY
53    #endif
54    
55    C--   Use the Old version of seaice_growth (close to cvs version 1.70)
56    C     otherwise, use the merged version (with some of Ian Fenty s code)
57    #undef SEAICE_GROWTH_LEGACY
58    #undef SEAICE_MODIFY_GROWTH_ADJ
59    
60  C--   By default cdm wind stress under sea-ice is set to the  C--   Since the missing sublimation term is now included
61  C     same value as it would be if there was no sea-ice.  C     this flag is needed for backward compatibility
62  C     This is a placeholder until a more physically-sensible  #define SEAICE_DISABLE_SUBLIM
63  C     stable solution is developed.  Apparently ocean stress  
64  C     that is based on sea-ice velocity can cause trouble in  C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
65  C     Arctic Ocean configurations.  This temporary solution  #define SEAICE_DISABLE_HEATCONSFIX
66  C     also corresponds to that adopted by CCSM-2.  For the  
67  C     adventurous user who requires ice-modified stress,  C--   Default is constant seaice salinity (SEAICE_salt0); Define the following
68  C     following options are available.  C     flag to consider (space & time) variable salinity: advected and forming
69  #undef SEAICE_ORIGINAL_BAD_ICE_STRESS  C     seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
70  #undef SEAICE_TEST_ICE_STRESS_1  C- Note: SItracer also offers an alternative way to handle variable salinity.
71    #define SEAICE_VARIABLE_SALINITY
72  C--   By default the freezing point of water is set to the value of  
73  C     the parameter SEAICE_freeze (=-1.96 by default). To use a  C--   Tracers of ice and/or ice cover.
74  C     simple linear dependence of the freezing point on salinity,  #undef ALLOW_SITRACER
75  C     set the following flag (pressure is assumed to have no effect,  #ifdef ALLOW_SITRACER
76  C     which is a good assumption for the top 20 meters). With this  C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff.
77  C     option defined the parameter SEAICE_freeze has no effect.  # define ALLOW_SITRACER_ADVCAP
78  #undef SEAICE_VARIABLE_FREEZING_POINT  #endif
79    
80  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
81  C     historical reasons). Define the following flag to use a new  C     historical reasons). Define the following flag to use a new
82  C     (not thoroughly) test version on a C-grid  C     (not thoroughly) test version on a C-grid
83  #define SEAICE_CGRID  #undef SEAICE_CGRID
84    
85  C--   Only for the C-grid version it is possible to enable EVP code by  C--   Only for the C-grid version it is possible to
 C     defining the following flag  
86  #ifdef SEAICE_CGRID  #ifdef SEAICE_CGRID
87  #define SEAICE_ALLOW_EVP  C     enable JFNK code by defining the following flag
88    # define SEAICE_ALLOW_JFNK
89    C     enable EVP code by defining the following flag
90    # define SEAICE_ALLOW_EVP
91    # ifdef SEAICE_ALLOW_EVP
92    C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
93    C     from below and above in seaice_evp: not necessary, and not recommended
94    #  undef SEAICE_ALLOW_CLIPZETA
95    # endif /* SEAICE_ALLOW_EVP */
96    C     regularize zeta to zmax with a smooth tanh-function instead
97    C     of a min(zeta,zmax). This improves convergence of iterative
98    C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
99    # undef SEAICE_ZETA_SMOOTHREG
100    C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
101    # undef SEAICE_ALLOW_TEM
102    #else /* not SEAICE_CGRID, but old B-grid */
103    C--   By default for B-grid dynamics solver wind stress under sea-ice is
104    C     set to the same value as it would be if there was no sea-ice.
105    C     Define following CPP flag for B-grid ice-ocean stress coupling.
106    # define SEAICE_BICE_STRESS
107    
108    C--   By default for B-grid dynamics solver surface tilt is obtained
109    C     indirectly via geostrophic velocities. Define following CPP
110    C     in order to use ETAN instead.
111    # define EXPLICIT_SSH_SLOPE
112    C--   Defining this flag turns on FV-discretization of the B-grid LSOR solver.
113    C     It is smoother and includes all metric terms, similar to C-grid solvers.
114    C     It is here for completeness, but its usefulness is unclear.
115    # undef SEAICE_LSRBNEW
116  #endif /* SEAICE_CGRID */  #endif /* SEAICE_CGRID */
117    
118  C--   Seaice flooding  C--   When set use MAX_HEFF to cap seaice thickness in seaice_growth;
119  #define ALLOW_SEAICE_FLOODING  C     currently only relevant for SEAICE_GROWTH_LEGACY
120    #undef SEAICE_CAP_HEFF
121  C--   By default sea ice is fresh.  Set following flag for salty ice.  C--   When set limit the Ice-Loading to mass of 1/5 of Surface ocean grid-box
122  #define SEAICE_SALINITY  #undef SEAICE_CAP_ICELOAD
123    C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
124    C     not recommended
125    #undef SEAICE_ALLOW_CLIPVELS
126    C--   When set cap the sublimation latent heat flux in solve4temp according
127    C     to the available amount of ice+snow. Otherwise this term is treated
128    C     like all of the others -- residuals heat and fw stocks are passed to
129    C     the ocean at the end of seaice_growth in a conservative manner.
130    C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
131    #undef SEAICE_CAP_SUBLIM
132    
133  c--   Enable modified sea-ice thermodynamic by Ian Fenty  C--   Enable free drift code
134  c--   Should improve adjoint, but doesnt work so far.  #undef SEAICE_ALLOW_FREEDRIFT
 #undef SEAICE_ALLOW_TD_IF  
135    
136    #endif /* ALLOW_SEAICE */
137  #endif /* SEAICE_OPTIONS_H */  #endif /* SEAICE_OPTIONS_H */
138    
139  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.16
  ViewVC Help
Powered by ViewVC 1.1.22