.. _doc.manual.clesCPP: Choice of **CPP keys** before compilation ============================================== * **In Makefile.caparmor : add CPP_keys in CPPFLAGS =** * **select variables namelists their corresponding** * **List of CPP keys** +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | GRID || -Dkey_bathy_final | | to read definite bathymetry in netCDF format file (no more changes) | | || -Dkey_out_grid_smallsize | | dont save in output the full set of variables for the grid | | || -Dkey_grid_curv | | Use to deal with orthogonal curvilinear grids (read 2D angle & dx,dy in the bathy_file) | | || | | custom the missing value of the grid in parameters.F90 (valmanq_curv) | | || | | to use with *-Dkey_sflx_interp_scrip* | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ +-----------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | ROTATED GRID | | -Dkey_grid_rotated | | to use a rotated grid | | | | -Dkey_tide_saverotatedobc | | to save 2D obc for a rotated child rank | +-----------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | | TIDE | | -Dkey_tide_schwid | | schwiderski model (1980), modele de pg Islande-Portugal (5 km) **l_tide_harmcompo=true** | | | choice of harmonic components | | -Dkey_tide_fes2004 | | FES 2004 (MOGD) **l_tide_harmcompo=true** | | | | | -Dkey_tide_fes2012 | | FES 2012 (MOGD) **l_tide_harmcompo=true** | | | | | -Dkey_tide_shom | | CST - File Shom - Channel Atlantic Fr **l_tide_harmcompo=true** | | | | | -Dkey_tide_shom_bilinear | | Bilinear interpolation for harmonic components on the model grid | | | | | -Dkey_tide_lagoon | | lagoons of Banuyls and Marseilles | | | | | -Dkey_tide_lagoon_banyuls | | tide for Banyuls | | | | | -Dkey_tide_lagoon_marseille | | tide for Marseilles | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | UNLINEAR TERMS | | default | | centered | | | | -Dkey_dyn_adv_quick | | QUICK | | | | -Dkey_dyn_adv_quickest | | QUICKEST | | | | -Dkey_dyn_adv_linear | | no nonlinear terms | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | INTERNAL PRESSURE GRADIENT | | default | | Density jacobian | | | | -Dkey_dyn_pg_djcs | | Density jacobien + cubic spline approx (Shchepetkin et al. 2004) | | | | -Dkey_dyn_pg_pint | | Marsaleix et al;2009 (integrated pressure before horizontal gradient) | | | | -Dkey_dyn_pg_dj | | Shchepetkin et Mc Williams, 2003 (density jacobian) | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | WET DRYING | | -Dkey_dyn_wetdry_fct | | use of Flux Corrected Transport to correct ssh and velocity estimates | | | | | | + and keep positive water depths in wet-drying area | | | | -Dkey_phicondrycell | | with key_substance if outflow into a dry cell during ebb tide | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | OPEN BOUNDARY CONDITIONS | | default | | reading and saving for straight open boundary | | | | -Dkey_grid_rotated | | reading with the use of a rotated child grid - | | | | | | + Longitude and latitude read from the bathy file | | | | -Dkey_tide_saveobcrotated | | saving for straight open boundary but using a rotated child grid | | | | | | + Define imin_child… variables in parameter.F90 and **file_bathy_child=‘file.nc’** | | | | | | Direct offline coupling : Use **extract tool** to prepare your obc fields | | | | | | + l_obc_ogcm : nesting with an ogcm | | | | | | + l_obc_tide : Nesting with a previous rank or from harmonics | | | | | | + l_obc_north.... & file_obc_ogcm_n... : Where are the open boundaries & Which obc file | | | | | | + l_obc_mars : MARS standard Sea surface height is prescribed & Gradient nul for velocity| | | | | | + l_obc_cycl : CYCLIC zonaly or meridionaly | | | | | | + l_obc_char : Caracteristics method (2D part only) | | | | | | + l_obc_diri : DIRICHLET : | | | | | | SSH prescribed (strong condition) & Velocities prescribed (weak condition) | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | OPEN BOUNDARY CONDITIONS | | default | | constant value or reading value in an OBC file | | FOR SUBSTANCES | | | | depending on l_obc_ogcm_rc (in parasubs.txt) | | | | | | | | :ref:`boundaries_substance` | | -Dkey_zerograd | | using **zero gradient condition** | | | | | | for some variables with "*zerograd*" instead of "*none*" or "*name of variable obc*" | | | | | | in variable.dat | | | | | | choose l_obc_coefrel for relaxation time | +---------------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | VERTICAL VELOCITY | | -Dkey_diag_physwz | | Estimate and save physical vertical velocity | | (wz_phys) | | | | | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | VERTICAL DIFFUSION | | no CPP key | | Choice of modele with namelist variables : turb_nbeq, turb_0eq_option or turb_2eq_option | | (nz, kz) | | | | see :ref:`doc.vertmixing` | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | VISCOSITY | | no CPP key | | Choice with namelist variables : l_smagor (viscosity constant or Smagorinsky, 1963) | | | | | | Sponge layer at each open boundary | || VERTICAL VISCOSITY | | -Dkey_les | | Compute viscosity from both horizontal and vertical shear | | | | | | in case of SMAGORINSKY (l_smagor=.true.) | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | STATE EQUATION | | no CPP key | | Choice of modele with namelist variables : l_stateeq_lin (linear model or not) | | | | -Dkey_potential_N2 | | estimate the potential brunt-vaisala frequency (used in turbulence formulation) | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | VERTICAL DISCRETIZATION | | default | | sigma : **l_equisig=.true.** Or **.false.** so specify sig for each level | | (xy direction) | | -Dkey_siggen | | generalized sigma : **l_equisig=.true.** (*do not change*) | | | | | | choice hc, teta_sig, b_sig. example : hc = 5.0 ; theta_sig=0.000001 ; b_sig=1 | | | | | | let theta_sig go to zero to get pure sigma coordinates | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | TRACER ADVECTION | | -Dkey_tssub_macho3d | | Macho scheme | | (multidimensional 3D | | | | | | including cross term) | | | | | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | TRACER ADVECTION | | default | | Quick / Euler-Upwind scheme | | (xy direction) | | -Dkey_tssub_adv_ultimatequickest | | quickest scheme (xy direction) + ultimate limiter | | DISSOLVED | | -Dkey_tssub_adv_ultimatequickestmacho | | quickest scheme+ultimate limiter + multidimensional extension macho | | | | -Dkey_tssub_adv_fourthorder | | fourth order centred scheme (xy direction) | | PARTICULATE | | -Dkey_parsub_adv_ultimatequickest | | quickest scheme (xy direction) + ultimate limiter | | | | -Dkey_parsub_adv_ultimatequickestmacho | | quickest scheme+ultimate limiter + multidimensional extension macho | | | | -Dkey_parsub_adv_fourthorder | | fourth order centred scheme (xy direction) | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | TRACER ADVECTION | | default | | centered scheme | | (along z) | | -Dkey_tssub_wquickupwind | | QUICK scheme along the vertical (dissolved tracer advection) | | | | -Dkey_tssub_wcompact | | Upwind Compact and Conservative scheme along the vertical (dissolved variables) | | | | -Dkey_parsub_wquickupwind | | QUICK scheme along the vertical (particulate tracer advection) | | | | -Dkey_parsub_wcompact | | Upwind Compact and Conservative scheme along the vertical (particulate variables) | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | VERTICAL ADVECTION | | -Dkey_adapt_imp_vert_adv | | Adaptive Courant-number-dependent implicit scheme for vertical advection | | | | | | (for Tracers and moment) | | | | | | | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ | TRACER DIFFUSION | | default | | along sigma | | | | -Dkey_ts_diffh_geo | | along geopotential | | | | -Dkey_ts_diffh_rho | | along isopycnes | +--------------------------+------------------------------------------+----------------------------------------------------------------------------------------------+ +-----------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | SURFACE FLUX | | -Dkey_sflx_interp_scrip | | Use SCRIP bicubic interpolation for atmospherical inputs | +-----------------------------+--------------------------------------+----------------------------------------------------------------------------------------------+ | | | default | | extinction formulated with 2 wave length and coeff adapted for clear water (5