Back to home page

MITgcm

 
 

    


File indexing completed on 2023-09-16 05:11:07 UTC

view on githubraw file Latest commit 910e5c3e on 2023-09-15 15:45:07 UTC
83fe077e76 Patr*0001 #ifndef GMREDI_OPTIONS_H
                0002 #define GMREDI_OPTIONS_H
                0003 #include "PACKAGES_CONFIG.h"
51a370328b Patr*0004 #include "CPP_OPTIONS.h"
                0005 
910e5c3e29 Mart*0006 CBOP
                0007 C !ROUTINE: GMREDI_OPTIONS.h
                0008 C !INTERFACE:
                0009 C #include "GMREDI_OPTIONS.h"
                0010 
                0011 C !DESCRIPTION:
                0012 C *==================================================================*
                0013 C | CPP options file for GM/Redi package:
                0014 C | Control which optional features to compile in this package code.
                0015 C *==================================================================*
                0016 CEOP
                0017 
a589927d63 Jean*0018 #ifdef ALLOW_GMREDI
                0019 C     Package-specific Options & Macros go here
                0020 
83fe077e76 Patr*0021 C Designed to simplify the Ajoint code:
a589927d63 Jean*0022 C #define GMREDI_WITH_STABLE_ADJOINT
                0023 C -- exclude the clipping/tapering part of the code that is not used
83fe077e76 Patr*0024 #define GM_EXCLUDE_CLIPPING
51a370328b Patr*0025 #define GM_EXCLUDE_FM07_TAP
a589927d63 Jean*0026 #define GM_EXCLUDE_AC02_TAP
87049f71ad Jean*0027 #undef GM_EXCLUDE_TAPERING
                0028 #define GM_EXCLUDE_SUBMESO
                0029 
910e5c3e29 Mart*0030 C Allows to read-in background 3-D Redi and GM diffusivity coefficients
                0031 C Note: need these to be defined for use as control (pkg/ctrl) parameters
                0032 #undef GM_READ_K3D_REDI
                0033 #undef GM_READ_K3D_GM
                0034 
83fe077e76 Patr*0035 C This allows to use Visbeck et al formulation to compute K_GM+Redi
51a370328b Patr*0036 #undef GM_VISBECK_VARIABLE_K
a589927d63 Jean*0037 C Use old calculation (before 2007/05/24) of Visbeck etal K_GM+Redi
                0038 C (which depends on tapering scheme)
                0039 #undef OLD_VISBECK_CALC
83fe077e76 Patr*0040 
910e5c3e29 Mart*0041 C This allows the Bates et al formulation to calculate the
                0042 C bolus transport and K for Redi
                0043 #undef GM_BATES_K3D
                0044 #undef GM_BATES_PASSIVE
                0045 
83fe077e76 Patr*0046 C This allows the leading diagonal (top two rows) to be non-unity
                0047 C (a feature required when tapering adiabatically).
a589927d63 Jean*0048 #define GM_NON_UNITY_DIAGONAL
83fe077e76 Patr*0049 
                0050 C Allows to use different values of K_GM and K_Redi ; also to
                0051 C be used with the advective form (Bolus velocity) of GM
a589927d63 Jean*0052 #define GM_EXTRA_DIAGONAL
83fe077e76 Patr*0053 
                0054 C Allows to use the advective form (Bolus velocity) of GM
                0055 C  instead of the Skew-Flux form (=default)
a589927d63 Jean*0056 #define GM_BOLUS_ADVEC
83fe077e76 Patr*0057 
87049f71ad Jean*0058 C Allows to use the Boundary-Value-Problem method to evaluate GM Bolus transport
                0059 #undef GM_BOLUS_BVP
83fe077e76 Patr*0060 
910e5c3e29 Mart*0061 C Allow QG Leith variable viscosity to be added to GMRedi coefficient
                0062 #undef ALLOW_GM_LEITH_QG
                0063 
                0064 C Related to Adjoint-code:
                0065 #undef GM_AUTODIFF_EXCESSIVE_STORE
                0066 #undef GMREDI_MASK_SLOPES
                0067 
83fe077e76 Patr*0068 #endif /* ALLOW_GMREDI */
                0069 #endif /* GMREDI_OPTIONS_H */