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

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

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

revision 1.3 by gforget, Wed May 25 19:36:04 2011 UTC revision 1.13 by dimitri, Sat Dec 22 00:52:05 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 22  C     This option is provided to allow u Line 25  C     This option is provided to allow u
25  C     on the thermodynamics component of the code only.  C     on the thermodynamics component of the code only.
26  C     Sea-ice dynamics can also be turned off at runtime  C     Sea-ice dynamics can also be turned off at runtime
27  C     using variable SEAICEuseDYNAMICS.  C     using variable SEAICEuseDYNAMICS.
28  #define SEAICE_ALLOW_DYNAMICS  #undef SEAICE_ALLOW_DYNAMICS
29    
30  C--   By default, the sea-ice package uses its own integrated bulk  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  C     formulae to compute fluxes (fu, fv, EmPmR, Qnet, and Qsw) over
# 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)
49    C     otherwise, use the merged version (with some of Ian Fenty s code)
50    #undef SEAICE_GROWTH_LEGACY
51  #undef SEAICE_MODIFY_GROWTH_ADJ  #undef SEAICE_MODIFY_GROWTH_ADJ
 #undef SEAICE_SIMPLIFY_GROWTH_ADJ  
   
 c     Use the McPhee Ocean-Ice heat flux  
 #define MCPHEE_OCEAN_ICE_HEAT_FLUX  
 #define GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR  
   
 #define SEAICE_DO_OPEN_WATER_GROWTH  
 #define SEAICE_DO_OPEN_WATER_MELT  
   
 #define FENTY_AREA_EXPANSION_CONTRACTION  
   
 #undef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET  
   
52    
53    C--   Since the missing sublimation term is now included
54    C     this flag is needed for backward compatibility
55    #define SEAICE_DISABLE_SUBLIM
56    
57    C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
58    #define SEAICE_DISABLE_HEATCONSFIX
59    
60    C--   Default is constant seaice salinity (SEAICE_salt0); Define the following
61    C     flag to consider (space & time) variable salinity: advected and forming
62    C     seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
63    C- Note: SItracer also offers an alternative way to handle variable salinity.
64    #define SEAICE_VARIABLE_SALINITY
65    
66  C--   By default cdm wind stress under sea-ice is set to the  C--   Tracers of ice and/or ice cover.
67  C     same value as it would be if there was no sea-ice.  #undef ALLOW_SITRACER
68  C     This is a placeholder until a more physically-sensible  #ifdef ALLOW_SITRACER
69  C     stable solution is developed.  Apparently ocean stress  C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff.
70  C     that is based on sea-ice velocity can cause trouble in  # define ALLOW_SITRACER_ADVCAP
71  C     Arctic Ocean configurations.  This temporary solution  #endif
 C     also corresponds to that adopted by CCSM-2.  For the  
 C     adventurous user who requires ice-modified stress,  
 C     following options are available.  
 #undef SEAICE_ORIGINAL_BAD_ICE_STRESS  
 #undef SEAICE_TEST_ICE_STRESS_1  
   
 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.  
 #undef SEAICE_VARIABLE_FREEZING_POINT  
72    
73  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
74  C     historical reasons). Define the following flag to use a new  C     historical reasons). Define the following flag to use a new
75  C     (not thoroughly) test version on a C-grid  C     (not thoroughly) test version on a C-grid
76  #define SEAICE_CGRID  #define SEAICE_CGRID
77    
78  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  
79  #ifdef SEAICE_CGRID  #ifdef SEAICE_CGRID
80  #define SEAICE_ALLOW_EVP  C     enable JFNK code by defining the following flag
81    # undef SEAICE_ALLOW_JFNK
82    C     enable LSR to use global (multi-tile) tri-diagonal solver
83    # undef SEAICE_GLOBAL_3DIAG_SOLVER
84    C     enable EVP code by defining the following flag
85    # define SEAICE_ALLOW_EVP
86    # ifdef SEAICE_ALLOW_EVP
87    C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
88    C     from below and above in seaice_evp: not necessary, and not recommended
89    #  undef SEAICE_ALLOW_CLIPZETA
90    # endif /* SEAICE_ALLOW_EVP */
91    C     regularize zeta to zmax with a smooth tanh-function instead
92    C     of a min(zeta,zmax). This improves convergence of iterative
93    C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
94    # undef SEAICE_ZETA_SMOOTHREG
95    C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
96    # undef SEAICE_ALLOW_TEM
97    #else /* not SEAICE_CGRID, but old B-grid */
98    C--   By default for B-grid dynamics solver wind stress under sea-ice is
99    C     set to the same value as it would be if there was no sea-ice.
100    C     Define following CPP flag for B-grid ice-ocean stress coupling.
101    # define SEAICE_BICE_STRESS
102    
103    C--   By default for B-grid dynamics solver surface tilt is obtained
104    C     indirectly via geostrophic velocities. Define following CPP
105    C     in order to use ETAN instead.
106    # define EXPLICIT_SSH_SLOPE
107    C--   Defining this flag turns on FV-discretization of the B-grid LSOR solver.
108    C     It is smoother and includes all metric terms, similar to C-grid solvers.
109    C     It is here for completeness, but its usefulness is unclear.
110    # undef SEAICE_LSRBNEW
111  #endif /* SEAICE_CGRID */  #endif /* SEAICE_CGRID */
112    
113  C--   Seaice flooding  C--   When set use MAX_HEFF to cap seaice thickness in seaice_growth;
114  #define ALLOW_SEAICE_FLOODING  C     currently only relevant for SEAICE_GROWTH_LEGACY
115    #undef SEAICE_CAP_HEFF
116  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
117  #define SEAICE_VARIABLE_SALINITY  #undef SEAICE_CAP_ICELOAD
118    C--   When set use SEAICE_clipVelocties = .true., to clip U/VICE at 40cm/s,
119    C     not recommended
120    #undef SEAICE_ALLOW_CLIPVELS
121    C--   When set cap the sublimation latent heat flux in solve4temp according
122    C     to the available amount of ice+snow. Otherwise this term is treated
123    C     like all of the others -- residuals heat and fw stocks are passed to
124    C     the ocean at the end of seaice_growth in a conservative manner.
125    C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
126    #undef SEAICE_CAP_SUBLIM
127    
128  c--   Enable modified sea-ice thermodynamic by Ian Fenty  C--   Enable free drift code
129  c--   Should improve adjoint, but doesnt work so far.  #undef SEAICE_ALLOW_FREEDRIFT
 #undef SEAICE_ALLOW_TD_IF  
130    
131    #endif /* ALLOW_SEAICE */
132  #endif /* SEAICE_OPTIONS_H */  #endif /* SEAICE_OPTIONS_H */
133    
134  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.13

  ViewVC Help
Powered by ViewVC 1.1.22