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

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

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

revision 1.13 by heimbach, Mon Oct 31 03:20:59 2011 UTC revision 1.27 by gforget, Wed Oct 1 16:06:24 2014 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  #define SEAICE_MULTICATEGORY  C--   run with sea Ice Thickness Distribution (ITD);
45    C     set number of categories (nITD) in SEAICE_SIZE.h
46  C--   Use the Old version of seaice_growth (close to cvs version 1.70)  #undef SEAICE_ITD
47  C     otherwise, use the merged version (with some of Ian Fenty s code)  
48  #define SEAICE_GROWTH_LEGACY  C--   Since the missing sublimation term is now included
49    C     this flag is needed for backward compatibility
50  C--   options only available in the merged version (from Ian Fenty s code)  #define SEAICE_DISABLE_SUBLIM
51  #ifndef SEAICE_GROWTH_LEGACY  
52  C-    to switch on/off open-water freezing contribution to thickness tendency:  C--   Suspected missing term in coupled ocn-ice heat budget (to be confirmed)
53  #define SEAICE_DO_OPEN_WATER_GROWTH  #define SEAICE_DISABLE_HEATCONSFIX
54  C-    to switch on/off ocean heat contribution to seaice cover reduction:  
55  #define SEAICE_OCN_MELT_ACT_ON_AREA  C--   Default is constant seaice salinity (SEAICE_salt0); Define the following
56  #endif  C     flag to consider (space & time) variable salinity: advected and forming
57    C     seaice with a fraction (=SEAICE_saltFrac) of freezing seawater salinity.
58  C--   Use the Old version of seaice_solve4temp (formerly seaice_budget_ice)  C- Note: SItracer also offers an alternative way to handle variable salinity.
 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.  
 #undef 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.  
59  #define SEAICE_VARIABLE_SALINITY  #define SEAICE_VARIABLE_SALINITY
60    
61  C--   Track sea ice age.  C--   Tracers of ice and/or ice cover.
62  #undef SEAICE_AGE  #undef ALLOW_SITRACER
63    #ifdef ALLOW_SITRACER
64    C--   To try avoid 'spontaneous generation' of tracer maxima by advdiff.
65    # define ALLOW_SITRACER_ADVCAP
66    #endif
67    
68  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
69  C     historical reasons). Define the following flag to use a new  C     historical reasons). Define the following flag to use a new
# Line 80  C     (not thoroughly) test version on a Line 72  C     (not thoroughly) test version on a
72    
73  C--   Only for the C-grid version it is possible to  C--   Only for the C-grid version it is possible to
74  #ifdef SEAICE_CGRID  #ifdef SEAICE_CGRID
75    C     enable JFNK code by defining the following flag
76    # undef SEAICE_ALLOW_JFNK
77    C     enable LSR to use global (multi-tile) tri-diagonal solver
78    # undef SEAICE_GLOBAL_3DIAG_SOLVER
79  C     enable EVP code by defining the following flag  C     enable EVP code by defining the following flag
80  # define SEAICE_ALLOW_EVP  # define SEAICE_ALLOW_EVP
81  # ifdef SEAICE_ALLOW_EVP  # ifdef SEAICE_ALLOW_EVP
82  C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit  C--   When set use SEAICE_zetaMin and SEAICE_evpDampC to limit viscosities
83  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  
84  #  undef SEAICE_ALLOW_CLIPZETA  #  undef SEAICE_ALLOW_CLIPZETA
85  # endif /* SEAICE_ALLOW_EVP */  # endif /* SEAICE_ALLOW_EVP */
86    C     regularize zeta to zmax with a smooth tanh-function instead
87    C     of a min(zeta,zmax). This improves convergence of iterative
88    C     solvers (Lemieux and Tremblay 2009, JGR). No effect on EVP
89    # undef SEAICE_ZETA_SMOOTHREG
90  C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)  C     allow the truncated ellipse rheology (runtime flag SEAICEuseTEM)
91  # undef SEAICE_ALLOW_TEM  # undef SEAICE_ALLOW_TEM
92    C     The adjoint compiler TAF complains the least (and gives the best code)
93    C     when SEAICE_VECTORIZE_LSR is defined, but this is a bit of a hack
94    # define SEAICE_VECTORIZE_LSR
95    # define SEAICE_LSR_ADJOINT_ITER
96  #else /* not SEAICE_CGRID, but old B-grid */  #else /* not SEAICE_CGRID, but old B-grid */
97  C--   By default for B-grid dynamics solver wind stress under sea-ice is  C--   By default for B-grid dynamics solver wind stress under sea-ice is
98  C     set to the same value as it would be if there was no sea-ice.  C     set to the same value as it would be if there was no sea-ice.
# 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    
 C--   When set use MAX_HEFF to cap sea ice thickness in seaice_growth  
 #undef SEAICE_CAP_HEFF  
112  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
113  #undef SEAICE_CAP_ICELOAD  #undef SEAICE_CAP_ICELOAD
114  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,
115  C--   not recommended  C     not recommended
116  #undef SEAICE_ALLOW_CLIPVELS  #undef SEAICE_ALLOW_CLIPVELS
117    C--   When set cap the sublimation latent heat flux in solve4temp according
118    C     to the available amount of ice+snow. Otherwise this term is treated
119    C     like all of the others -- residuals heat and fw stocks are passed to
120    C     the ocean at the end of seaice_growth in a conservative manner.
121    C     SEAICE_CAP_SUBLIM is not needed as of now, but kept just in case.
122    #undef SEAICE_CAP_SUBLIM
123    
124  C     enable free drift code  C--   Enable free drift code
125  #define SEAICE_ALLOW_FREEDRIFT  #define SEAICE_ALLOW_FREEDRIFT
126    
127    C--   pkg/seaice cost functions compile flags
128    c       >>> Sea-ice volume (requires pkg/cost)
129    #undef  ALLOW_COST_ICE
130    c       >>> Sea-ice misfit to obs (requires pkg/cost and ecco)
131    #define ALLOW_SEAICE_COST_SMR_AREA
132    
133    #endif /* ALLOW_SEAICE */
134  #endif /* SEAICE_OPTIONS_H */  #endif /* SEAICE_OPTIONS_H */
135    
136  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.27
  ViewVC Help
Powered by ViewVC 1.1.22