/[MITgcm]/MITgcm/model/inc/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/model/inc/CPP_OPTIONS.h

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

revision 1.22.2.1 by adcroft, Wed Oct 1 20:43:17 2003 UTC revision 1.38 by dimitri, Thu Apr 5 22:51:48 2007 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4  C CPP flags controlling particular source code features  #ifndef CPP_OPTIONS_H
5    #define CPP_OPTIONS_H
 C o Include/exclude code for C-D grid method of integrating the  
 C   coriolis terms  
 #define  INCLUDE_CD_CODE  
6    
7  C o Include/exclude temperature forcing code  C CPP flags controlling particular source code features
 C#define  INCLUDE_T_FORCING_CODE  
8    
9  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
10  C Note: this should be a run-time option and not necessarily dependent on KPP  C Note: this should be a run-time option
11  #ifdef ALLOW_KPP  #undef SHORTWAVE_HEATING
 #define  SHORTWAVE_HEATING  
 #endif  
   
 C o Include/exclude momentum forcing code  
 #define INCLUDE_MOMENTUM_FORCING_CODE  
   
 C o Include/exclude momentum eqn metric terms code  
 #define INCLUDE_MOMENTUM_METRIC_TERM_CODE  
12    
13  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
14  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
# Line 31  C o Include/exclude call to S/R CONVECT Line 19  C o Include/exclude call to S/R CONVECT
19  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
20  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
21    
22  C o Allow nonHydrostatic code  C o Allow full 3D specification of vertical diffusivity
23  #define ALLOW_NONHYDROSTATIC  #undef ALLOW_3D_DIFFKR
24    
25    C o Include/exclude Implicit vertical advection code
26    #define INCLUDE_IMPLVERTADV_CODE
27    
28    C o Include/exclude AdamsBashforth-3rd-Order code
29    #undef ALLOW_ADAMSBASHFORTH_3
30    
31    C o Include/exclude nonHydrostatic code
32    #undef ALLOW_NONHYDROSTATIC
33    
34  C o Include pressure loading code  C o Include pressure loading code
35  #define ATMOSPHERIC_LOADING  #define ATMOSPHERIC_LOADING
36    
 C o Use "natural" boundary conditions for salinity  
 C   instead of the "virtual salt flux"  
 #undef  USE_NATURAL_BCS  
   
37  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C o Use "Exact Convervation" of fluid in Free-Surface formulation
38  C   so that d/dt(eta) is exactly equal to - Div.Transport  C   so that d/dt(eta) is exactly equal to - Div.Transport
39  #define EXACT_CONSERV  #define EXACT_CONSERV
40    
41  C o Allow the use of Non-Linear Free-Surface formulation  C o Allow the use of Non-Linear Free-Surface formulation
42  C   this implies that surface thickness (hFactors) vary with time  C   this implies that surface thickness (hFactors) vary with time
43  #define NONLIN_FRSURF  #undef NONLIN_FRSURF
44    
45    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
46    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
47    C *only for use on a lat-lon grid*
48    C   Setting this flag here affects both momentum and tracer equation unless
49    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
50    C   The definition of the flag is commented to avoid interference with
51    C   such other header files.
52    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
53    C   in data which is then automatically scaled by the grid size;
54    C   the old method of specifying viscAh/viscA4 and this flag is provided
55    C   for completeness only (and for use with the adjoint).
56    C#define ISOTROPIC_COS_SCALING
57    
58    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
59    C *only for use on a lat-lon grid*
60    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
61    C   Has no effect on vector invariant momentum equations.
62    C   Setting this flag here affects both momentum and tracer equation unless
63    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
64    C   The definition of the flag is commented to avoid interference with
65    C   such other header files.
66    C#define COSINEMETH_III
67    
68  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
69  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
70  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
71  #undef  OLD_ADV_BCS  #undef  OLD_ADV_BCS
72    
73  C o Use "OLD" UV geometry on sphere (definately *NOT* recommended)  C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
74  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
75  C          because the old code did not have no-slip BCs  C   is still useful with, e.g., single-domain curvilinear configurations.
76  #undef  OLD_UV_GEOMETRY  #undef OLD_GRID_IO
77    
78  C o Execution environment support options  C o Execution environment support options
79  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
80    
81  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude code specific to the ECCO/SEALION version.
82  #undef INCLUDE_ECCO_PACKAGE  C   AUTODIFF or EXF package.
83  #ifdef INCLUDE_ECCO_PACKAGE  C   Currently controled by a single header file
84  #include "ECCO_CPPOPTIONS.h"  C   For this to work, PACKAGES_CONFIG.h needs to be included!
85  #endif  cph#if (defined (ALLOW_AUTODIFF) || \
86    cph     defined (ALLOW_ECCO) || \
87    cph     defined (ALLOW_EXF))
88    cph# include "ECCO_CPPOPTIONS.h"
89    cph#endif
90    
91    #endif /* CPP_OPTIONS_H */
92    
Legend:
Removed from v.1.22.2.1  
changed lines
  Added in v.1.38
  ViewVC Help
Powered by ViewVC 1.1.22