![]() |
|
|||
File indexing completed on 2024-11-30 06:10:25 UTC
view on githubraw file Latest commit 7bb5a8a1 on 2024-11-29 14:30:55 UTC417e03a214 Ed H*0001 #ifndef CPP_OPTIONS_H 0002 #define CPP_OPTIONS_H 0003 b30dcaee27 Jean*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 6d54cf9ca1 Ed H*0016 C CPP flags controlling particular source code features ba5f5f4485 Jean*0017 d4bae8cf47 Jean*0018 C-- Forcing code options: 0019 7bb5a8a109 Jean*0020 C o Shortwave heating as extra term in APPLY_FORCING_T (apply_forcing.F) ac0407fdce Jean*0021 #undef SHORTWAVE_HEATING 1dbaea09ee Chri*0022 238dcc4694 Jean*0023 C o Include/exclude Geothermal Heat Flux at the bottom of the ocean 0024 #undef ALLOW_GEOTHERMAL_FLUX 0025 d4bae8cf47 Jean*0026 C o Allow to account for heating due to friction (and momentum dissipation) 0027 #undef ALLOW_FRICTION_HEATING 0028 0029 C o Allow mass source or sink of Fluid in the interior 0030 C (3-D generalisation of oceanic real-fresh water flux) 0031 #undef ALLOW_ADDFLUID 0032 0033 C o Include pressure loading code 0034 #define ATMOSPHERIC_LOADING 0035 0036 C o Include/exclude balancing surface forcing fluxes code 0037 #undef ALLOW_BALANCE_FLUXES 0038 0039 C o Include/exclude balancing surface forcing relaxation code 0040 #undef ALLOW_BALANCE_RELAX 0041 0042 C o Include/exclude checking for negative salinity 0043 #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES 0044 0045 C-- Options to discard parts of the main code: 0046 0047 C o Exclude/allow external forcing-fields load 0048 C this allows to read & do simple linear time interpolation of oceanic 0049 C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. 0050 #undef EXCLUDE_FFIELDS_LOAD 3156f625d5 Jean*0051 C If defined, use same method (with pkg/autodiff compiled or not) for checking 0052 C when to load new reccord ; by default, use simpler method with pkg/autodiff. 0053 #undef STORE_LOADEDREC_TEST d4bae8cf47 Jean*0054 1dbaea09ee Chri*0055 C o Include/exclude phi_hyd calculation code 0056 #define INCLUDE_PHIHYD_CALCULATION_CODE 0057 fb2c52cfd4 aver*0058 C o Include/exclude sound speed calculation code 51575f66de Mart*0059 C o (Note that this is a diagnostic from Del Grasso algorithm, not derived 0060 C from EOS) fb2c52cfd4 aver*0061 #undef INCLUDE_SOUNDSPEED_CALC_CODE 0062 d4bae8cf47 Jean*0063 C-- Vertical mixing code options: 0064 51575f66de Mart*0065 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT 1dbaea09ee Chri*0066 #define INCLUDE_CONVECT_CALL 0067 51575f66de Mart*0068 C o Include/exclude calling S/R CONVECTIVE_ADJUSTMENT_INI, turned off by 0069 C default because it is an unpopular historical left-over 0070 #undef INCLUDE_CONVECT_INI_CALL 0071 1dbaea09ee Chri*0072 C o Include/exclude call to S/R CALC_DIFFUSIVITY 0073 #define INCLUDE_CALC_DIFFUSIVITY_CALL ea212a0263 Alis*0074 b30dcaee27 Jean*0075 C o Allow full 3D specification of vertical diffusivity 0076 #undef ALLOW_3D_DIFFKR 0077 e40c34e398 Dimi*0078 C o Allow latitudinally varying BryanLewis79 vertical diffusivity 0079 #undef ALLOW_BL79_LAT_VARY 0080 d4bae8cf47 Jean*0081 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing 0082 C this allows to account for partial-cell in vertical viscosity and diffusion, 0083 C either from grid-spacing reduction effect or as artificially enhanced mixing 0084 C near surface & bottom for too thin grid-cell 0085 #undef EXCLUDE_PCELL_MIX_CODE 0086 2d5bb917cc Jean*0087 C o Exclude/allow to use isotropic 3-D Smagorinsky viscosity as diffusivity 0088 C for tracers (after scaling by constant Prandtl number) 0089 #undef ALLOW_SMAG_3D_DIFFUSIVITY 0090 d4bae8cf47 Jean*0091 C-- Time-stepping code options: c0be2284a6 Jean*0092 795d169011 Jean*0093 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code 0094 #undef ALLOW_SOLVE4_PS_AND_DRAG 0095 d4bae8cf47 Jean*0096 C o Include/exclude Implicit vertical advection code 0097 #define INCLUDE_IMPLVERTADV_CODE 0098 87d21912d2 Jean*0099 C o Include/exclude AdamsBashforth-3rd-Order code 0100 #undef ALLOW_ADAMSBASHFORTH_3 0101 fdf5fb6af0 Jean*0102 C o Include/exclude Quasi-Hydrostatic Stagger Time-step AdamsBashforth code 0103 #undef ALLOW_QHYD_STAGGER_TS 0104 d4bae8cf47 Jean*0105 C-- Model formulation options: 22dbc402ed Jean*0106 d4bae8cf47 Jean*0107 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation 0108 C that ensures that d/dt(eta) is exactly equal to - Div.Transport 0109 #define EXACT_CONSERV 3b540d7094 Jean*0110 d4bae8cf47 Jean*0111 C o Allow the use of Non-Linear Free-Surface formulation 0112 C this implies that grid-cell thickness (hFactors) varies with time 0113 #undef NONLIN_FRSURF aecc8b0f47 Mart*0114 C o Disable code for rStar coordinate and/or code for Sigma coordinate 0115 c#define DISABLE_RSTAR_CODE 0116 c#define DISABLE_SIGMA_CODE 7ef88d9da2 Jean*0117 d4bae8cf47 Jean*0118 C o Include/exclude nonHydrostatic code 0119 #undef ALLOW_NONHYDROSTATIC 7ef88d9da2 Jean*0120 2b64c85b46 Jean*0121 C o Include/exclude GM-like eddy stress in momentum code 0122 #undef ALLOW_EDDYPSI 0123 d4bae8cf47 Jean*0124 C-- Algorithm options: aea29c8517 Alis*0125 aecc8b0f47 Mart*0126 C o Include/exclude code for Non Self-Adjoint (NSA) conjugate-gradient solver d4bae8cf47 Jean*0127 #undef ALLOW_CG2D_NSA aea29c8517 Alis*0128 b30dcaee27 Jean*0129 C o Include/exclude code for single reduction Conjugate-Gradient solver 0130 #define ALLOW_SRCG 2b64c85b46 Jean*0131 efd9855229 Patr*0132 C o Choices for implicit solver routines solve_*diagonal.F 0133 C The following has low memory footprint, but not suitable for AD f097220636 Jean*0134 #undef SOLVE_DIAGONAL_LOWMEMORY efd9855229 Patr*0135 C The following one suitable for AD but does not vectorize 0136 #undef SOLVE_DIAGONAL_KINNER 0137 f40bb882f5 Jean*0138 C Implementation alternative (might be faster on some platforms ?) 0139 #undef USE_MASK_AND_NO_IF 0140 d4bae8cf47 Jean*0141 C-- Retired code options: 0142 7bb5a8a109 Jean*0143 C- These 2 flags: ISOTROPIC_COS_SCALING & COSINEMETH_III have no effect 0144 C here as they are reset in GAD_OPTIONS.h and in MOM_COMMON_OPTIONS.h 0145 C for tracer diffusivity and momentum viscosity respectively 73545f9d8b Mart*0146 c1701ff971 Alis*0147 C o Use "OLD" UV discretisation near boundaries (*not* recommended) 734746fac8 Jean*0148 C Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE." c1701ff971 Alis*0149 C because the old code did not have no-slip BCs 734746fac8 Jean*0150 #undef OLD_ADV_BCS c1701ff971 Alis*0151 ea0385b2b8 Dimi*0152 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F 0153 C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO 0154 C is still useful with, e.g., single-domain curvilinear configurations. 0155 #undef OLD_GRID_IO 0156 734746fac8 Jean*0157 C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility) 0158 #undef USE_OLD_EXTERNAL_FORCING 0159 d4bae8cf47 Jean*0160 C-- Other option files: 0161 1dbaea09ee Chri*0162 C o Execution environment support options 73470161ee Alis*0163 #include "CPP_EEOPTIONS.h" e508fdf6c2 Patr*0164 7bb5a8a109 Jean*0165 C- Place where multi-pkg header file ECCO_CPPOPTIONS.h used to be included 2b64c85b46 Jean*0166 417e03a214 Ed H*0167 #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 |
![]() ![]() |