!====================================================================== ! CROCO is a branch of ROMS developped at IRD, INRIA, ! Ifremer, CNRS and Univ. Toulouse III 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 /* Activate the RVTK_DEBUG procedure that will test the reproducibility of parallel computation by comparing binary files produced by serial and parallel runs. For the umpteenth time, RVTK_DEBUG itself should be defined from cppdefs.h, so not undefined here !!!!! */ #if !defined RVTK_DEBUG #undef RVTK_DEBUG_ADVANCED #endif #if defined RVTK_DEBUG && !defined MPI && !defined OPENMP && !defined RVTK_DEBUG_READ # define RVTK_DEBUG_WRITE #endif /* Take care need to use a debug.F specific */ #if defined RVTK_DEBUG_PERFRST && !defined RVTK_DEBUG_READ # define RVTK_DEBUG_WRITE #endif /* Constant tracer option (for debugging) */ #ifdef KILPATRICK # define CONST_TRACERS #else # undef CONST_TRACERS #endif /* ====================================================================== Set OA COUPLING options: Define MPI Change the generic name of MPI communicator MPI_COMM_WORLD to OASIS-MCT local communicator ====================================================================== */ #ifdef OA_COUPLING # undef OPENMP # define MPI # define MPI_COMM_WORLD ocean_grid_comm # define READ_PATM # define OBC_PATM # undef OA_GRID_UV # undef BULK_FLUX # undef QCORRECTION # undef SFLX_CORR # undef ANA_DIURNAL_SW # undef SFLUX_CFB #endif /* ====================================================================== Set OW COUPLING options: Define MPI Change the generic name of MPI communicator MPI_COMM_WORLD to OASIS-MCT local communicator ====================================================================== */ #ifdef OW_COUPLING # undef OPENMP # define MPI # define MPI_COMM_WORLD ocean_grid_comm # undef WKB_WWAVE # undef WAVE_OFFLINE # ifdef MRL_WCI # undef WAVE_ROLLER # define WAVE_STREAMING # define WAVE_RAMP # endif # ifdef OA_COUPLING # undef WAVE_SMFLUX # endif #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 #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 /* ====================================================================== Set default flags for computing temperature ====================================================================== */ #if !defined NO_TRACER # define TRACERS /* Compute at least one tracer */ #endif #if !defined NO_TEMPERATURE /* Compute temperature */ # define TEMPERATURE #endif #if defined SALINITY || defined TEMPERATURE || \ defined PASSIVE_TRACER || defined SUBSTANCE # define TRACERS #endif /* ====================================================================== Activate NBQ choices for non-hydrostatic simulations ====================================================================== */ #ifdef NBQ /* General options */ # define M3FAST # define SOLVE3D # define M2FILTER_NONE /* no filter with NBQ */ # undef M2FILTER_POWER # define NBQ_IMP # undef NBQ_THETAIMP # undef NBQ_FREESLIP # undef NBQ_HZ_PROGNOSTIC # undef M3FAST_REINIT # ifdef TANK # define NOT_NBQ_AM4 # endif # undef TRACETXT # undef DIAG_CFL # define HZR Hzr /* NBQ Precise or Performance options (default: NBQ_PERF) */ # ifndef NBQ_PRECISE # define NBQ_PERF # endif # ifdef NBQ_PERF # undef NBQ_MASS # define NBQ_GRID_SLOW # define NBQ_HZCORRECT # else # define NBQ_MASS # undef NBQ_GRID_SLOW # define NBQ_HZCORRECT # endif /* Options for wz HADV numerical schemes (default C4) */ # ifdef W_HADV_SPLINES /* Check if options are defined in cppdefs.h */ # elif defined W_HADV_TVD # elif defined W_HADV_WENO5 # elif defined W_HADV_C4 # elif defined W_HADV_C2 # else # undef W_HADV_SPLINES /* Splines vertical advection */ # undef W_HADV_TVD /* TVD vertical advection */ # define W_HADV_WENO5 /* 5th-order WENOZ vertical advection */ # undef W_HADV_C4 /* 2nd-order centered vertical advection */ # undef W_HADV_C2 /* 2nd-order centered vertical advection */ # endif /* Options for wz VADV numerical schemes (default SPLINES) */ # ifdef W_VADV_SPLINES /* Check if options are defined in cppdefs.h */ # elif defined W_VADV_TVD # elif defined W_VADV_WENO5 # elif defined W_VADV_C2 # else # undef W_VADV_SPLINES /* Splines vertical advection */ # undef W_VADV_TVD /* TVD vertical advection */ # define W_VADV_WENO5 /* !!! 5th-order WENOZ vertical advection */ # undef W_VADV_C2 /* 2nd-order centered vertical advection */ # endif /* NBQ Open boundary conditions */ # if defined OBC_WEST || defined OBC_EAST || \ defined OBC_NORTH || defined OBC_SOUTH # define OBC_NBQ # endif # ifdef OBC_NBQ /* OBC options and nudging: default zero grad */ # define OBC_NBQORLANSKI /* NBQ Radiative conditions */ # undef OBC_NBQSPECIFIED /* NBQ Specified conditions */ # define OBC_WORLANSKI /* W Radiative conditions */ # undef OBC_WSPECIFIED /* W Specified conditions */ # define NBQ_NUDGING /* interior/bdy forcing/nudging */ # define NBQCLIMATOLOGY /* interior/bdy forcing/nudging */ # define NBQ_FRC_BRY /* bdy forcing/nudging */ # define W_FRC_BRY /* wz bdy forcing/nudging */ # endif #else /* Hydrostatic mode */ # define HZR Hz #endif /* NBQ */ /* ====================================================================== Activate FAST timestep 3D dynamics for hydrostatic simulations -- Fast friction BSTRESS_FAST -- ====================================================================== */ #ifdef BSTRESS_FAST # define M3FAST #endif #if !defined NBQ && defined M3FAST /* General options */ # define SOLVE3D # define M2FILTER_NONE /* no filter with M3FAST */ # undef M2FILTER_POWER # define BSTRESS_FAST /* use options from NBQ Open boundary conditions */ # if defined OBC_WEST || defined OBC_EAST || \ defined OBC_NORTH || defined OBC_SOUTH # define OBC_NBQ # endif # ifdef OBC_NBQ /* OBC options and nudging: default zero grad */ # undef OBC_NBQORLANSKI /* Radiative conditions */ # define OBC_NBQSPECIFIED /* Specified conditions (forcing) */ # undef NBQ_NUDGING /* interior/bdy forcing/nudging */ # undef NBQCLIMATOLOGY /* interior/bdy forcing/nudging */ # define NBQ_FRC_BRY /* bdy forcing/nudging */ # undef W_FRC_BRY /* wz bdy forcing/nudging */ # endif #endif /* M3FAST */ /* ====================================================================== 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 \ && !defined MOVING_BATHY # define RESET_RHO0 # endif #endif /* ====================================================================== Activate choice of Pressure Gradient formulation (default is the Density Jacobian formulation with Cubic Polynomial fit from Shchepetkin et al. (2003). But: 1- This code can be run cheaper for flat bottom cases if terms involving z-grid x/y gradients are removed (PGF_FLAT_BOTTOM) 2- a cheaper standard Jacobian formulation can also be used (PGF_BASIC_JACOBIAN) for smooth topography. 3- The Weighted Jacobian formulation of Song & Haidvogel (1994) can be used in this case by defining 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 \ || defined KH_INST || defined TS_HADV_TEST # define PGF_FLAT_BOTTOM #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 #elif defined UV_HADV_TVD #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 */ # undef UV_HADV_TVD /* TVD 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 or 3D GLS */ #ifdef UV_VIS_SMAGO_3D # define UV_VIS2 # define TS_DIF2 # define UV_VIS_SMAGO # define TS_DIF_SMAGO #endif #ifdef UV_VIS_SMAGO # define VIS_COEF_3D #endif #ifdef GLS_MIXING_3D # define GLS_MIXING # define UV_VIS2 # define VIS_COEF_3D # undef TS_DIF2 # undef DIF_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 #elif defined UV_VADV_TVD #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 */ # undef UV_VADV_TVD /* TVD 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_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 */ #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 #if defined TS_HADV_C4 && !defined TS_HADV_RSUP3 /* 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 /* 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 diffusivity 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 # if defined TEMPERATURE && defined SALINITY # define NTRA_T3DMIX 2 /* TS_HADV applied over the 2 active tracers */ # elif defined TEMPERATURE || defined SALINITY # define NTRA_T3DMIX 1 /* TS_HADV applied over the 2 active tracers */ # else # define NTRA_T3DMIX 0 /* TS_HADV applied over the 2 active tracers */ # endif #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 # if defined SEDIMENT # define SPONGE_SED # endif #endif /* ====================================================================== GLS_MIXING ====================================================================== */ #ifdef GLS_MIXING # if defined GLS_KOMEGA # elif defined GLS_KEPSILON # elif defined GLS_GEN # else # define GLS_KEPSILON # endif # if defined CANUTO_A # elif defined GibLau_78 # elif defined MelYam_82 # elif defined KanCla_94 # elif defined Luyten_96 # elif defined CANUTO_B # elif defined Cheng_02 # else # define CANUTO_A # endif #endif /* ====================================================================== TIDES: select dependable keys if not done yet ====================================================================== */ #ifdef TIDES # ifdef SSH_TIDES # ifdef ZCLIMATOLOGY # elif defined Z_FRC_BRY # else # define ZCLIMATOLOGY # define ANA_SSH # endif # endif # ifdef UV_TIDES # ifdef M2CLIMATOLOGY # elif defined M2_FRC_BRY # else # define M2CLIMATOLOGY # define ANA_M2CLIMA # endif # endif #endif #ifdef TIDES_MAS # define MASKING #endif /* ====================================================================== WAVE_MAKER for wave-resolving simulations ====================================================================== */ #ifdef WAVE_MAKER # if defined WAVE_MAKER_JONSWAP || defined WAVE_MAKER_GAUSSIAN # define WAVE_MAKER_SPECTRUM # endif # ifdef WAVE_MAKER_SPECTRUM # ifdef WAVE_MAKER_JONSWAP # elif defined WAVE_MAKER_GAUSSIAN # else # define WAVE_MAKER_JONSWAP # endif # endif # ifndef WAVE_MAKER_SPECTRUM # define STOKES_WAVES # endif #endif /* ====================================================================== PSOURCE / PSOURCE_NCFILE option ====================================================================== */ #if defined PSOURCE || defined PSOURCE_MASS # define ANA_PSOURCE /* ON: set vertical profil for qbar */ # undef RIVER_RAMP #endif #ifdef PSOURCE_MASS # undef PSOURCE #endif #if defined PSOURCE_NCFILE # define PSOURCE # define ANA_PSOURCE # undef RIVER_RAMP #endif /* ====================================================================== Bulk flux option ====================================================================== ! ! Bulk algorithms (options) ! by default COARE3p0 parametrization is used with GUSTINESS effects ! ! To change bulk parametrization you have to define one the following cpp keys (not additional) : ! - define BULK_ECUMEV0 : used of ECUME_v0 parametrization ! - define BULK_ECUMEV6 : used of ECUME_v6 parametrization ! - define BULK_WASP : used of WASP parametrization ! Warning : it is possible to add GUSTINESS effects for all parametrizations by defining BULK_GUSTINESS cpp key ! */ #ifdef BULK_FLUX # ifdef ONLINE # define CUBIC_INTERP # ifdef BULK_MONTH_1DIGIT /* Check if options are defined in cppdefs.h */ # else # undef BULK_MONTH_1DIGIT # endif # endif # ifdef BULK_ECUMEV0 # define BULK_GUSTINESS # elif defined BULK_ECUMEV6 # define BULK_GUSTINESS # elif defined BULK_WASP # define BULK_GUSTINESS # endif #endif /* ====================================================================== Current feedback option ====================================================================== */ #ifdef SFLUX_CFB # ifdef BULK_FLUX # define CFB_STRESS # define CFB_WIND_TRA # else # undef CFB_STRESS # undef CFB_WIND_TRA # 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 defined WAVE_BREAK_TG86 # elif defined WAVE_BREAK_TG86A # elif defined WAVE_BREAK_R93 # elif defined WAVE_BREAK_BJ78 # else # define WAVE_BREAK_CT93 /* defaults */ # endif #endif /* WKB specific options */ #ifdef WKB_WWAVE # ifdef MRL_CEW # undef WKB_KZ_FILTER # undef WKB_TIME_FILTER # endif # define WKB_ADD_DIFF # define WKB_ADD_DIFFRACTION # undef WKB_NUDGING # ifndef WAVE_OFFLINE # undef WKB_NUDGING # endif # if defined SHOREFACE || defined SANDBAR \ || (defined RIP && !defined BISCA) # define ANA_BRY_WKB # endif #endif #ifdef MRL_WCI # define STOKES_DRIFT /* Stokes drift */ /* Default WCI is with input file data (WAVE_OFFLINE) */ # if !defined WKB_WWAVE && !defined ANA_WWAVE && !defined OW_COUPLING # define WAVE_OFFLINE # undef WAVE_ROLLER # endif #endif #if defined WKB_WWAVE || defined OW_COUPLING \ || (defined WAVE_OFFLINE && defined MRL_WCI) # define WAVE_IO #endif /* ====================================================================== KPP options IF-less KPP --> KPP2005 ====================================================================== */ #if defined 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 */ # ifdef XIOS # undef DIAGNOSTICS_BIO # undef key_trc_diaadd # endif # ifdef DIAGNOSTICS_BIO # define key_trc_diaadd # endif # endif # ifdef BIO_BioEBUS # undef VAR_CHL_C /* Under Development */ # undef CARBON /* Under Development */ # undef HYDROGEN_SULFIDE /* Under Development */ # endif #endif /* ====================================================================== Bottom forcing: By default: define ANA_BTFLUX : set to zero in analytical.F define ANA_BSFLUX - define BHFLUX : bottom heat flux, Btflx(i,j,itemp), is read into the netcdf file croco_btf.nc - define BWFLUX : bottom freshwater flux, Btflx(i,j,isalt), is read into a netcdf file(croco_btf.nc) ====================================================================== */ #if !defined ANA_BTFLUX # define BHFLUX #endif #if !defined ANA_BSFLUX && defined SALINITY # define BWFLUX #endif /* ====================================================================== Bottom stress option: LIMIT_BSTRESS: Set limiting factor for bottom stress and avoid numerical instability associated with reversing bottom flow NOW replaced by BSTRESS_FAST option ====================================================================== */ /* #ifndef BSTRESS_FAST # define LIMIT_BSTRESS #endif */ #ifdef INNERSHELF # undef LIMIT_BSTRESS #endif #ifdef BBL # ifdef OW_COUPLING # elif defined WAVE_OFFLINE # elif defined WKB_WWAVE # else # define ANA_WWAVE # endif # 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 (USGS sediment model/Mustang) ====================================================================== */ /* ===== CROCO-USGS SEDIMENT model ===== */ #ifdef SEDIMENT # undef MUSTANG # define ANA_SEDIMENT # undef BED_ARMOR # undef BED_HIDEXP # ifdef BEDLOAD # ifdef BEDLOAD_VANDERA /* == BEDLOAD scheme == */ # elif defined BEDLOAD_MPM /* Meyer-Peter & Muller */ # elif defined BEDLOAD_WULIN /* Wu & Lin */ # elif defined BEDLOAD_MARIEU /* Marieu */ # else /* --> default scheme: */ # if (defined WAVE_OFFLINE || defined WKB_WWAVE ||\ defined ANA_WWAVE || defined OW_COUPLING) # define BEDLOAD_VANDERA /* Van der A */ # else # define BEDLOAD_WULIN /* Wu & Lin */ # endif # endif # ifdef BEDLOAD_UP1 /* == INTERPOLATION == */ # elif defined BEDLOAD_UP5 /* upwind 5th order */ # elif defined BEDLOAD_WENO5 /* WENO 5th order */ # else # define BEDLOAD_UP1 /* default: Up-1st order */ # endif # ifdef SLOPE_LESSER /* == SLOPE scheme == */ # elif defined SLOPE_NEMETH /* Nemeth */ # elif defined SLOPE_KIRWAN /* Kirwan */ # else # define SLOPE_LESSER /* default: Lesser */ # endif # endif /* BEDLOAD */ # ifdef DUNE # ifdef ANA_DUNE # undef SLOPE_LESSER # endif # endif /* DUNE */ #endif /* SEDIMENT */ /* ===== MUSTANG SEDIMENT model ===== */ #ifdef MUSTANG # undef SEDIMENT # define SUBSTANCE # define USE_CALENDAR # define TEMPERATURE # define SALINITY # define key_noTSdiss_insed # define key_nofluxwat_IWS #endif /* MUSTANG */ #ifdef SUBSTANCE # define key_CROCO #endif /* ====================================================================== Hydro-morphodynamic coupling (Moving Bathymetry) -> MORPHODYN: Morphodynamics (bed evolution & feedback on circulation) ... must be defined for coupling with SEDIMENT model -> ANA_MORPHODYN: Analytical function of oscillating bathymetry (ifndef SEDIMENT) MORPHODYN or ANA_MORPHODYN must be defined in cppdefs.h ANA_MORPHODYN triggers MORPHODYN below ANA_MORPHODYN and SEDIMENT are incompatible for now MORPHODYN && NBQ needs NBQ_FREESLIP ====================================================================== */ #ifdef ANA_MORPHODYN # define MORPHODYN #endif #if defined SEDIMENT || defined MUSTANG # undef ANA_MORPHODYN #endif #if defined MORPHODYN && defined MUSTANG # define MORPHODYN_MUSTANG_byHYDRO #endif #if defined MORPHODYN && defined NBQ # define NBQ_FREESLIP #endif /* ====================================================================== OBCs ====================================================================== */ #if defined OBC_EAST || defined OBC_WEST || defined OBC_SOUTH\ || defined OBC_NORTH # ifdef OBC_M2SPECIFIED # elif defined OBC_M2CHARACT # elif defined OBC_M2ORLANSKI # else # undef OBC_M2SPECIFIED # 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 */ # if defined Z_FRC_BRY || defined M2_FRC_BRY ||\ defined M3_FRC_BRY || defined T_FRC_BRY ||\ defined ANA_BRY # define FRC_BRY # endif #endif /* OBC */ /* ====================================================================== AGRIF nesting ====================================================================== */ #ifdef AGRIF # define key_agrif /* Update schemes */ # undef AGRIF_UPDATE_MIX_LOW # define AGRIF_UPDATE_MIX # undef 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 # ifdef NBQ # define AGRIF_OBC_WSPECIFIED # define AGRIF_OBC_NBQSPECIFIED # endif #endif /* AGRIF */ #if defined AGRIF && defined EXACT_RESTART # error "AGRIF with EXACT_RESTART is not yet implemented" #endif #if defined AGRIF && defined XIOS && \ ( defined OA_COUPLING || defined OW_COUPLING ) # error "AGRIF + XIOS + OASIS coupling is not yet implemented" #endif #if defined AGRIF && defined USE_CALENDAR #error "AGRIF + USE_CALENDAR is not yet implemented" #endif /* ====================================================================== Standard I/O ====================================================================== Set land mask value to _FillValue */ #ifndef FILLVAL # undef FILLVAL #endif /* 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) */ /* Define the NetCDF creation mode flag: nf_clobber (classic), nf_64bit_offset (large files) or nf_netcdf4 */ #ifdef NC4PAR # define NF_CLOBBER nf_mpiio #else # define NF_CLOBBER nf_64bit_offset #endif /* ====================================================================== Exchange at boundaries ====================================================================== */ #if defined EW_PERIODIC || defined NS_PERIODIC || defined MPI || (defined OPENACC && defined OPENMP) #define BD_EXCHANGE #else #undef BD_EXCHANGE #endif /* ====================================================================== Consistency for 2D configurations ====================================================================== */ #ifndef SOLVE3D # undef AVERAGES_K # undef TRACERS # undef TEMPERATURE # 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 SFLUX_CFB # 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 #if !defined OPENACC #define ENDDOLOOP2D enddo #define DOLOOP2D_R(irange,jrange) do j=jrange #define DOLOOP2D(i1,i2,j1,j2) do j=j1,j2 #else #define DOLOOP2D_R(irange,jrange) DOLOOP2D(irange,jrange) #endif