/[MITgcm]/MITgcm/verification/1D_ocean_ice_column/code/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/verification/1D_ocean_ice_column/code/CPP_OPTIONS.h

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

revision 1.2 by jmc, Mon Jan 16 19:17:56 2012 UTC revision 1.3 by jmc, Thu Nov 2 17:53:45 2017 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    
7    CBOP
8    C !ROUTINE: CPP_OPTIONS.h
9    C !INTERFACE:
10    C #include "CPP_OPTIONS.h"
11    
12    C !DESCRIPTION:
13    C *==================================================================*
14    C | main CPP options file for the model:
15    C | Control which optional features to compile in model/src code.
16    C *==================================================================*
17    CEOP
18    
19  C CPP flags controlling particular source code features  C CPP flags controlling particular source code features
20    
21    C-- Forcing code options:
22    
23  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
24  C Note: this should be a run-time option  C Note: this should be a run-time option
25  #define SHORTWAVE_HEATING  #define SHORTWAVE_HEATING
26    
27    C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
28    #undef ALLOW_GEOTHERMAL_FLUX
29    
30    C o Allow to account for heating due to friction (and momentum dissipation)
31    #undef ALLOW_FRICTION_HEATING
32    
33    C o Allow mass source or sink of Fluid in the interior
34    C   (3-D generalisation of oceanic real-fresh water flux)
35    #undef ALLOW_ADDFLUID
36    
37    C o Include pressure loading code
38    #define ATMOSPHERIC_LOADING
39    
40    C o Include/exclude balancing surface forcing fluxes code
41    #undef ALLOW_BALANCE_FLUXES
42    
43    C o Include/exclude balancing surface forcing relaxation code
44    #undef ALLOW_BALANCE_RELAX
45    
46    C o Include/exclude checking for negative salinity
47    #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES
48    
49    C-- Options to discard parts of the main code:
50    
51    C o Exclude/allow external forcing-fields load
52    C   this allows to read & do simple linear time interpolation of oceanic
53    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
54    #undef EXCLUDE_FFIELDS_LOAD
55    
56  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
57  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
58    
59    C-- Vertical mixing code options:
60    
61  C o Include/exclude call to S/R CONVECT  C o Include/exclude call to S/R CONVECT
62  #define INCLUDE_CONVECT_CALL  #define INCLUDE_CONVECT_CALL
63    
64  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
65  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
66    
67    C o Allow full 3D specification of vertical diffusivity
68    #undef ALLOW_3D_DIFFKR
69    
70  C o Allow latitudinally varying BryanLewis79 vertical diffusivity  C o Allow latitudinally varying BryanLewis79 vertical diffusivity
71  #undef ALLOW_BL79_LAT_VARY  #undef ALLOW_BL79_LAT_VARY
72    
73    C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
74    C   this allows to account for partial-cell in vertical viscosity and diffusion,
75    C   either from grid-spacing reduction effect or as artificially enhanced mixing
76    C   near surface & bottom for too thin grid-cell
77    #undef EXCLUDE_PCELL_MIX_CODE
78    
79    C-- Time-stepping code options:
80    
81    C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
82    #undef ALLOW_SOLVE4_PS_AND_DRAG
83    
84  C o Include/exclude Implicit vertical advection code  C o Include/exclude Implicit vertical advection code
85  #define INCLUDE_IMPLVERTADV_CODE  #define INCLUDE_IMPLVERTADV_CODE
86    
87  C o Include/exclude AdamsBashforth-3rd-Order code  C o Include/exclude AdamsBashforth-3rd-Order code
88  #undef ALLOW_ADAMSBASHFORTH_3  #undef ALLOW_ADAMSBASHFORTH_3
89    
90  C o Include/exclude code for single reduction cg-solver  C-- Model formulation options:
 #undef ALLOW_SRCG  
91    
92  C o Include/exclude nonHydrostatic code  C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
93  #undef ALLOW_NONHYDROSTATIC  C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
94    #define EXACT_CONSERV
95    
96  C o Include pressure loading code  C o Allow the use of Non-Linear Free-Surface formulation
97  #define ATMOSPHERIC_LOADING  C   this implies that grid-cell thickness (hFactors) varies with time
98    #undef NONLIN_FRSURF
99    
100  C o exclude/allow external forcing-fields load  C o Include/exclude nonHydrostatic code
101  C   this allows to read & do simple linear time interpolation of oceanic  #undef ALLOW_NONHYDROSTATIC
 C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.  
 #undef EXCLUDE_FFIELDS_LOAD  
