/[MITgcm]/MITgcm_contrib/heimbach/OpenAD/code_regress/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm_contrib/heimbach/OpenAD/code_regress/CPP_OPTIONS.h

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

revision 1.1 by utke, Tue Nov 20 15:20:57 2007 UTC revision 1.2 by utke, Fri Aug 22 21:46:52 2008 UTC
# Line 1  Line 1 
 C  
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
 C CPP flags controlling which code in included in the files that  
 C will be compiled.  
   
4  #ifndef CPP_OPTIONS_H  #ifndef CPP_OPTIONS_H
5  #define CPP_OPTIONS_H  #define CPP_OPTIONS_H
6    
7  #include "PACKAGES_CONFIG.h"  #include "PACKAGES_CONFIG.h"
8    
9    C CPP flags controlling particular source code features
10    
11    C o Shortwave heating as extra term in external_forcing.F
12    C Note: this should be a run-time option
13  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
14  #define  SHORTWAVE_HEATING  #define  SHORTWAVE_HEATING
15  #endif  #endif
# Line 23  C o Include/exclude call to S/R CONVECT Line 23  C o Include/exclude call to S/R CONVECT
23  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
24  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
25    
26  C o Allow nonHydrostatic code  C o Allow latitudinally varying BryanLewis79 vertical diffusivity
27  #undef  ALLOW_NONHYDROSTATIC  #undef ALLOW_BL79_LAT_VARY
28    
29    C o Include/exclude Implicit vertical advection code
30    C#define INCLUDE_IMPLVERTADV_CODE
31    
32    C o Include/exclude AdamsBashforth-3rd-Order code
33    #undef ALLOW_ADAMSBASHFORTH_3
34    
35    C o Include/exclude nonHydrostatic code
36    #undef ALLOW_NONHYDROSTATIC
37    
38  C o Exact volume conservation  C o Include pressure loading code
39    C#define ATMOSPHERIC_LOADING
40    
41    C o exclude/allow external forcing-fields load
42    C   this allows to read & do simple linear time interpolation of oceanic
43    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
44    #undef EXCLUDE_FFIELDS_LOAD
45    
46    C o Include/exclude GM-like eddy stress in momentum code
47    #undef ALLOW_EDDYPSI
48    
49    C o Use "Exact Convervation" of fluid in Free-Surface formulation
50    C   so that d/dt(eta) is exactly equal to - Div.Transport
51  #undef EXACT_CONSERV  #undef EXACT_CONSERV
52    
53    C o Allow the use of Non-Linear Free-Surface formulation
54    C   this implies that surface thickness (hFactors) vary with time
55    #undef NONLIN_FRSURF
56    
57    C o Allow mass source or sink of Fluid in the interior
58    C   (3-D generalisation of oceanic real-fresh water flux)
59    #undef ALLOW_ADDFLUID
60    
61    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
62    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
63    C *only for use on a lat-lon grid*
64    C   Setting this flag here affects both momentum and tracer equation unless
65    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
66    C   The definition of the flag is commented to avoid interference with
67    C   such other header files.
68    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
69    C   in data which is then automatically scaled by the grid size;
70    C   the old method of specifying viscAh/viscA4 and this flag is provided
71    C   for completeness only (and for use with the adjoint).
72    C#define ISOTROPIC_COS_SCALING
73    
74    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
75    C *only for use on a lat-lon grid*
76    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
77    C   Has no effect on vector invariant momentum equations.
78    C   Setting this flag here affects both momentum and tracer equation unless
79    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
80    C   The definition of the flag is commented to avoid interference with
81    C   such other header files.
82    C#define COSINEMETH_III
83    
84    C o Use "OLD" UV discretisation near boundaries (*not* recommended)
85    C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
86    C          because the old code did not have no-slip BCs
87    C#undef  OLD_ADV_BCS
88    
89    C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
90    C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
91    C   is still useful with, e.g., single-domain curvilinear configurations.
92    C#undef OLD_GRID_IO
93    
94  C o Execution environment support options  C o Execution environment support options
95  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
96    
97  #ifdef ALLOW_AUTODIFF  C o Include/exclude code specific to the ECCO/SEALION version.
98    C   AUTODIFF or EXF package.
99    C   Currently controled by a single header file
100    C   For this to work, PACKAGES_CONFIG.h needs to be included!
101    #if (defined (ALLOW_AUTODIFF) || \
102         defined (ALLOW_ECCO) || \
103         defined (ALLOW_EXF))
104  # include "ECCO_CPPOPTIONS.h"  # include "ECCO_CPPOPTIONS.h"
105  #endif  #endif
106    
107    C o Allow full 3D specification of vertical diffusivity
108    #ifdef ALLOW_DIFFKR_CONTROL
109    C - Need to be defined if using DIFFKR_CONTROL
110    C   (alternatively, could have put this in ECCO_CPPOPTIONS)
111    #define ALLOW_3D_DIFFKR
112    #else
113    C - otherwise, can be turned on or off hereafter:
114    #undef  ALLOW_3D_DIFFKR
115    #endif /* ALLOW_DIFFKR_CONTROL */
116    
117  #endif /* CPP_OPTIONS_H */  #endif /* CPP_OPTIONS_H */
118    
119    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

  ViewVC Help
Powered by ViewVC 1.1.22