/[MITgcm]/MITgcm_contrib/high_res_cube/code-mods/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm_contrib/high_res_cube/code-mods/CPP_OPTIONS.h

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

revision 1.3 by dimitri, Sun Jan 25 00:27:25 2004 UTC revision 1.10 by dimitri, Mon Mar 19 20:31:59 2012 UTC
# Line 4  C $Name$ Line 4  C $Name$
4  #ifndef CPP_OPTIONS_H  #ifndef CPP_OPTIONS_H
5  #define CPP_OPTIONS_H  #define CPP_OPTIONS_H
6    
 #include "PACKAGES_CONFIG.h"  
   
7  C CPP flags controlling particular source code features  C CPP flags controlling particular source code features
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  #define  SHORTWAVE_HEATING  C Note: this should be a run-time option
11    #define SHORTWAVE_HEATING
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 20  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 latitudinally varying BryanLewis79 vertical diffusivity
23    #undef ALLOW_BL79_LAT_VARY
24    
25    C o Include/exclude Implicit vertical advection code
26    #undef INCLUDE_IMPLVERTADV_CODE
27    
28    C o Include/exclude AdamsBashforth-3rd-Order code
29    #undef ALLOW_ADAMSBASHFORTH_3
30    
31    C o Include/exclude code for single reduction cg-solver
32    #undef ALLOW_SRCG
33    
34  C o Include/exclude nonHydrostatic code  C o Include/exclude nonHydrostatic code
35  #undef ALLOW_NONHYDROSTATIC  #undef ALLOW_NONHYDROSTATIC
36    
37  C o Include pressure loading code  C o Include pressure loading code
38  #define ATMOSPHERIC_LOADING  #define ATMOSPHERIC_LOADING
39    
40    C o exclude/allow external forcing-fields load
41    C   this allows to read & do simple linear time interpolation of oceanic
42    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
43    #undef EXCLUDE_FFIELDS_LOAD
44    
45    C o Include/exclude GM-like eddy stress in momentum code
46    #undef ALLOW_EDDYPSI
47    
48  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C o Use "Exact Convervation" of fluid in Free-Surface formulation
49  C   so that d/dt(eta) is exactly equal to - Div.Transport  C   so that d/dt(eta) is exactly equal to - Div.Transport
50  #define EXACT_CONSERV  #define EXACT_CONSERV
# Line 34  C o Allow the use of Non-Linear Free-Sur Line 53  C o Allow the use of Non-Linear Free-Sur
53  C   this implies that surface thickness (hFactors) vary with time  C   this implies that surface thickness (hFactors) vary with time
54  #define NONLIN_FRSURF  #define NONLIN_FRSURF
55    
56    C o Allow mass source or sink of Fluid in the interior
57    C   (3-D generalisation of oceanic real-fresh water flux)
58    #undef ALLOW_ADDFLUID
59    
60    C o Choices for implicit solver routines solve_*diagonal.F
61    C   The following has low memory footprint, but not suitable for AD
62    #undef SOLVE_DIAGONAL_LOWMEMORY
63    C   The following one suitable for AD but does not vectorize
64    #undef SOLVE_DIAGONAL_KINNER
65    
66    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
67    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
68    C *only for use on a lat-lon grid*
69    C   Setting this flag here affects both momentum and tracer equation unless
70    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
71    C   The definition of the flag is commented to avoid interference with
72    C   such other header files.
73    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
74    C   in data which is then automatically scaled by the grid size;
75    C   the old method of specifying viscAh/viscA4 and this flag is provided
76    C   for completeness only (and for use with the adjoint).
77    C#define ISOTROPIC_COS_SCALING
78    
79    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
80    C *only for use on a lat-lon grid*
81    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
82    C   Has no effect on vector invariant momentum equations.
83    C   Setting this flag here affects both momentum and tracer equation unless
84    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
85    C   The definition of the flag is commented to avoid interference with
86    C   such other header files.
87    C#define COSINEMETH_III
88    
89  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
90  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
91  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
92  #undef  OLD_ADV_BCS  #undef  OLD_ADV_BCS
93    
94    C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
95    C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
96    C   is still useful with, e.g., single-domain curvilinear configurations.
97    #undef OLD_GRID_IO
98    
99  C o Execution environment support options  C o Execution environment support options
100  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
101    
# Line 46  C o Include/exclude code specific to the Line 103  C o Include/exclude code specific to the
103  C   AUTODIFF or EXF package.  C   AUTODIFF or EXF package.
104  C   Currently controled by a single header file  C   Currently controled by a single header file
105  C   For this to work, PACKAGES_CONFIG.h needs to be included!  C   For this to work, PACKAGES_CONFIG.h needs to be included!
106  #if (defined (ALLOW_AUTODIFF) || \  cph#if (defined (ALLOW_AUTODIFF) || \
107       defined (ALLOW_ECCO) || \  cph     defined (ALLOW_ECCO) || \
108       defined (ALLOW_EXF))  cph     defined (ALLOW_EXF))
109  # include "ECCO_CPPOPTIONS.h"  cph# include "ECCO_CPPOPTIONS.h"
110  #endif  cph#endif
111    
112  C o Configuration details specific to high-resolution cube-sphere  C o Allow full 3D specification of vertical diffusivity
113  #define HRCUBE  #ifdef ALLOW_DIFFKR_CONTROL
114    C - Need to be defined if using DIFFKR_CONTROL
115    C   (alternatively, could have put this in ECCO_CPPOPTIONS)
116    #define ALLOW_3D_DIFFKR
117    #else
118    C - otherwise, can be turned on or off hereafter:
119    #define ALLOW_3D_DIFFKR
120    #endif /* ALLOW_DIFFKR_CONTROL */
121    
122  #endif /* CPP_OPTIONS_H */  #endif /* CPP_OPTIONS_H */
123    

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

  ViewVC Help
Powered by ViewVC 1.1.22