tupdate documentation for addIceFloeCylindrical! - Granular.jl - Julia package for granular dynamics simulation
HTML git clone git://src.adamsgaard.dk/Granular.jl
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit f8a4b1a273e29811ec8ffaa7775c98e605aac507
DIR parent 1f2f39e1e34300057dd0d2dbd4631d085f24f3df
HTML Author: Anders Damsgaard <andersd@riseup.net>
Date: Tue, 12 Sep 2017 11:28:23 -0400
update documentation for addIceFloeCylindrical!
Diffstat:
M src/icefloe.jl | 26 +++++++++++++++++++++++---
1 file changed, 23 insertions(+), 3 deletions(-)
---
DIR diff --git a/src/icefloe.jl b/src/icefloe.jl
t@@ -96,10 +96,30 @@ are optional, and come with default values. The only required arguments are
# Examples
The most basic example adds a new ice floe to the simulation `sim`, with a
-center at `[1., 2., 3.]`, a radius of `1.` meter, and a thickness of `0.5`
-meter.
+center at `[1., 2.]`, a radius of `1.` meter, and a thickness of `0.5`
+meter:
- SeaIce.addIceFloeCylindrical(sim, [1., 2., 3.], 1., .5)
+```julia
+SeaIce.addIceFloeCylindrical!(sim, [1., 2.], 1., .5)
+```
+
+The following example will create a ice floe with tensile strength (cohesion),
+and a velocity of 0.5 m/s towards -x:
+
+```julia
+SeaIce.addIceFloeCylindrical!(sim, [4., 2.], 1., .5,
+ tensile_strength = 200e3,
+ lin_vel = [-.5, 0.])
+```
+
+Fixed ice floes are useful for creating walls or coasts, and loops are useful
+for creating regular arrangements:
+
+```julia
+for i=1:5
+ SeaIce.addIceFloeCylindrical!(sim, [i*2., 0., 3.], 1., .5, fixed=true)
+end
+```
"""
function addIceFloeCylindrical!(simulation::Simulation,
lin_pos::Vector{Float64},