Granular.jl

commit 06506b845e2f703b7c90d99aea71837b0b53ac93
parent 9377d1980d99d3dcf6b1a344a58e6e3233a17a49
Author: Anders Damsgaard <andersd@riseup.net>
Date:   Wed,  1 Nov 2017 15:07:15 -0400

add documentation on bc_* parameters

Diffstat:
M
src/datatypes.jl
 | 
24
++++++++++++++++++++++++

1 file changed, 24 insertions(+), 0 deletions(-)
diff --git a/src/datatypes.jl b/src/datatypes.jl
@@ -164,6 +164,18 @@ h-points.  During read, the velocities are interpolated to the cell corners
     dimensions correspond to placement in `[xh, yh, zi, time]`.
 * `grain_list::Array{Float64, Int}`: indexes of grains contained in the 
     ocean grid cells.
+* `bc_west::Integer`: Boundary condition type for the west edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_south::Integer`: Boundary condition type for the south edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_east::Integer`: Boundary condition type for the east edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_north::Integer`: Boundary condition type for the north edge of the grid.
+        0: inactive,
+        1: periodic
 =#
 mutable struct Ocean
     input_file::Any
@@ -229,6 +241,18 @@ cell corners (q-points).
     dimensions correspond to placement in `[xq, yq, zl, time]`.
 * `grain_list::Array{Float64, Int}`: interface height relative to mean sea 
     level [m],  dimensions correspond to placement in `[xh, yh, zi, time]`.
+* `bc_west::Integer`: Boundary condition type for the west edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_south::Integer`: Boundary condition type for the south edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_east::Integer`: Boundary condition type for the east edge of the grid.
+        0: inactive,
+        1: periodic
+* `bc_north::Integer`: Boundary condition type for the north edge of the grid.
+        0: inactive,
+        1: periodic
 =#
 mutable struct Atmosphere
     input_file::Any