|
||||
File indexing completed on 2021-06-23 05:12:02 UTC
view on githubraw file Latest commit fe17fbd0 on 2021-06-18 21:03:59 UTCfb2c52cfd4 aver*0001 #ifndef CPP_OPTIONS_H 0002 #define CPP_OPTIONS_H 0003 0004 CBOP 0005 C !ROUTINE: CPP_OPTIONS.h 0006 C !INTERFACE: 0007 C #include "CPP_OPTIONS.h" 0008 0009 C !DESCRIPTION: 0010 C *==================================================================* 0011 C | main CPP options file for the model: 0012 C | Control which optional features to compile in model/src code. 0013 C *==================================================================* 0014 CEOP 0015 0016 C CPP flags controlling particular source code features 0017 0018 C-- Forcing code options: 0019 0020 C o Shortwave heating as extra term in external_forcing.F 0021 C Note: this should be a run-time option 0022 #undef SHORTWAVE_HEATING 0023 0024 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean 0025 #undef ALLOW_GEOTHERMAL_FLUX 0026 0027 C o Allow to account for heating due to friction (and momentum dissipation) 0028 #undef ALLOW_FRICTION_HEATING 0029 0030 C o Allow mass source or sink of Fluid in the interior 0031 C (3-D generalisation of oceanic real-fresh water flux) 0032 #undef ALLOW_ADDFLUID 0033 0034 C o Include pressure loading code 0035 #define ATMOSPHERIC_LOADING 0036 0037 C o Include/exclude balancing surface forcing fluxes code 0038 #undef ALLOW_BALANCE_FLUXES 0039 0040 C o Include/exclude balancing surface forcing relaxation code 0041 #undef ALLOW_BALANCE_RELAX 0042 0043 C o Include/exclude checking for negative salinity 0044 #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES 0045 0046 C-- Options to discard parts of the main code: 0047 0048 C o Exclude/allow external forcing-fields load 0049 C this allows to read & do simple linear time interpolation of oceanic 0050 C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. 0051 #undef EXCLUDE_FFIELDS_LOAD 0052 0053 C o Include/exclude phi_hyd calculation code 0054 #define INCLUDE_PHIHYD_CALCULATION_CODE 0055 0056 C o Include/exclude sound speed calculation code 0057 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived from EOS) 0058 #define INCLUDE_SOUNDSPEED_CALC_CODE 0059 0060 C-- Vertical mixing code options: 0061 0062 C o Include/exclude call to S/R CONVECT 0063 #define INCLUDE_CONVECT_CALL 0064 0065 C o Include/exclude call to S/R CALC_DIFFUSIVITY 0066 #define INCLUDE_CALC_DIFFUSIVITY_CALL 0067 0068 C o Allow full 3D specification of vertical diffusivity 0069 #undef ALLOW_3D_DIFFKR 0070 0071 C o Allow latitudinally varying BryanLewis79 vertical diffusivity 0072 #undef ALLOW_BL79_LAT_VARY 0073 0074 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing 0075 C this allows to account for partial-cell in vertical viscosity and diffusion, 0076 C either from grid-spacing reduction effect or as artificially enhanced mixing 0077 C near surface & bottom for too thin grid-cell 0078 #undef EXCLUDE_PCELL_MIX_CODE 0079 0080 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity 0081 C for tracers (after scaling by constant Prandtl number) 0082 #undef ALLOW_SMAG_3D_DIFFUSIVITY 0083 0084 C-- Time-stepping code options: 0085 0086 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code 0087 #undef ALLOW_SOLVE4_PS_AND_DRAG 0088 0089 C o Include/exclude Implicit vertical advection code 0090 #define INCLUDE_IMPLVERTADV_CODE 0091 0092 C o Include/exclude AdamsBashforth-3rd-Order code 0093 #undef ALLOW_ADAMSBASHFORTH_3 0094 0095 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code 0096 #undef ALLOW_QHYD_STAGGER_TS 0097 0098 C-- Model formulation options: 0099 0100 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation 0101 C that ensures that d/dt(eta) is exactly equal to - Div.Transport 0102 #define EXACT_CONSERV 0103 0104 C o Allow the use of Non-Linear Free-Surface formulation 0105 C this implies that grid-cell thickness (hFactors) varies with time 0106 #undef NONLIN_FRSURF 0107 0108 C o Include/exclude nonHydrostatic code 0109 #undef ALLOW_NONHYDROSTATIC 0110 0111 C o Include/exclude GM-like eddy stress in momentum code 0112 #undef ALLOW_EDDYPSI 0113 0114 C-- Algorithm options: 0115 0116 C o Use Non Self-Adjoint (NSA) conjugate-gradient solver 0117 #undef ALLOW_CG2D_NSA 0118 0119 C o Include/exclude code for single reduction Conjugate-Gradient solver 0120 #define ALLOW_SRCG 0121 0122 C o Choices for implicit solver routines solve_*diagonal.F 0123 C The following has low memory footprint, but not suitable for AD 0124 #undef SOLVE_DIAGONAL_LOWMEMORY 0125 C The following one suitable for AD but does not vectorize 0126 #undef SOLVE_DIAGONAL_KINNER 0127 0128 C-- Retired code options: 0129 0130 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when 0131 C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) 0132 C *only for use on a lat-lon grid* 0133 C Setting this flag here affects both momentum and tracer equation unless 0134 C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). 0135 C The definition of the flag is commented to avoid interference with 0136 C such other header files. 0137 C The preferred method is specifying a value for viscAhGrid or viscA4Grid 0138 C in data which is then automatically scaled by the grid size; 0139 C the old method of specifying viscAh/viscA4 and this flag is provided 0140 C for completeness only (and for use with the adjoint). 0141 C#define ISOTROPIC_COS_SCALING 0142 0143 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. 0144 C *only for use on a lat-lon grid* 0145 C Has no effect if ISOTROPIC_COS_SCALING is undefined. 0146 C Has no effect on vector invariant momentum equations. 0147 C Setting this flag here affects both momentum and tracer equation unless 0148 C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). 0149 C The definition of the flag is commented to avoid interference with 0150 C such other header files. 0151 C#define COSINEMETH_III 0152 0153 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F 0154 C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO 0155 C is still useful with, e.g., single-domain curvilinear configurations. 0156 #undef OLD_GRID_IO 0157 0158 C-- Other option files: 0159 0160 C o Execution environment support options 0161 #include "CPP_EEOPTIONS.h" 0162 0163 C o Include/exclude single header file containing multiple packages options 0164 C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where 0165 C each of the above pkg get its own options from its specific option file. 0166 C Although this method, inherited from ECCO setup, has been traditionally 0167 C used for all adjoint built, work is in progress to allow to use the 0168 C standard method also for adjoint built. 0169 c#ifdef PACKAGES_CONFIG_H 0170 c# include "ECCO_CPPOPTIONS.h" 0171 c#endif 0172 0173 #endif /* CPP_OPTIONS_H */
[ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
This page was automatically generated from https://github.com/MITgcm/MITgcm by the 2.2.1-MITgcm-0.1 LXR engine. The LXR team |