102    
103  C o Include/exclude GM-like eddy stress in momentum code  C o Include/exclude GM-like eddy stress in momentum code
104  #undef ALLOW_EDDYPSI  #undef ALLOW_EDDYPSI
105    
106  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C-- Algorithm options:
 C   so that d/dt(eta) is exactly equal to - Div.Transport  
 #define EXACT_CONSERV  
107    
108  C o Allow the use of Non-Linear Free-Surface formulation  C o Use Non Self-Adjoint (NSA) conjugate-gradient solver
109  C   this implies that surface thickness (hFactors) vary with time  #undef ALLOW_CG2D_NSA
 #undef NONLIN_FRSURF  
110    
111  C o Allow mass source or sink of Fluid in the interior  C o Include/exclude code for single reduction Conjugate-Gradient solver
112  C   (3-D generalisation of oceanic real-fresh water flux)  #undef ALLOW_SRCG
113  #undef ALLOW_ADDFLUID  
114    C o Choices for implicit solver routines solve_*diagonal.F
115    C   The following has low memory footprint, but not suitable for AD
116    #undef SOLVE_DIAGONAL_LOWMEMORY
117    C   The following one suitable for AD but does not vectorize
118    #undef SOLVE_DIAGONAL_KINNER
119    
120  C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when  C-- Retired code options:
 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))  
 C *only for use on a lat-lon grid*  
 C   Setting this flag here affects both momentum and tracer equation unless  
 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).  
 C   The definition of the flag is commented to avoid interference with  
 C   such other header files.  
 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid  
 C   in data which is then automatically scaled by the grid size;  
 C   the old method of specifying viscAh/viscA4 and this flag is provided  
 C   for completeness only (and for use with the adjoint).  
 C#define ISOTROPIC_COS_SCALING  
   
 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.  
 C *only for use on a lat-lon grid*  
 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.  
 C   Has no effect on vector invariant momentum equations.  
 C   Setting this flag here affects both momentum and tracer equation unless  
 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).  
 C   The definition of the flag is commented to avoid interference with  
 C   such other header files.  
 C#define COSINEMETH_III  
   
 C o Use "OLD" UV discretisation near boundaries (*not* recommended)  
 C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  
 C          because the old code did not have no-slip BCs  
 #undef  OLD_ADV_BCS  
121    
122  C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F  C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
123  C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO  C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
124  C   is still useful with, e.g., single-domain curvilinear configurations.  C   is still useful with, e.g., single-domain curvilinear configurations.
125  #undef OLD_GRID_IO  #undef OLD_GRID_IO
126    
127    C-- Other option files:
128    
129  C o Execution environment support options  C o Execution environment support options
130  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
131    
132  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude single header file containing multiple packages options
133  C   AUTODIFF or EXF package.  C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
134  C   Currently controled by a single header file  C   each of the above pkg get its own options from its specific option file.
135  C   For this to work, PACKAGES_CONFIG.h needs to be included!  C   Although this method, inherited from ECCO setup, has been traditionally
136  cph#if (defined (ALLOW_AUTODIFF) || \  C   used for all adjoint built, work is in progress to allow to use the
137  cph     defined (ALLOW_ECCO) || \  C   standard method also for adjoint built.
138  cph     defined (ALLOW_EXF))  c#ifdef PACKAGES_CONFIG_H
139  cph# include "ECCO_CPPOPTIONS.h"  c# include "ECCO_CPPOPTIONS.h"
140  cph#endif  c#endif
   
 C o Allow full 3D specification of vertical diffusivity  
 #ifdef ALLOW_DIFFKR_CONTROL  
 C - Need to be defined if using DIFFKR_CONTROL  
 C   (alternatively, could have put this in ECCO_CPPOPTIONS)  
 #define ALLOW_3D_DIFFKR  
 #else  
 C - otherwise, can be turned on or off hereafter:  
 #undef  ALLOW_3D_DIFFKR  
 #endif /* ALLOW_DIFFKR_CONTROL */  
141    
142  #endif /* CPP_OPTIONS_H */  #endif /* CPP_OPTIONS_H */
   
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.22