! $Id: cppdefs.h 1628 2015-01-10 13:53:00Z marchesiello $ ! !====================================================================== ! CROCO is a branch of ROMS developped at IRD and INRIA, in France ! The two other branches from UCLA (Shchepetkin et al) ! and Rutgers University (Arango et al) are under MIT/X style license. ! CROCO specific routines (nesting) are under CeCILL-C license. ! ! CROCO website : http://www.croco-ocean.org !====================================================================== ! /* This is "cppdefs.h": MODEL CONFIGURATION FILE ==== == ============ ===== ============= ==== */ #undef BASIN /* Basin Example */ #undef CANYON_A /* Canyon_A Example */ #undef CANYON_B /* Canyon_B Example */ #undef EQUATOR /* Equator Example */ #undef ACOUSTIC /* Acoustic wave test case */ #undef GRAV_ADJ /* Graviational Adjustment Example */ #undef KH_INST /* Kelvin-Helmholtz Instability Example */ #undef INNERSHELF /* Inner Shelf Example */ #undef RIVER /* River run-off Example */ #undef OVERFLOW /* Graviational/Overflow Example */ #undef SEAMOUNT /* Seamount Example */ #undef SHELFRONT /* Shelf Front Example */ #undef SOLITON /* Equatorial Rossby Wave Example */ #undef UPWELLING /* Upwelling Example */ #undef VORTEX /* Baroclinic Vortex Example */ #undef INTERNAL /* Internal Tide Example */ #undef IGW /* COMODO Internal Tide Example */ #undef JET /* Baroclinic Jet Example */ #undef RIP /* Rip Current Test Case */ #undef SHOREFACE /* Shoreface Test Case on a Planar Beach */ #undef FLUME /* Bar-generating Flume Example */ #undef SWASH /* Swash Test Case on a Planar Beach */ #undef THACKER /* Thacker wetting-drying Example */ #undef TANK /* Tank Example */ #undef S2DV /* 2D Vertical Section Application */ #define REGIONAL /* REGIONAL Applications */ #if defined REGIONAL /* !==================================================================== ! REGIONAL (realistic) Configurations !==================================================================== ! !---------------------- ! BASIC OPTIONS !---------------------- ! */ /* Configuration Name */ # define BENGUELA_LR /* Parallelization */ # undef OPENMP # define MPI /* I/O server */ # undef XIOS /* dedicated croco.log file */ # define LOGFILE /* Nesting */ # undef AGRIF # undef AGRIF_2WAY /* OA and OW Coupling via OASIS (MPI) */ # define OA_COUPLING # undef OW_COUPLING # undef OA_GRID_UV /* Wave-current interactions */ # undef MRL_WCI /* Open Boundary Conditions */ # undef TIDES # define OBC_EAST # define OBC_WEST # define OBC_NORTH # define OBC_SOUTH /* Applications */ # undef BIOLOGY # undef FLOATS # undef STATIONS # undef PASSIVE_TRACER # undef SEDIMENT # undef BBL /*! !------------------------------------------------- ! PRE-SELECTED OPTIONS ! ! ADVANCED OPTIONS ARE IN CPPDEFS_DEV.H !------------------------------------------------- */ /* Parallelization */ # ifdef MPI # undef PARALLEL_FILES # endif # undef AUTOTILING # undef ETALON_CHECK /* Grid configuration */ # define CURVGRID # define SPHERICAL # define MASKING # undef WET_DRY # define NEW_S_COORD /* Model dynamics */ # define SOLVE3D # define UV_COR # define UV_ADV /* Equation of State */ # define SALINITY # define NONLIN_EOS /* Lateral Momentum Advection (default UP3) */ # define UV_HADV_UP3 # undef UV_HADV_UP5 # undef UV_HADV_C4 # undef UV_HADV_WENO5 /* Lateral Explicit Momentum Mixing */ # undef UV_VIS2 # ifdef UV_VIS2 # define UV_VIS_SMAGO # endif /* Lateral Tracer Advection (default UP3) */ # undef TS_HADV_UP3 # define TS_HADV_RSUP3 # undef TS_HADV_UP5 # undef TS_HADV_C4 # undef TS_HADV_WENO5 /* Lateral Explicit Tracer Mixing */ # undef TS_DIF2 # undef TS_DIF4 # undef TS_MIX_S /* Sponge layers for UV and TS */ # define SPONGE /* Semi-implicit Vertical Tracer/Mom Advection */ # undef VADV_ADAPT_IMP /* Vertical Mixing */ # undef BODYFORCE # undef BVF_MIXING # define LMD_MIXING # undef GLS_MIXING # undef GLS_MIX2017 /* <--- Warning: option still under testing */ # ifdef LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_RIMIX # define LMD_CONVEC # undef LMD_DDMIX # define LMD_NONLOCAL # endif # ifdef GLS_MIXING # define GLS_KKL # undef GLS_KOMEGA # undef GLS_KEPSILON # undef GLS_GEN # undef KANTHA_CLAYSON # undef CRAIG_BANNER # undef CANUTO_A # undef ZOS_HSIG # endif # ifdef GLS_MIX2017 # undef GLS_KOMEGA # define GLS_KEPSILON # undef GLS_GEN # define CANUTO_A # undef GibLau_78 # undef MelYam_82 # undef KanCla_94 # undef Luyten_96 # undef CANUTO_B # undef Cheng_02 # endif /* Surface Forcing */ # undef BULK_FLUX # ifdef BULK_FLUX # define BULK_FAIRALL # define BULK_LW # define BULK_EP # define BULK_SMFLUX # undef SST_SKIN # undef ANA_DIURNAL_SW # undef ONLINE # undef ERA_ECMWF # undef RELATIVE_WIND # elif undef OA_COUPLING # define QCORRECTION # define SFLX_CORR # define ANA_DIURNAL_SW # endif # ifdef OA_COUPLING # undef BULK_FLUX # undef QCORRECTION # undef SFLX_CORR # undef ANA_DIURNAL_SW # endif /* Wave-current interactions */ # ifdef OW_COUPLING # define MRL_WCI # endif # ifdef MRL_WCI # undef WAVE_ROLLER # define WAVE_STREAMING # define WAVE_FRICTION # define WAVE_RAMP # undef WKB_WWAVE # ifdef WKB_WWAVE # undef WKB_OBC_NORTH # undef WKB_OBC_SOUTH # undef WKB_OBC_WEST # undef WKB_OBC_EAST # endif # undef WAVE_OFFLINE # endif /* Lateral Forcing */ # undef CLIMATOLOGY # ifdef CLIMATOLOGY # define ZCLIMATOLOGY # define M2CLIMATOLOGY # define M3CLIMATOLOGY # define TCLIMATOLOGY # define ZNUDGING # define M2NUDGING # define M3NUDGING # define TNUDGING # undef ROBUST_DIAG # endif # define FRC_BRY # ifdef FRC_BRY # define Z_FRC_BRY # define M2_FRC_BRY # define M3_FRC_BRY # define T_FRC_BRY # endif /* Bottom Forcing */ # define ANA_BSFLUX # define ANA_BTFLUX /* Point Sources - Rivers */ # undef PSOURCE # undef PSOURCE_NCFILE # ifdef PSOURCE_NCFILE # undef PSOURCE_NCFILE_TS # endif /* Open Boundary Conditions */ # ifdef TIDES # define SSH_TIDES # define UV_TIDES # undef POT_TIDES # define TIDERAMP # define OBC_M2FLATHER # else # undef OBC_M2SPECIFIED # undef OBC_M2FLATHER # define OBC_M2CHARACT # undef OBC_M2ORLANSKI # endif # define OBC_M3ORLANSKI # define OBC_TORLANSKI # undef OBC_M3SPECIFIED # undef OBC_TSPECIFIED /* Input/Output & Diagnostics */ # define AVERAGES # define AVERAGES_K # undef DIAGNOSTICS_TS # undef DIAGNOSTICS_UV # ifdef DIAGNOSTICS_TS # undef DIAGNOSTICS_TS_ADV # define DIAGNOSTICS_TS_MLD # endif /* ! Applications: !--------------------------------- ! Biology, floats, Stations, ! Passive tracer, Sediments, BBL !--------------------------------- ! Quasi-monotone lateral advection scheme (WENO5) for passive/biology/sediment tracers */ # if defined PASSIVE_TRACER || defined BIOLOGY || defined SEDIMENT # define BIO_HADV_WENO5 # endif /* Choice of Biology models */ # ifdef BIOLOGY # undef PISCES # undef BIO_NChlPZD # undef BIO_N2ChlPZD2 # define BIO_BioEBUS /* Biology options */ # ifdef PISCES # undef DIURNAL_INPUT_SRFLX # define key_pisces # endif # ifdef BIO_NChlPZD # define OXYGEN # endif # ifdef BIO_BioEBUS # define NITROUS_OXIDE # endif /* Biology diagnostics */ # define DIAGNOSTICS_BIO # if defined DIAGNOSTICS_BIO && defined PISCES # define key_trc_diaadd # define key_trc_dia3d # define key_iomput # endif # endif /* Lagrangian floats model */ # ifdef FLOATS # undef FLOATS_GLOBAL_ATTRIBUTES # undef IBM # undef RANDOM_WALK # ifdef RANDOM_WALK # define DIEL_MIGRATION # define RANDOM_VERTICAL # define RANDOM_HORIZONTAL # endif # endif /* Stations recording */ # ifdef STATIONS # define ALL_SIGMA # endif /* Sediment dynamics model */ # ifdef SEDIMENT # define ANA_SEDIMENT # undef ANA_SPFLUX # undef ANA_BPFLUX # endif /* Bottom Boundary Layer model */ # ifdef BBL # define ANA_WWAVE # endif /* ! !========================================================== ! IDEALIZED CONFIGURATIONS !========================================================== ! */ #elif defined BASIN /* ! Basin Example ! ===== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define UV_VIS2 # define SOLVE3D # define TS_DIF2 # define BODYFORCE # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX #elif defined CANYON_A /* ! First Canyon Example ! ===== ====== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define SOLVE3D # define EW_PERIODIC # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX #elif defined CANYON_B /* ! Second Canyon Example ! ====== ====== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define SOLVE3D # define EW_PERIODIC # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX # define ANA_VMIX #elif defined EQUATOR /* ! Equator Example ! ======= ======= ! Boccaletti, G., R.C. Pacanowski, G.H. Philander and A.V. Fedorov, 2004, ! The Thermal Structure of the Upper Ocean, J.Phys.Oceanogr., 34, 888-902. */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define UV_VIS2 # define SOLVE3D # define SALINITY # define TS_DIF2 # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SRFLUX # define ANA_SSFLUX # define ANA_BTFLUX # define ANA_BSFLUX # define QCORRECTION # define ANA_SST # define LMD_SKPP /* problem with MPI in Xi direction */ # define LMD_MIXING # define LMD_RIMIX # define LMD_CONVEC #elif defined KH_INST /* ! Kelvin-Helmholtz Instability Example ! ================ =========== ======= ! */ # undef OPENMP # define KH_INST2D # undef KH_INST3D # undef KH_INSTY # define MPI # define NBQ # define XIOS # ifdef NBQ # undef OBC_NBQ # undef NBQ_VOL # undef NBQ_IMP # define NBQ_IMP_LU # define NBQ_IMP_TRIDIAG # undef NBQ_IMPIJK # define NBQ_FB # undef NBQ_LF # undef NBQ_RK2 # undef NBQ_RK3 # undef NBQ_RK3b # endif # undef MASKING # undef OBC_EAST # undef OBC_WEST # undef OBC_SOUTH # undef OBC_NORTH # define UV_VIS2 # define SALINITY # define UV_MIX_S # define UV_VIS_SMAGO # define SOLVE3D # define NEW_S_COORD # define UV_ADV # define TS_HADV_WENO5 # define TS_VADV_WENO5 # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SRFLUX # define ANA_BTFLUX # define ANA_SSFLUX # define ANA_BSFLUX # ifndef KH_INSTY # define EW_PERIODIC # else # define NS_PERIODIC # endif #elif defined ACOUSTIC /* ! ACOUSTIC WAVE TESTCASE ! ====================== */ # undef OPENMP # define MPI # define NBQ # ifdef NBQ # undef NBQ_VOL # undef NBQ_IMP # undef NBQ_IMP_LU # undef NBQ_IMP_TRIDIAG # undef NBQ_IMPIJK # define NBQ_FB # undef NBQ_LF # undef NBQ_RK2 # undef NBQ_RK3 # undef NBQ_RK3b # undef DEBUG_NBQ # endif # undef UV_VIS2 # define SOLVE3D # define NEW_S_COORD # undef UV_ADV # undef TS_HADV_WENO5 # undef TS_VADV_WENO5 # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX #elif defined GRAV_ADJ /* ! Gravitational Adjustment Example ! ============= ========== ======= ! ! Soliton case GRAV_ADJ_SOLITON (non-hydro test) is setup from: ! Horn, D.A., J. Imberger, & G.N. Ivey, (2001). ! The degeneration of large-scale interfacial gravity waves in lakes. ! J. Fluid Mech., 434:181-207. ! */ # undef OPENMP # define MPI # undef NBQ # undef XIOS # ifdef NBQ # define GRAV_ADJ_SOLITON # define NBQ_FB # define NBQ_IMP # define NBQ_IMP_LU # undef NBQ_IMP_TRIDIAG # endif # define UV_VIS2 # define SOLVE3D # define NEW_S_COORD # define UV_ADV # define TS_HADV_WENO5 # define TS_VADV_WENO5 # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX #elif defined INNERSHELF /* ! Inner Shelf Example ! ===== ===== ======= */ # undef OPENMP # undef MPI # define INNERSHELF_EKMAN # define INNERSHELF_APG # define SOLVE3D # define UV_COR # define ANA_GRID # define ANA_INITIAL # define AVERAGES # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_STFLUX # define ANA_BSFLUX # define ANA_BTFLUX # define ANA_SMFLUX # define NS_PERIODIC # define OBC_WEST # define SPONGE # ifndef INNERSHELF_EKMAN # define UV_ADV # define SALINITY # define NONLIN_EOS # define LMD_MIXING # ifdef LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_RIMIX # define LMD_CONVEC # else # define GLS_MIXING # define GLS_KKL # endif # endif #elif defined INTERNAL /* ! Internal Tide Example ! ======== ==== ======= ! ! Di Lorenzo, E, W.R. Young and S.L. Smith, 2006, Numerical and anlytical estimates of M2 ! tidal conversion at steep oceanic ridges, J. Phys. Oceanogr., 36, 1072-1084. */ # undef ETALON_CHECK # undef OPENMP # undef MPI # define SOLVE3D # define UV_COR # define UV_ADV # define BODYTIDE # define ANA_GRID # undef INTERNALSHELF # define ANA_INITIAL # define ANA_BTFLUX # define ANA_SMFLUX # define ANA_SRFLUX # define ANA_STFLUX # define ANA_VMIX # define EW_PERIODIC # define NS_PERIODIC # undef OBC_EAST # undef OBC_WEST # undef SPONGE # undef ANA_SSH # undef ANA_M2CLIMA # undef ANA_M3CLIMA # undef ANA_TCLIMA # undef ZCLIMATOLOGY # undef M2CLIMATOLOGY # undef M3CLIMATOLOGY # undef TCLIMATOLOGY # undef M2NUDGING # undef M3NUDGING # undef TNUDGING #elif defined S2DV /* ! 2DV Sections ! ============ ! */ /* Applications */ # undef TIDES # define NBQ # undef OA /* Parallelization */ # undef OPENMP /* <-- debug mode */ # define MPI /* <-- debug mode */ /* I/O server */ # define XIOS /* Equation of State */ # undef SALINITY /* Open Boundary Conditions */ # ifdef TIDES # define TIDERAMP # define SSH_TIDES # undef POT_TIDES # define UV_TIDES # endif # define OBC_EAST # define OBC_WEST # undef OBC_SOUTH # undef OBC_NORTH # define NS_PERIODIC /* Model dynamics */ # define SOLVE3D # define UV_ADV # define UV_COR /* Lateral Explicit Momentum Mixing */ # define UV_VIS2 # ifdef UV_VIS # undef UV_VIS_SMAGO # endif /* Semi-implicit Vertical Tracer/Mom Advection */ # undef VADV_ADAPT_IMP /* Grid configuration */ # define SPHERICAL # define CURVGRID # undef MASKING # define NEW_S_COORD # undef WET_DRY /* Non-Boussinesq */ # ifdef NBQ # undef NBQ_VOL /* <-- check */ # undef NBQ_OUT /* <-- obsolete */ # undef NBQ_DEBUG /* <-- alt. key, incl. debug level */ # undef NBQ_LF # define NBQ_FB # define NBQ_IMP # define NBQ_IMP_LU # undef NBQ_IMP_TRIDIAG # define OBC_NBQ # define NBQCLIMATOLOGY # define NBQNUDGING # endif /* Sponge layers for UV and TS */ # define SPONGE # define ANA_VMIX # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SRFLUX # define ANA_SSFLUX /* Bottom Forcing */ # define ANA_BTFLUX # define ANA_BSFLUX /* Lateral Forcing */ # define ZCLIMATOLOGY /* <-- needed for tides forcing */ # define M2CLIMATOLOGY /* <-- needed for tides forcing */ # define M3CLIMATOLOGY # define TCLIMATOLOGY # define ANA_INITIAL # define ANA_SSH /* <-- needed for z forcing initialisation to 0 */ # define ANA_M2CLIMA /* <-- needed for barotropic forcing initialisation to 0 */ # define ANA_M3CLIMA # define ANA_TCLIMA # define EXPERIMENT3 # define M2NUDGING # define M3NUDGING # define TNUDGING #elif defined REGIONAL_NBQ /* ! NBQ-REGIONAL APPLICATIONS ! ============ ! */ /* Applications */ # undef TIDES # define NBQ # undef OA /* Parallelization */ # undef OPENMP /* <-- debug mode */ # define MPI /* <-- debug mode */ !# define MPI /* <-- debug mode */ /* I/O server */ # undef XIOS /* Equation of State */ # define SALINITY /* Open Boundary Conditions */ # ifdef TIDES # define TIDERAMP # define SSH_TIDES # define POT_TIDES # define UV_TIDES # endif # undef OBC_EAST # define OBC_WEST # undef OBC_SOUTH # define OBC_NORTH /* Model dynamics */ # define SOLVE3D # define UV_ADV # define UV_COR /* Lateral Explicit Momentum Mixing */ # define UV_VIS2 # ifdef UV_VIS # undef UV_VIS_SMAGO # endif /* Semi-implicit Vertical Tracer/Mom Advection */ # undef VADV_ADAPT_IMP /* Grid configuration */ # define SPHERICAL # define CURVGRID # define MASKING # define NEW_S_COORD # undef WET_DRY /* Non-Boussinesq */ # ifdef NBQ # undef IMP_SLOW # undef NBQ_VOL /* <-- check */ # undef NBQ_OUT /* <-- obsolete */ # undef NBQ_DEBUG /* <-- alt. key, incl. debug level */ # undef NBQ_LF # define NBQ_FB # define NBQ_IMP # define NBQ_IMP_LU # undef NBQ_IMP_TRIDIAG # define OBC_NBQ # define NBQCLIMATOLOGY # define NBQNUDGING # endif /* Sponge layers for UV and TS */ # define SPONGE # define ANA_VMIX # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SRFLUX # define ANA_SSFLUX /* Bottom Forcing */ # define ANA_BTFLUX # define ANA_BSFLUX /* Lateral Forcing */ # define ZCLIMATOLOGY /* <-- needed for tides forcing */ # define M2CLIMATOLOGY /* <-- needed for tides forcing */ # define M3CLIMATOLOGY # define TCLIMATOLOGY # define ANA_INITIAL # define ANA_SSH /* <-- needed for z forcing initialisation to 0 */ # define ANA_M2CLIMA /* <-- needed for barotropic forcing initialisation to 0 */ # define ANA_M3CLIMA # define ANA_TCLIMA # define EXPERIMENT3 # define M2NUDGING # define M3NUDGING # define TNUDGING #elif defined IGW /* ! COMODO Internal Tide Example ! ====== ======== ==== ======= ! ! Pichon, A., 2007: Tests academiques de maree, Rapport interne n 21 du 19 octobre 2007, ! Service Hydrographique et Oceanographique de la Marine. */ # define EXPERIMENT3 # undef OPENMP # undef MPI # undef NBQ # ifdef NBQ # define NBQ_IMP # endif # define NEW_S_COORD # define TIDES # define TIDERAMP # define SSH_TIDES # define UV_TIDES # define SOLVE3D # define UV_ADV # define UV_COR # define UV_VIS2 # undef VADV_ADAPT_IMP # define SPHERICAL # define CURVGRID # define ANA_INITIAL # define ANA_VMIX # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SRFLUX # define ANA_SSFLUX # define ANA_BTFLUX # define ANA_BSFLUX # define NS_PERIODIC # define OBC_EAST # define OBC_WEST # undef SPONGE # define ANA_SSH # define ANA_M2CLIMA # define ANA_M3CLIMA # define ANA_TCLIMA # define ZCLIMATOLOGY # define M2CLIMATOLOGY # define M3CLIMATOLOGY # define TCLIMATOLOGY # define M2NUDGING # define M3NUDGING # define TNUDGING # undef ONLINE_ANALYSIS #elif defined RIVER /* ! River run-off test problem ! ========================== */ # undef OPENMP # undef MPI # define SOLVE3D # define UV_ADV # define UV_COR # define M2FILTER_FLAT # define NONLIN_EOS # define SALINITY # define ANA_GRID # define MASKING # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_BTFLUX # define ANA_BSFLUX # define LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_RIMIX # define LMD_CONVEC # define PSOURCE # define ANA_PSOURCE # define NS_PERIODIC # define FLOATS # ifdef FLOATS # define RANDOM_WALK # ifdef RANDOM_WALK # define DIEL_MIGRATION # define RANDOM_VERTICAL # define RANDOM_HORIZONTAL # endif # endif #elif defined SEAMOUNT /* ! Seamount Example ! ======== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define SOLVE3D # define SALINITY # define NONLIN_EOS # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_BTFLUX # define ANA_BSFLUX # elif defined SHELFRONT /* ! Shelf Front Example ! ===== ===== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define SOLVE3D # define SALINITY # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_BTFLUX # define ANA_BSFLUX # define EW_PERIODIC #elif defined SOLITON /* ! Equatorial Rossby Wave Example ! ========== ====== ==== ======= */ # undef OPENMP # undef MPI # define UV_COR # define UV_ADV # define ANA_GRID # define ANA_INITIAL # define AVERAGES # define EW_PERIODIC # define ANA_SMFLUX # elif defined OVERFLOW /* ! Gravitational/Overflow Example ! ====================== ======= */ # undef OPENMP # undef MPI # define UV_ADV # define UV_COR # define UV_VIS2 # define TS_DIF2 # define TS_MIX_GEO # define SOLVE3D # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_BTFLUX #elif defined PLUME /* !---------------------- ! BASIC OPTIONS !---------------------- */ /* Parallelization */ # undef OPENMP # define MPI # undef OBC_EAST # undef OBC_WEST # undef OBC_NORTH # undef OBC_SOUTH # undef AUTOTILING # undef ETALON_CHECK /* Grid configuration */ # define NEW_S_COORD /* Analytical intial + Forcing */ # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX /* Bottom Forcing */ # define ANA_BSFLUX # define ANA_BTFLUX /* Model dynamics */ # define SOLVE3D # define UV_COR # define UV_ADV /* Equation of State */ # define SALINITY # define NONLIN_EOS # define SPLIT_EOS /* Lateral Tracer Advection (default UP3) */ # define TS_HADV_UP3 /* Sponge layers for UV and TS */ # define SPONGE /* Semi-implicit Vertical Tracer/Mom Advection */ # undef LMD_MIXING # define GLS_MIX2017 # ifdef LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_RIMIX # define LMD_CONVEC # undef LMD_DDMIX # define LMD_NONLOCAL # undef MLCONVEC # endif # ifdef GLS_MIX2017 # undef GLS_KOMEGA # define GLS_KEPSILON # undef GLS_GEN # define CANUTO_A # undef GibLau_78 # undef MelYam_82 # undef KanCla_94 # undef Luyten_96 # undef CANUTO_B # undef Cheng_02 # endif #elif defined UPWELLING /* ! Upwelling Example ! ========= ======= */ # undef OPENMP # undef MPI # define SOLVE3D # define UV_COR # define UV_ADV # define ANA_GRID # define ANA_INITIAL # define AVERAGES # define SALINITY # define NONLIN_EOS # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_STFLUX # define ANA_BSFLUX # define ANA_BTFLUX # define ANA_SMFLUX # define LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_RIMIX # define LMD_CONVEC # define EW_PERIODIC #elif defined VORTEX /* ! Baroclinic Vortex Example (TEST AGRIF) ! ========== ====== ======= ===== ====== */ # undef OPENMP # undef MPI # define AGRIF # define AGRIF_2WAY # undef NBQ # define SOLVE3D # define UV_COR # define UV_ADV # define ANA_STFLUX # define ANA_SMFLUX # define ANA_BSFLUX # define ANA_BTFLUX # define ANA_VMIX # define OBC_EAST # define OBC_WEST # define OBC_NORTH # define OBC_SOUTH # define SPONGE # define ZCLIMATOLOGY # define M2CLIMATOLOGY # define M3CLIMATOLOGY # define TCLIMATOLOGY # define ZNUDGING # define M2NUDGING # define M3NUDGING # define TNUDGING #elif defined JET /* ! Baroclinic JET Example ! ========== === ======= */ # define ANA_JET # undef MPI # undef AGRIF # undef AGRIF_2WAY # define SOLVE3D # define UV_COR # define UV_ADV # define UV_VIS2 # ifdef ANA_JET # define ANA_GRID # define ANA_INITIAL # endif # define ANA_STFLUX # define ANA_SMFLUX # define ANA_BSFLUX # define ANA_BTFLUX # define ANA_VMIX # define EW_PERIODIC # define CLIMATOLOGY # ifdef CLIMATOLOGY # define ZCLIMATOLOGY # define M2CLIMATOLOGY # define M3CLIMATOLOGY # define TCLIMATOLOGY # define ZNUDGING # define M2NUDGING # define M3NUDGING # define TNUDGING # define ROBUST_DIAG # define ZONAL_NUDGING # ifdef ANA_JET # define ANA_SSH # define ANA_M2CLIMA # define ANA_M3CLIMA # define ANA_TCLIMA # endif # endif # define LMD_MIXING # ifdef LMD_MIXING # undef ANA_VMIX # define ANA_SRFLUX # undef LMD_KPP # define LMD_RIMIX # define LMD_CONVEC # endif #elif defined SHOREFACE /* ! PLANAR BEACH Example ! ====== ===== ======= ! ! Uchiyama, Y., McWilliams, J.C. and Shchepetkin, A.F. (2010): ! Wave-current interaction in an oceanic circulation model with a ! vortex force formalism: Application to the surf zone. ! Ocean Modelling Vol. 34:1-2, pp.16-35. */ # undef OPENMP # undef MPI # define SOLVE3D # define UV_ADV # undef MASKING # define WET_DRY # define NEW_S_COORD # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_SST # define ANA_BTFLUX # define NS_PERIODIC # define OBC_WEST # define SPONGE # define MRL_WCI # ifdef MRL_WCI # undef WAVE_OFFLINE # ifndef WAVE_OFFLINE # define WKB_WWAVE # define WKB_OBC_WEST # define WAVE_FRICTION # undef WAVE_ROLLER # undef MRL_CEW # endif # endif # define LMD_MIXING # define LMD_SKPP # define LMD_BKPP # undef BBL # undef SEDIMENT # ifdef SEDIMENT # define TCLIMATOLOGY # define TNUDGING # define ANA_TCLIMA # endif #elif defined FLUME /* ! FLUME Example ! ===== ======= ! ! Roelvink, J.A. and Stive, M.J.F., 1989: Bar-generating cross-shore ! flow mechanisms on a beach. Journal of Geophysical Research */ # undef OPENMP # undef MPI # define SOLVE3D # define UV_ADV # define NEW_S_COORD # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_SST # define ANA_BTFLUX # define NS_PERIODIC # define OBC_WEST # define SPONGE # define WET_DRY # define MRL_WCI # ifdef MRL_WCI # define WKB_WWAVE # define MRL_CEW # define WKB_OBC_WEST # define WAVE_ROLLER # define WAVE_FRICTION # define WAVE_BREAK_SWASH # undef WAVE_STREAMING # undef WAVE_RAMP # endif # define LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define LMD_VMIX_SWASH # undef GLS_MIX2017 # ifdef GLS_MIX2017 # undef GLS_KOMEGA # define GLS_KEPSILON # undef GLS_GEN # define CANUTO_A # undef GibLau_78 # undef MelYam_82 # undef KanCla_94 # undef Luyten_96 # undef CANUTO_B # undef Cheng_02 # endif # define BBL # define SEDIMENT # ifdef SEDIMENT # define TCLIMATOLOGY # define TNUDGING # define ANA_TCLIMA # define MORPHODYN # endif #elif defined RIP /* ! Rip Current Example ! === ======= ======= ! ! Weir, B., Uchiyama, Y.. (2010): ! A vortex force analysis of the interaction of rip ! currents and surface gravity wave ! JGR Vol. 116 ! ! Default is idealized Duck Beach with 3D topography ! RIP_TOPO_2D: Logshore uniform topography ! BISCA: realistic case with Input files ! GRANDPOPO: idealized Grand Popo Beach in Benin, ! longshore uniform */ # undef BISCA # undef RIP_TOPO_2D # undef GRANDPOPO # ifdef GRANDPOPO # define RIP_TOPO_2D # endif # undef ANA_TIDES ! # undef OPENMP # undef MPI # define SOLVE3D # define UV_ADV # undef VADV_ADAPT_IMP # define UV_VIS2 # define UV_VIS_SMAGO # define LMD_MIXING # define LMD_SKPP # define LMD_BKPP # define NEW_S_COORD # ifndef BISCA # define ANA_GRID # endif # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_SST # define ANA_BTFLUX # if !defined BISCA && !defined ANA_TIDES # define NS_PERIODIC # else # define OBC_NORTH # define OBC_SOUTH # endif # define OBC_WEST # define SPONGE # ifdef ANA_TIDES # define ANA_SSH # define ANA_M2CLIMA # define ANA_M3CLIMA # define ZCLIMATOLOGY # define M2CLIMATOLOGY # define M3CLIMATOLOGY # define M2NUDGING # define M3NUDGING # endif # define WET_DRY # define MRL_WCI # ifdef MRL_WCI # define WKB_WWAVE # define WKB_OBC_WEST # define WAVE_ROLLER # define WAVE_FRICTION # define WAVE_STREAMING # define MRL_CEW # ifdef RIP_TOPO_2D # define WAVE_RAMP # endif # endif # ifdef BISCA # define BBL # endif # undef SEDIMENT # ifdef SEDIMENT # define ANA_SEDIMENT # undef ANA_SPFLUX # undef ANA_BPFLUX # endif # undef DIAGNOSTICS_UV #elif defined SWASH /* ! SWASH PLANAR BEACH Example ! ===== ====== ===== ======= ! */ # undef OPENMP # undef MPI # define SOLVE3D # undef NBQ # define UV_ADV # define UV_VIS2 # define UV_VIS_SMAGO # define MASKING # define NEW_S_COORD # define ANA_GRID # define ANA_INITIAL # define ANA_SMFLUX # define ANA_STFLUX # define ANA_SSFLUX # define ANA_SRFLUX # define ANA_SST # define ANA_BTFLUX # define OBC_WEST # define SPONGE # define FRC_BRY # define ANA_BRY # define Z_FRC_BRY # define M2_FRC_BRY # define M3_FRC_BRY # define T_FRC_BRY # define WET_DRY #elif defined THACKER /* ! Thacker Example ! ======= ======= ! ! Thacker, W., (1981), Some exact solutions to the nonlinear ! shallow-water wave equations. ! J. Fluid Mech., 107, 499–508. */ # undef OPENMP # undef MPI # define THACKER_2DV # define SOLVE3D # define UV_COR # define UV_ADV # undef UV_VIS2 # define WET_DRY # define NEW_S_COORD # define ANA_GRID # define ANA_INITIAL # define ANA_BTFLUX # define ANA_SMFLUX # define ANA_SRFLUX # define ANA_STFLUX #elif defined TANK /* ! Tank Example ! ======= ======= ! ! Chen, X.J., 2003. A fully hydrodynamic model for three-dimensional, ! free-surface flows. ! Int. J. Numer. Methods Fluids 42, 929–952. */ # define TANKY # undef XIOS # define MPI # define NBQ # ifdef NBQ # undef IMP_SLOW # undef NBQ_VOL # undef NBQ_IMP # undef NBQ_IMP_LU # undef NBQ_IMP_TRIDIAG # undef NBQ_IMPIJK # define NBQ_FB # undef NBQ_LF # undef NBQ_RK2 # undef NBQ_RK3 # undef NBQ_RK3b # undef DEBUG_NBQ # endif # define SOLVE3D # undef MASKING # undef UV_ADV # define NEW_S_COORD # define ANA_GRID # define ANA_INITIAL # define ANA_BTFLUX # define ANA_SMFLUX # define ANA_SRFLUX # define ANA_STFLUX #endif /* END OF CONFIGURATION CHOICE */ #include "cppdefs_dev.h" #include "set_global_definitions.h" ! $Id: set_global_definitions.h 1618 2014-12-18 14:39:51Z rblod $ ! !====================================================================== ! CROCO is a branch of ROMS developped at IRD and INRIA, in France ! The two other branches from UCLA (Shchepetkin et al) ! and Rutgers University (Arango et al) are under MIT/X style license. ! CROCO specific routines (nesting) are under CeCILL-C license. ! ! CROCO website : http://www.croco-ocean.org !====================================================================== ! /* This is "cppdefs_dev.h": It contains a set of predetermined macro definitions which are inserted into the individual files by C-preprocessor. General user is discouraged from attempts to modify anything below this line. But developers are encouraged to do so if needed */ /* ====================================================================== Set debugging options ====================================================================== */ /* Switch to mixed [tiled + single-block] execution. Activation of this switch enables special logical branch in "compute_tile_bounds" which recognizes tile=NSUB_X*NSUB_E as covering the whole model grid, and it increases sizes of arrays declared in "private_scratch" to accomodate enough workspace accordingly. This switch is used for debugging purposes only and normally should be undefined. */ #undef ALLOW_SINGLE_BLOCK_MODE #ifdef ALLOW_SINGLE_BLOCK_MODE # define SINGLE NSUB_X*NSUB_E,NSUB_X*NSUB_E !!! #endif /* Constant tracer option (for debugging) */ #undef CONST_TRACERS /* ====================================================================== Set OA COUPLING options: Define MPI, select OA_MCT Change the generic name of MPI communicator MPI_COMM_WORLD to OASIS-MCT local communicator ====================================================================== */ #ifdef OA_COUPLING # undef OPENMP # define MPI # define OA_MCT # define MPI_COMM_WORLD ocean_grid_comm # undef BULK_FLUX #endif /* ====================================================================== Set OW COUPLING options: Define MPI, select OA_MCT Change the generic name of MPI communicator MPI_COMM_WORLD to OASIS-MCT local communicator ====================================================================== */ #ifdef OW_COUPLING # undef OPENMP # define MPI # define OA_MCT # define MPI_COMM_WORLD ocean_grid_comm # undef WKB_WWAVE # undef WAVE_OFFLINE #endif /* ====================================================================== Set XIOS options: Activate MPI Change the generic name of MPI communicator MPI_COMM_WORLD to XIOS local communicator ====================================================================== */ #ifdef XIOS # define MPI # define MPI_COMM_WORLD ocean_grid_comm # define key_iomput #else # undef key_iomput #endif /* ====================================================================== Set default time-averaging filter for barotropic fields. ====================================================================== */ #ifdef M2FILTER_NONE /* Check if options are defined in cppdefs.h */ #elif defined M2FILTER_POWER #elif defined M2FILTER_COSINE #elif defined M2FILTER_FLAT #else # undef M2FILTER_NONE # define M2FILTER_POWER # undef M2FILTER_COSINE # undef M2FILTER_FLAT #endif /* ====================================================================== Activate barotropic pressure gradient response to the perturbation of free-surface in the presence of stratification ====================================================================== */ #if defined SOLVE3D # define VAR_RHO_2D # if !defined NONLIN_EOS && !defined INNERSHELF # define RESET_RHO0 # endif #endif /* ====================================================================== Activate NBQ choices for non-hydrostatic simulations ====================================================================== */ #ifdef NBQ # define M2FILTER_NONE # undef M2FILTER_POWER # define NBQ_IJK # define NBQ_IMP # define NBQ_IMPIJK # define NBQ_CONS # define NBQ_COUPLE1 # undef TRACETXT # define HZR Hzr # define NBQ_ZETAW /* ====================================================================== Activate NBQ Precise or Performance mode ====================================================================== */ #if !defined NBQ_PERF #define NBQ_PRECISE #endif #ifdef NBQ_PRECISE # define NBQ_MASS # define NBQ_DTDRHO2 # undef NBQ_DTDRHO2B # define NBQ_GRIDEXT # define NBQ_ZETAEXP # define NBQ_ZETAREDIAG # define NBQ_TRACERS # undef NBQ_NODS #else # undef NBQ_MASS # define NBQ_DTDRHO2 # undef NBQ_DTDRHO2B # undef NBQ_GRIDEXT # undef NBQ_ZETAEXP # undef NBQ_ZETAREDIAG # define NBQ_TRACERS # define NBQ_NODS #endif #ifndef NBQ_ZETAW # undef NBQ_MASS # undef NBQ_DTDRHO2 # undef NBQ_DTDRHO2B # undef NBQ_GRIDEXT # undef NBQ_ZETAEXP # undef NBQ_ZETAREDIAG # undef NBQ_TRACERS # define NBQ_NODS #endif # ifdef OBC_NBQ # undef OBC_NBQORLANSKI # undef OBC_NBQSPECIFIED # undef NBQ_FRC_BRY # define W_FRC_BRY # endif #else # define HZR Hz #endif /* ====================================================================== Activate choice of Pressure Gradient formulation (default is the Density Jacobian formulation with Cubic Polynomial fit from Shchepetkin et al. (2003). But: 1- a cheaper standard Jacobian formulation can also be used (PGF_BASIC_JACOBIAN), especially for flat or smooth topography). 2- The Weighted Jacobian formulation of Song & Haidvogel (1994) can also be used by defining the WJ_GRADP key, which then serves as the weight value. ====================================================================== */ #if defined BASIN || defined EQUATOR || defined GRAV_ADJ \ || defined SOLITON || defined JET \ || defined ACOUSTIC || defined VORTEX \ || defined THACKER || defined TANK # define PGF_BASIC_JACOBIAN # undef WJ_GRADP #elif defined RIP # define PGF_BASIC_JACOBIAN # define WJ_GRADP 0.125 #elif defined PGF_BASIC_JACOBIAN # define WJ_GRADP 0.125 #endif /* ====================================================================== Activate EOS splitting of seawater compressibility effect in case of non-linear formulation, as part of the pressure gradient algorithm with polynomial fit (Shchepetkin & McWilliams 2003) ====================================================================== */ #ifdef NONLIN_EOS # define SPLIT_EOS #endif /* ====================================================================== Select MOMENTUM LATERAL advection-diffusion scheme: (The default is third-order upstream biased) ====================================================================== */ #ifdef UV_HADV_UP3 /* Check if options are defined in cppdefs.h */ #elif defined UV_HADV_C4 #elif defined UV_HADV_C2 #elif defined UV_HADV_UP5 #elif defined UV_HADV_C6 #elif defined UV_HADV_WENO5 #else # define UV_HADV_UP3 /* 3rd-order upstream lateral advection */ # undef UV_HADV_C4 /* 4th-order centered lateral advection */ # undef UV_HADV_C2 /* 2nd-order centered lateral advection */ # undef UV_HADV_UP5 /* 5th-order upstream lateral advection */ # undef UV_HADV_C6 /* 6th-order centered lateral advection */ # undef UV_HADV_WENO5 /* 5th-order WENOZ lateral advection */ #endif /* UV DIFFUSION: set default orientation */ #ifdef UV_MIX_S /* Check if options are defined */ #elif defined UV_MIX_GEO #else # define UV_MIX_S /* Default: diffusion along sigma surfaces */ #endif /* Set keys related to Smagorinsky viscosity */ #ifdef UV_VIS_SMAGO # define VIS_COEF_3D #endif /* Set UP3 scheme in barotropic equations for 2DH applications */ #if !defined SOLVE3D && !defined SOLITON # define M2_HADV_UP3 #endif /* If interior MOMENTUM LATERAL diffusion is defined, apply it over an anomaly with respect to a reference frame (climatology) */ #ifdef M3CLIMATOLOGY # undef CLIMAT_UV_MIXH #endif /* ====================================================================== Select MOMENTUM VERTICAL advection scheme: ====================================================================== */ #ifdef UV_VADV_SPLINES /* Check if options are defined in cppdefs.h */ #elif defined UV_VADV_WENO5 #elif defined UV_VADV_C2 #else # define UV_VADV_SPLINES /* Splines vertical advection */ # undef UV_VADV_WENO5 /* 5th-order WENOZ vertical advection */ # undef UV_VADV_C2 /* 2nd-order centered vertical advection */ #endif #ifdef VADV_ADAPT_IMP /* Semi-implicit vertical advection */ # undef VADV_ADAPT_PRED /* apply to both pred/corr steps (choice) */ # define UV_VADV_SPLINES /* Impose splines advection (no choice) */ # undef UV_VADV_C2 #endif /* ====================================================================== Select TRACER LATERAL advection-diffusion scheme (The default is third-order upstream biased) ====================================================================== */ #ifdef TS_HADV_UP3 /* Check if options are defined in cppdefs.h */ #elif defined TS_HADV_C4 #elif defined TS_HADV_UP5 #elif defined TS_HADV_WENO5 #elif defined TS_HADV_C6 #elif defined TS_HADV_RSUP3 #elif defined TS_HADV_RSUP5 #else # define TS_HADV_UP3 /* 3rd-order upstream lateral advection */ # undef TS_HADV_C4 /* 4th-order centered lateral advection */ # undef TS_HADV_UP5 /* 5th-order upstream lateral advection */ # undef TS_HADV_WENO5 /* 5th-order WENOZ lateral advection */ # undef TS_HADV_C6 /* 6th-order centered lateral advection */ # undef TS_HADV_RSUP3 /* Rotated-Split UP3 lateral advection */ # undef TS_HADV_RSUP5 /* Pseudo R-Split UP5 lateral advection */ #endif /* Options for split-rotated advection-diffusion schemes */ #ifdef TS_HADV_C4 /* 4th-order centered advection with: */ # define TS_DIF2 /* + Laplacian Diffusion */ # undef TS_DIF4 /* */ # define TS_DIF_SMAGO /* + Smagorinsky diffusivity */ # define TS_MIX_ISO /* + Isopycnal rotation */ #endif #ifdef TS_HADV_RSUP3 /* Rotated-Split 3rd-order scheme is: */ # define TS_HADV_C4 /* 4th-order centered advection */ # undef TS_DIF2 /* + */ # define TS_DIF4 /* Hyperdiffusion with */ # undef TS_MIX_GEO /* Geopotential rotation */ # define TS_MIX_ISO /* or Isopycnal rotation */ # if defined GLS_MIX2017 || defined GLS_MIXING # undef TS_MIX_ISO # define TS_MIX_GEO # endif #endif #ifdef TS_HADV_RSUP5 /* Pseudo RS 5th-order scheme is: */ # define TS_HADV_C6 /* 6th-order centered advection */ # undef TS_DIF2 /* + */ # define TS_DIF4 /* Hyperdiffusion with */ # define TS_MIX_GEO /* Geopotential rotation */ # undef TS_MIX_ISO /* or Isopycnal rotation */ #endif /* TS DIFFUSION: set default orientation */ #ifdef TS_MIX_S /* Check if options are defined */ #elif defined TS_MIX_GEO #elif defined TS_MIX_ISO #else # define TS_MIX_S /* Set iso-sigma diffusion as default */ #endif /* Apply implicit treatment and filters */ #if defined TS_MIX_ISO || (defined TS_DIF4 && defined TS_MIX_GEO) # define TS_MIX_IMP /* Implicit treatment of vertical fluxes */ #endif #if defined TS_MIX_ISO && defined SALINITY # define TS_MIX_ISO_FILT /* neutral slope filtering */ #endif /* Apply interior diffusion (if defined) over tracer anomalies with respect to a reference frame (climatology) */ # ifdef TCLIMATOLOGY # undef CLIMAT_TS_MIXH # undef CLIMAT_TS_MIXH_FINE # endif /* Use 3D viscosity arrays if needed */ #if defined TS_HADV_RSUP3 \ || defined TS_HADV_RSUP5 || defined TS_DIF_SMAGO # define DIF_COEF_3D #endif /* If BIO_HADV_WENO5 is chosen, the advection scheme for passive tracers is independent from that selected for the two active tracers (TS_HADV) */ #ifdef BIO_HADV_WENO5 # define NTRA_T3DMIX 2 /* TS_HADV applied over the 2 active tracers */ #else # define NTRA_T3DMIX NT /* TS_HADV applied over all NT tracers */ #endif /* ====================================================================== Select model dynamics for TRACER vertical advection (The default is 4th-order centered) ====================================================================== */ #ifdef TS_VADV_SPLINES /* Check if options are defined in cppdefs.h */ #elif defined TS_VADV_AKIMA #elif defined TS_VADV_WENO5 #elif defined TS_VADV_C2 #else # undef TS_VADV_SPLINES /* Splines vertical advection */ # define TS_VADV_AKIMA /* 4th-order Akima vertical advection */ # undef TS_VADV_WENO5 /* 5th-order WENOZ vertical advection */ # undef TS_VADV_C2 /* 2nd-order centered vertical advection */ #endif #undef TS_VADV_FCT /* Flux correction of vertical advection */ #ifdef VADV_ADAPT_IMP # define TS_VADV_SPLINES # undef TS_VADV_AKIMA # undef TS_VADV_WENO5 # undef TS_VADV_C2 #endif /* ====================================================================== SPONGE: define SPONGE_GRID, SPONGE_DIF2 and SPONGE_VIS2 ====================================================================== */ #ifdef SPONGE # ifndef INNERSHELF # define SPONGE_GRID # endif # define SPONGE_DIF2 # define SPONGE_VIS2 # ifdef SEDIMENT # define SPONGE_SED # endif #endif /* ====================================================================== PSOURCE / PSOURCE_NCFILE option ====================================================================== */ #if defined PSOURCE # define ANA_PSOURCE /* ON: set vertical profil for qbar */ #endif #if defined PSOURCE_NCFILE # define PSOURCE # define ANA_PSOURCE #endif /* ====================================================================== Bulk flux option ====================================================================== */ #ifdef BULK_FLUX # ifdef BULK_SMFLUX # define BULK_SM_UPDATE /* ON: Compute wind stress via bulk_flux */ # endif # ifdef ONLINE # define CUBIC_INTERP # endif #endif /* ====================================================================== Wave Current Interaction ====================================================================== */ #if defined MRL_WCI || defined WKB_WWAVE /* Wave breaking dissipation (both WKB and WCI) */ # undef WAVE_SFC_BREAK # ifdef WAVE_BREAK_CT93 # elif WAVE_BREAK_TG86 # elif WAVE_BREAK_TG86A # elif WAVE_BREAK_R93 # else # define WAVE_BREAK_CT93 /* defaults */ # endif #endif /* WKB specific options */ #ifdef WKB_WWAVE # define MRL_CEW # ifdef MRL_CEW # undef WKB_KZ_FILTER # undef WKB_TIME_FILTER # endif # define WKB_ADD_DIFF # undef WKB_ADD_DIFFRACTION # undef WKB_NUDGING # ifndef WAVE_OFFLINE # undef WKB_NUDGING # endif # if defined SHOREFACE || defined FLUME \ || (defined RIP && !defined BISCA) # define ANA_BRY_WKB # endif #endif #ifdef MRL_WCI /* Bottom streaming */ # ifdef WAVE_STREAMING # define WAVE_BODY_STREAMING # endif #endif #ifdef WAVE_OFFLINE # define WAVE_OFFLINE_BREAKING # ifdef WAVE_ROLLER # define WAVE_OFFLINE_ROLLER # endif # if defined WAVE_FRICTION || WAVE_STREAMING # define WAVE_OFFLINE_FRICTION # endif #endif # if defined WKB_WWAVE || defined OW_COUPLING || defined WAVE_OFFLINE # define WAVE_IO # endif /* ====================================================================== KPP options IF-less KPP --> KPP2005 ====================================================================== */ #ifdef LMD_SKPP # define LMD_SKPP2005 #endif #ifdef LMD_BKPP # undef LMD_BKPP2005 /*<- unresolved problems with bkpp2005 at depth default: lmd_bkpp1994 */ #endif /* ====================================================================== Biogeochemical models ====================================================================== */ #ifdef BIOLOGY # ifdef PISCES # undef DIURNAL_INPUT_SFLX /* Under Development */ # define key_trc_pisces # define key_passivetrc # ifdef DIAGNOSTICS_BIO # define key_trc_diaadd # define key_trc_dia3d # endif # endif # ifdef BIO_BioEBUS # undef VAR_CHL_C /* Under Development */ # undef CARBON /* Under Development */ # undef HYDROGEN_SULFIDE /* Under Development */ # endif #endif /* ====================================================================== Bottom stress option: LIMIT_BSTRESS: Set limiting factor for bottom stress and avoid numerical instability associated with reversing bottom flow ====================================================================== */ #ifndef INNERSHELF # define LIMIT_BSTRESS #endif #ifdef BBL # ifdef SEDIMENT # undef ANA_BSEDIM # else # define ANA_BSEDIM # endif # ifdef SEDIMENT # define Z0_BL # else # undef Z0_BL # endif # ifdef Z0_BL # define Z0_RIP # endif # undef Z0_BIO #endif /* ====================================================================== Sediment dynamics models ====================================================================== */ #ifdef SEDIMENT # define SUSPLOAD # define BEDLOAD # ifdef BEDLOAD # undef SLOPE_NEMETH # define SLOPE_LESSER # if (defined WAVE_OFFLINE || defined WKB_WWAVE || defined ANA_WWAVE\ || defined OW_COUPLING) # define BEDLOAD_SOULSBY # define Z0_BL /* Mandatory with BEDLOAD_SOULSBY */ # define Z0_RIP # else # define BEDLOAD_MPM # endif # endif /* Morphodynamics (bed evolution feedback on circulation): MORPHODYN or MOVING_BATHY (equivalent) must be defined in cppdefs.h (default is undefined) */ # if defined MORPHODYN || defined MOVING_BATHY # ifdef MOVING_BATHY # else # define MOVING_BATHY # endif # else # undef MOVING_BATHY # endif #endif /* SEDIMENT */ /* ====================================================================== OBCs ====================================================================== */ #if defined OBC_EAST || defined OBC_WEST || defined OBC_SOUTH\ || defined OBC_NORTH # ifdef OBC_M2SPECIFIED # elif defined OBC_M2FLATHER # elif defined OBC_M2CHARACT # elif defined OBC_M2ORLANSKI # else # undef OBC_M2SPECIFIED # undef OBC_M2FLATHER # define OBC_M2CHARACT # undef OBC_M2ORLANSKI # endif # ifdef OBC_M2ORLANSKI # define OBC_VOLCONS # endif # ifdef SOLVE3D # ifdef OBC_M3SPECIFIED # elif defined OBC_M3ORLANSKI # else # undef OBC_M3SPECIFIED # define OBC_M3ORLANSKI # endif # ifdef OBC_TSPECIFIED # elif defined OBC_TORLANSKI # else # undef OBC_TSPECIFIED # define OBC_TORLANSKI # endif # endif /* SOLVE3D */ #endif /* OBC */ /* ====================================================================== AGRIF nesting ====================================================================== */ #ifdef AGRIF #define key_agrif /* Update schemes */ # undef AGRIF_UPDATE_MIX_LOW # define AGRIF_UPDATE_MIX # define AGRIF_UPDATE_DECAL /* Conservation options */ # define AGRIF_CONSERV_VOL # undef AGRIF_CONSERV_TRA /* Sponge layer */ # define SPONGE # define SPONGE_DIF2 # define SPONGE_VIS2 /* Boundary conditions */ # define AGRIF_OBC_EAST # define AGRIF_OBC_WEST # define AGRIF_OBC_NORTH # define AGRIF_OBC_SOUTH # define AGRIF_FLUX_BC # define AGRIF_OBC_M2SPECIFIED # ifdef AGRIF_2WAY # define AGRIF_OBC_M3SPECIFIED # define AGRIF_OBC_TSPECIFIED # else # define AGRIF_OBC_M3ORLANSKI # define AGRIF_OBC_TORLANSKI # endif #endif /* AGRIF */ /* ====================================================================== Standard I/O ====================================================================== Set land mask value to _FillValue */ #undef FILLVAL /* Write start_date information in netCDF output (in roms.in, add the keyword start_date: For example, if the simulation starts 1 January of 2000, at 00:00:00 start_date: 01-JAN-2000 00:00:00) */ #undef START_DATE /* Define the NetCDF creation mode flag: nf_clobber (classic), nf_64bit_offset (large files) or nf_netcdf4 */ #define NF_CLOBBER nf_64bit_offset /* ====================================================================== Consistency for 2D configurations ====================================================================== */ #ifndef SOLVE3D # undef AVERAGES_K # undef SALINITY # undef NONLIN_EOS # undef SPLIT_EOS # undef QCORRECTION # undef SFLX_CORR # undef ANA_DIURNAL_SW # undef ANA_STFLUX # undef ANA_SSFLUX # undef ANA_SRFLUX # undef BULK_FLUX # undef TS_DIF2 # undef TS_DIF4 # undef CLIMAT_TS_MIXH # undef SPONGE_DIF2 # undef TS_HADV_RSUP3 # undef TS_MIX_GEO # undef TS_MIX_ISO # undef TS_DIF_SMAGO # undef UV_MIX_GEO # undef VIS_COEF_3D # undef DIF_COEF_3D # undef M3NUDGING # undef TNUDGING # undef ROBUST_DIAG # undef M3CLIMATOLOGY # undef TCLIMATOLOGY # undef M3_FRC_BRY # undef T_FRC_BRY # undef BODYFORCE # undef BVF_MIXING # undef LMD_MIXING # undef LMD_BKPP # undef LMD_SKPP # undef LMD_RIMIX # undef LMD_CONVEC # undef OBC_M3ORLANSKI # undef OBC_M3SPECIFIED # undef OBC_TORLANSKI # undef OBC_TSPECIFIED # undef AGRIF_OBC_M3ORLANSKI # undef AGRIF_OBC_M3SPECIFIED # undef AGRIF_OBC_TORLANSKI # undef AGRIF_OBC_TSPECIFIED # undef SEDIMENT # undef BIOLOGY #endif