GopherProxy

	tImprove docstrings for createRegularOceanGrid and createRegularAtmosphereGrid …
	git clone git://src.adamsgaard.dk/Granular.jl
	Log
	Files
	Refs
	README
	LICENSE
	---
	commit 1dab14f9bc7ecc1d4aa70eb5f8ac0979b2fe1247
	parent 5806672d685e0803a6360cea543a269d25697614
	Author: Anders Damsgaard <[email protected]>
	Date: Wed, 24 Jan 2018 14:36:26 -0500

	Improve docstrings for createRegularOceanGrid and
	createRegularAtmosphereGrid

	Diffstat:
	M src/atmosphere.jl \| 29 ++++++++++++++++++++++-------
	M src/ocean.jl \| 16 ++++++++++++++++

	2 files changed, 38 insertions(+), 7 deletions(-)
	---
	diff --git a/src/atmosphere.jl b/src/atmosphere.jl
	t@@ -100,13 +100,28 @@ end

	export createRegularAtmosphereGrid
	"""
	-Initialize and return a regular, Cartesian `Atmosphere` grid with `n[1]` by `n…
	-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 conta…
	-one 4-th dimension matrix per `time` step. Sea surface will be at `z=0.` with
	-the atmosphere spanning `z<0.`. Vertical indexing starts with `k=0` at the se…
	-surface, and increases downwards.
	+ createRegularAtmosphereGrid(n, L[, origo, time, name,
	+ bc_west, bc_south, bc_east, bc_north])
	+
	+Initialize and return a regular, Cartesian `Atmosphere` 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. Sea surface will be at
	+`z=0.` with the atmosphere spanning `z<0.`. Vertical indexing starts with `k=…
	+at the sea surface, and increases downwards.
	+
	+# Arguments
	+* `n::Vector{Int}`: number of cells along each dimension [-].
	+* `L::Vector{Float64}`: domain length along each dimension [m].
	+* `origo::Vector{Float64}`: domain offset in each dimension [m] (default =
	+ `[0.0, 0.0]`).
	+* `time::Vector{Float64}`: vector of time stamps for the grid [s].
	+* `name::String`: grid name (default = `"unnamed"`).
	+* `bc_west::Integer`: grid boundary condition for the grains.
	+* `bc_south::Integer`: grid boundary condition for the grains.
	+* `bc_east::Integer`: grid boundary condition for the grains.
	+* `bc_north::Integer`: grid boundary condition for the grains.
	"""
	function createRegularAtmosphereGrid(n::Vector{Int},
	L::Vector{Float64};
	diff --git a/src/ocean.jl b/src/ocean.jl
	t@@ -214,6 +214,10 @@ end

	export createRegularOceanGrid
	"""
	+
	+ createRegularOceanGrid(n, L[, origo, time, name,
	+ bc_west, bc_south, bc_east, bc_north])
	+
	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
	t@@ -221,6 +225,18 @@ and center coordinates will be set according to the grid …
	one 4-th dimension matrix per `time` step. Sea surface will be at `z=0.` with
	the ocean spanning `z<0.`. Vertical indexing starts with `k=0` at the sea
	surface, and increases downwards.
	+
	+# Arguments
	+* `n::Vector{Int}`: number of cells along each dimension [-].
	+* `L::Vector{Float64}`: domain length along each dimension [m].
	+* `origo::Vector{Float64}`: domain offset in each dimension [m] (default =
	+ `[0.0, 0.0]`).
	+* `time::Vector{Float64}`: vector of time stamps for the grid [s].
	+* `name::String`: grid name (default = `"unnamed"`).
	+* `bc_west::Integer`: grid boundary condition for the grains.
	+* `bc_south::Integer`: grid boundary condition for the grains.
	+* `bc_east::Integer`: grid boundary condition for the grains.
	+* `bc_north::Integer`: grid boundary condition for the grains.
	"""
	function createRegularOceanGrid(n::Vector{Int},
	L::Vector{Float64};