|
||||
File indexing completed on 2024-05-16 05:11:13 UTC
view on githubraw file Latest commit 0c90ef58 on 2024-05-15 16:50:06 UTC2e5beeb00f Patr*0001 #ifndef CPP_OPTIONS_H 0002 #define CPP_OPTIONS_H 0003 4dd7556535 Jean*0004 CBOP 0005 C !ROUTINE: CPP_OPTIONS.h 0006 C !INTERFACE: 0007 C #include "CPP_OPTIONS.h" 816b5c73de Patr*0008 4dd7556535 Jean*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 cf3f8e2629 Patr*0015 4dd7556535 Jean*0016 C CPP flags controlling particular source code features 0017 8c2719e888 Jean*0018 C-- Forcing code options: 0019 4dd7556535 Jean*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 816b5c73de Patr*0023 83210123b2 Jean*0024 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean 0025 #undef ALLOW_GEOTHERMAL_FLUX 0026 8c2719e888 Jean*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 #undef 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 0c90ef582a Jean*0052 C If defined, use same method (with pkg/autodiff compiled or not) for checking 0053 C when to load new reccord ; by default, use simpler method with pkg/autodiff. 0054 #define STORE_LOADEDREC_TEST 8c2719e888 Jean*0055 816b5c73de Patr*0056 C o Include/exclude phi_hyd calculation code 0057 #define INCLUDE_PHIHYD_CALCULATION_CODE 0058 0c90ef582a Jean*0059 C o Include/exclude sound speed calculation code 0060 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived 0061 C from EOS) 0062 #undef INCLUDE_SOUNDSPEED_CALC_CODE 0063 8c2719e888 Jean*0064 C-- Vertical mixing code options: 0065 0c90ef582a Jean*0066 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT 816b5c73de Patr*0067 #define INCLUDE_CONVECT_CALL 0068 0c90ef582a Jean*0069 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT_INI, turned off by 0070 C default because it is an unpopular historical left-over 0071 #undef INCLUDE_CONVECT_INI_CALL 0072 816b5c73de Patr*0073 C o Include/exclude call to S/R CALC_DIFFUSIVITY 0074 #define INCLUDE_CALC_DIFFUSIVITY_CALL 0075 4dd7556535 Jean*0076 C o Allow full 3D specification of vertical diffusivity 0c90ef582a Jean*0077 #undef ALLOW_3D_DIFFKR 4dd7556535 Jean*0078 0079 C o Allow latitudinally varying BryanLewis79 vertical diffusivity 0080 #undef ALLOW_BL79_LAT_VARY 0081 8c2719e888 Jean*0082 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing 0083 C this allows to account for partial-cell in vertical viscosity and diffusion, 0084 C either from grid-spacing reduction effect or as artificially enhanced mixing 0085 C near surface & bottom for too thin grid-cell 0086 #define EXCLUDE_PCELL_MIX_CODE 0087 0c90ef582a Jean*0088 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity 0089 C for tracers (after scaling by constant Prandtl number) 0090 #undef ALLOW_SMAG_3D_DIFFUSIVITY 0091 8c2719e888 Jean*0092 C-- Time-stepping code options: 0093 0094 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code 0095 #undef ALLOW_SOLVE4_PS_AND_DRAG 0096 4dd7556535 Jean*0097 C o Include/exclude Implicit vertical advection code 0098 #define INCLUDE_IMPLVERTADV_CODE 0099 0100 C o Include/exclude AdamsBashforth-3rd-Order code 0101 #undef ALLOW_ADAMSBASHFORTH_3 0102 0c90ef582a Jean*0103 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code 0104 #undef ALLOW_QHYD_STAGGER_TS 0105 8c2719e888 Jean*0106 C-- Model formulation options: 4dd7556535 Jean*0107 8c2719e888 Jean*0108 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation 0109 C that ensures that d/dt(eta) is exactly equal to - Div.Transport 4dd7556535 Jean*0110 #define EXACT_CONSERV 0111 0112 C o Allow the use of Non-Linear Free-Surface formulation 8c2719e888 Jean*0113 C this implies that grid-cell thickness (hFactors) varies with time 4dd7556535 Jean*0114 #define NONLIN_FRSURF 0c90ef582a Jean*0115 C o Disable code for rStar coordinate and/or code for Sigma coordinate 4dd7556535 Jean*0116 #define DISABLE_RSTAR_CODE 0117 #define DISABLE_SIGMA_CODE 0118 8c2719e888 Jean*0119 C o Include/exclude nonHydrostatic code 0120 #undef ALLOW_NONHYDROSTATIC 0121 0122 C o Include/exclude GM-like eddy stress in momentum code 0123 #undef ALLOW_EDDYPSI 0124 0125 C-- Algorithm options: 0126 0c90ef582a Jean*0127 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver 83210123b2 Jean*0128 #undef ALLOW_CG2D_NSA 0129 4dd7556535 Jean*0130 C o Include/exclude code for single reduction Conjugate-Gradient solver 0131 #undef ALLOW_SRCG 0132 0133 C o Choices for implicit solver routines solve_*diagonal.F 0134 C The following has low memory footprint, but not suitable for AD 0135 #undef SOLVE_DIAGONAL_LOWMEMORY 0136 C The following one suitable for AD but does not vectorize 0137 #undef SOLVE_DIAGONAL_KINNER 0138 0c90ef582a Jean*0139 C Implementation alternative (might be faster on some platforms ?) 0140 #undef USE_MASK_AND_NO_IF 0141 8c2719e888 Jean*0142 C-- Retired code options: 4dd7556535 Jean*0143 0c90ef582a Jean*0144 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when 0145 C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) 0146 C *only for use on a lat-lon grid* 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 The preferred method is specifying a value for viscAhGrid or viscA4Grid 0152 C in data which is then automatically scaled by the grid size; 0153 C the old method of specifying viscAh/viscA4 and this flag is provided 0154 C for completeness only (and for use with the adjoint). 0155 c#define ISOTROPIC_COS_SCALING 0156 0157 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. 0158 C *only for use on a lat-lon grid* 0159 C Has no effect if ISOTROPIC_COS_SCALING is undefined. 0160 C Has no effect on vector invariant momentum equations. 0161 C Setting this flag here affects both momentum and tracer equation unless 0162 C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). 0163 C The definition of the flag is commented to avoid interference with 0164 C such other header files. 0165 c#define COSINEMETH_III 0166 4dd7556535 Jean*0167 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F 0168 C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO 0169 C is still useful with, e.g., single-domain curvilinear configurations. 0170 #undef OLD_GRID_IO 816b5c73de Patr*0171 8c2719e888 Jean*0172 C-- Other option files: 0173 816b5c73de Patr*0174 C o Execution environment support options 0175 #include "CPP_EEOPTIONS.h" 0176 4dd7556535 Jean*0177 C o Include/exclude single header file containing multiple packages options 0178 C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where 0179 C each of the above pkg get its own options from its specific option file. 0180 C Although this method, inherited from ECCO setup, has been traditionally 0181 C used for all adjoint built, work is in progress to allow to use the 0182 C standard method also for adjoint built. 83210123b2 Jean*0183 c#ifdef PACKAGES_CONFIG_H 0184 c# include "ECCO_CPPOPTIONS.h" 0185 c#endif 816b5c73de Patr*0186 56f171e550 Jean*0187 #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 |