verification/tutorial_plume_on_slope/README.md

ab47de63dc Mart*0001 Tutorial Example: "Gravity plume on a continental slope"
                0002 ========================================================
                0003 (formerly "plume_on_slope" verification ;
                0004  also "nonhydrostatic_plume_on_slope" in release.1 branch)
                0005
                0006 ### Overview:
                0007 This is a 2D set-up with (variable) high-resolution and non-hydrostatic dynamics, where dense water is produced on a shelf that then flows as a gravity current down the slope.
                0008
                0009 The **primary** test uses a no-slip bottom boundary condition (`no_slip_bottom=.TRUE.`) and no explicit drag.
                0010
                0011 The **secondary** test `rough.Bot` uses the logarithmic law of the wall to compute the drag coefficient for quadratic bottom drag as a function of distance from the bottom (i.e. cell thickness) and a prescribed roughness length `zRoughBot = 0.01` (in meters). For this configuration (i.e. vertical grid spacing) this value of `zRoughBot` corresponds to approximately `bottomDragQuadratic=5.E-2`. For consistency, the bottom boundary conditions is set to free slip (`no_slip_bottom=.FALSE.`).
                0012
                0013 ## Instructions
                0014 Configure and compile the code:
                0015
                0016 ```
                0017   cd build
                0018   ../../../tools/genmake2 -mods ../code [-of my_platform_optionFile]
                0019   make depend
                0020   make
                0021   cd ..
                0022 ```
                0023
                0024 To run:
                0025
                0026 ```
                0027   cd run
                0028   ln -s ../input/* .
                0029   ln -s ../build/mitgcmuv .
                0030   ./mitgcmuv > output.txt
                0031   cd ..
                0032 ```
                0033
                0034 To run the **secondary** test `roughBot`:
                0035
                0036 ```
                0037   cd run
                0038   rm *
                0039   ln -s ../input.roughBot/* .
                0040   ln -s ../input/* .
                0041   ../build/mitgcmuv > output.txt
                0042 ```
                0043
                0044 There is comparison output in the directory:
                0045
                0046 ```
                0047   results/output.txt
                0048   results/output.roughBot.txt
                0049 ```
                0050
                0051 ## Comments
                0052   The input data is `real*8` and generated using the MATLAB script
                0053   gendata.m.
                0054