|
||||
File indexing completed on 2018-03-02 18:45:31 UTC
view on githubraw file Latest commit add29e06 on 2018-01-31 20:35:05 UTC9d1f071b34 Jean*0001 #ifndef CPP_OPTIONS_H 0002 #define CPP_OPTIONS_H a368568840 Jean*0003 fec94e08e8 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 c3174171d2 Ed H*0016 C CPP flags controlling particular source code features a368568840 Jean*0017 8c2719e888 Jean*0018 C-- Forcing code options: 0019 c3174171d2 Ed H*0020 C o Shortwave heating as extra term in external_forcing.F 6d2df2a337 Jean*0021 C Note: this should be a run-time option b28d97e251 Jean*0022 #define SHORTWAVE_HEATING a368568840 Jean*0023 4c278c0ccc 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 #define ATMOSPHERIC_LOADING 0036 0037 C o Include/exclude balancing surface forcing fluxes code 0038 #define ALLOW_BALANCE_FLUXES 0039 0040 C o Include/exclude balancing surface forcing relaxation code 0041 #define 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 a368568840 Jean*0053 C o Include/exclude phi_hyd calculation code 0054 #define INCLUDE_PHIHYD_CALCULATION_CODE 0055 8c2719e888 Jean*0056 C-- Vertical mixing code options: 0057 a368568840 Jean*0058 C o Include/exclude call to S/R CONVECT c3174171d2 Ed H*0059 #define INCLUDE_CONVECT_CALL a368568840 Jean*0060 0061 C o Include/exclude call to S/R CALC_DIFFUSIVITY 0062 #define INCLUDE_CALC_DIFFUSIVITY_CALL 0063 fec94e08e8 Jean*0064 C o Allow full 3D specification of vertical diffusivity 0065 #undef ALLOW_3D_DIFFKR 0066 b28d97e251 Jean*0067 C o Allow latitudinally varying BryanLewis79 vertical diffusivity 0068 #undef ALLOW_BL79_LAT_VARY 0069 8c2719e888 Jean*0070 C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing 0071 C this allows to account for partial-cell in vertical viscosity and diffusion, 0072 C either from grid-spacing reduction effect or as artificially enhanced mixing 0073 C near surface & bottom for too thin grid-cell 0074 #undef EXCLUDE_PCELL_MIX_CODE 0075 0076 C-- Time-stepping code options: 6d2df2a337 Jean*0077 4c278c0ccc Jean*0078 C o Include/exclude combined Surf.Pressure and Drag Implicit solver code 0079 #define ALLOW_SOLVE4_PS_AND_DRAG 0080 8c2719e888 Jean*0081 C o Include/exclude Implicit vertical advection code 0082 #define INCLUDE_IMPLVERTADV_CODE 0083 983f9ba41a Jean*0084 C o Include/exclude AdamsBashforth-3rd-Order code 0085 #undef ALLOW_ADAMSBASHFORTH_3 0086 8c2719e888 Jean*0087 C-- Model formulation options: fec94e08e8 Jean*0088 8c2719e888 Jean*0089 C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation 0090 C that ensures that d/dt(eta) is exactly equal to - Div.Transport 0091 #define EXACT_CONSERV b28d97e251 Jean*0092 8c2719e888 Jean*0093 C o Allow the use of Non-Linear Free-Surface formulation 0094 C this implies that grid-cell thickness (hFactors) varies with time 0095 #define NONLIN_FRSURF f8cdff35cc Jean*0096 8c2719e888 Jean*0097 C o Include/exclude nonHydrostatic code 0098 #define ALLOW_NONHYDROSTATIC f8cdff35cc Jean*0099 02f25033b5 Jean*0100 C o Include/exclude GM-like eddy stress in momentum code 0101 #undef ALLOW_EDDYPSI 0102 8c2719e888 Jean*0103 C-- Algorithm options: a368568840 Jean*0104 8c2719e888 Jean*0105 C o Use Non Self-Adjoint (NSA) conjugate-gradient solver 0106 #undef ALLOW_CG2D_NSA a368568840 Jean*0107 fec94e08e8 Jean*0108 C o Include/exclude code for single reduction Conjugate-Gradient solver 0109 #define ALLOW_SRCG 02f25033b5 Jean*0110 f8cdff35cc Jean*0111 C o Choices for implicit solver routines solve_*diagonal.F 0112 C The following has low memory footprint, but not suitable for AD 0113 #undef SOLVE_DIAGONAL_LOWMEMORY 0114 C The following one suitable for AD but does not vectorize 0115 #undef SOLVE_DIAGONAL_KINNER 0116 8c2719e888 Jean*0117 C-- Retired code options: a368568840 Jean*0118 b28d97e251 Jean*0119 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F 0120 C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO 0121 C is still useful with, e.g., single-domain curvilinear configurations. 0122 #undef OLD_GRID_IO 0123 8c2719e888 Jean*0124 C-- Other option files: 4c278c0ccc Jean*0125 a368568840 Jean*0126 C o Execution environment support options 0127 #include "CPP_EEOPTIONS.h" 0128 f8cdff35cc Jean*0129 C o Include/exclude single header file containing multiple packages options 0130 C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where 0131 C each of the above pkg get its own options from its specific option file. 0132 C Although this method, inherited from ECCO setup, has been traditionally fec94e08e8 Jean*0133 C used for all adjoint built, work is in progress to allow to use the 0134 C standard method also for adjoint built. 0135 c#ifdef PACKAGES_CONFIG_H 0136 c# include "ECCO_CPPOPTIONS.h" 0137 c#endif 02f25033b5 Jean*0138 9d1f071b34 Jean*0139 #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 |