commit fe0c1c4c3ed7188621c45f618ebe7f74b49a2b00
parent 67a484aedb7d2a0ba47d653da95ebfe16ae12da5
Author: Anders Damsgaard <andersd@riseup.net>
Date: Fri, 28 Apr 2017 13:53:43 -0400
add note in docstring about vertical ocean coordinates
Diffstat:
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/ocean.jl b/src/ocean.jl
@@ -206,7 +206,8 @@ Initialize and return a regular, Cartesian `Ocean` grid with `n[1]` by `n[2]`
cells in the horizontal dimension, and `n[3]` vertical cells. The cell corner
and center coordinates will be set according to the grid spatial dimensions
`L[1]`, `L[2]`, and `L[3]`. The grid `u`, `v`, `h`, and `e` fields will contain
-one 4-th dimension matrix per `time` step.
+one 4-th dimension matrix per `time` step. Sea surface will be at `z=0.` with
+the ocean spanning `z<0.`.
"""
function createRegularOceanGrid(n::Array{Int, 1},
L::Array{float, 1};