tchange symbol for argument lists - Granular.jl - Julia package for granular dy… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 1f2f39e1e34300057dd0d2dbd4631d085f24f3df | |
parent 07af9e22d90c294225e4554ec551106fa84381e8 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Tue, 12 Sep 2017 10:19:15 -0400 | |
change symbol for argument lists | |
Diffstat: | |
M src/icefloe.jl | 96 ++++++++++++++++-------------… | |
1 file changed, 48 insertions(+), 48 deletions(-) | |
--- | |
diff --git a/src/icefloe.jl b/src/icefloe.jl | |
t@@ -29,69 +29,69 @@ are optional, and come with default values. The only requ… | |
`simulation`, `lin_pos`, `contact_radius`, and `thickness`. | |
# Arguments | |
-- `simulation::Simulation`: the simulation object where the ice floe should be | |
+* `simulation::Simulation`: the simulation object where the ice floe should be | |
added to. | |
-- `lin_pos::Vector{Float64}`: linear position of ice-floe center [m]. | |
-- `contact_radius::Float64`: ice-floe radius for granular interaction [m]. | |
-- `thickness::Float64`: ice-floe thickness [m]. | |
-- `areal_radius = false`: ice-floe radius for determining sea-ice concentration | |
+* `lin_pos::Vector{Float64}`: linear position of ice-floe center [m]. | |
+* `contact_radius::Float64`: ice-floe radius for granular interaction [m]. | |
+* `thickness::Float64`: ice-floe thickness [m]. | |
+* `areal_radius = false`: ice-floe radius for determining sea-ice concentration | |
[m]. | |
-- `lin_vel::Vector{Float64} = [0., 0.]`: linear velocity [m/s]. | |
-- `lin_acc::Vector{Float64} = [0., 0.]`: linear acceleration [m/s^2]. | |
-- `force::Vector{Float64} = [0., 0.]`: linear force balance [N]. | |
-- `ang_pos::Float64 = 0.`: angular position around its center vertical axis | |
+* `lin_vel::Vector{Float64} = [0., 0.]`: linear velocity [m/s]. | |
+* `lin_acc::Vector{Float64} = [0., 0.]`: linear acceleration [m/s^2]. | |
+* `force::Vector{Float64} = [0., 0.]`: linear force balance [N]. | |
+* `ang_pos::Float64 = 0.`: angular position around its center vertical axis | |
[rad]. | |
-- `ang_vel::Float64 = 0.`: angular velocity around its center vertical axis | |
+* `ang_vel::Float64 = 0.`: angular velocity around its center vertical axis | |
[rad/s]. | |
-- `ang_acc::Float64 = 0.`: angular acceleration around its center vertical axis | |
+* `ang_acc::Float64 = 0.`: angular acceleration around its center vertical axis | |
[rad/s^2]. | |
-- `torque::Float64 = 0.`: torque around its center vertical axis [N*m] | |
-- `density::Float64 = 934.`: ice-floe mean density [kg/m^3]. | |
-- `contact_stiffness_normal::Float64 = 1e7`: contact-normal stiffness [N/m]; | |
+* `torque::Float64 = 0.`: torque around its center vertical axis [N*m] | |
+* `density::Float64 = 934.`: ice-floe mean density [kg/m^3]. | |
+* `contact_stiffness_normal::Float64 = 1e7`: contact-normal stiffness [N/m]; | |
overridden if `youngs_modulus` is set to a positive value. | |
-- `contact_stiffness_tangential::Float64 = 0.`: contact-tangential stiffness | |
+* `contact_stiffness_tangential::Float64 = 0.`: contact-tangential stiffness | |
[N/m]; overridden if `youngs_modulus` is set to a positive value. | |
-- `contact_viscosity_normal::Float64 = 0.`: contact-normal viscosity [N/m/s]. | |
-- `contact_viscosity_tangential::Float64 = 0.`: contact-tangential viscosity | |
+* `contact_viscosity_normal::Float64 = 0.`: contact-normal viscosity [N/m/s]. | |
+* `contact_viscosity_tangential::Float64 = 0.`: contact-tangential viscosity | |
[N/m/s]. | |
-- `contact_static_friction::Float64 = 0.4`: contact static Coulomb frictional | |
+* `contact_static_friction::Float64 = 0.4`: contact static Coulomb frictional | |
coefficient [-]. | |
-- `contact_dynamic_friction::Float64 = 0.4`: contact dynamic Coulomb frictional | |
+* `contact_dynamic_friction::Float64 = 0.4`: contact dynamic Coulomb frictional | |
coefficient [-]. | |
-- `youngs_modulus::Float64 = 2e7`: elastic modulus [Pa]; overrides any value | |
+* `youngs_modulus::Float64 = 2e7`: elastic modulus [Pa]; overrides any value | |
set for `k_n`. | |
-- `poissons_ratio::Float64 = 0.185`: Poisson's ratio, used to determine the | |
+* `poissons_ratio::Float64 = 0.185`: Poisson's ratio, used to determine the | |
contact-tangential stiffness from `youngs_modulus` [-]. | |
-- `tensile_strength::Float64 = 0.`: contact-tensile (cohesive) bond strength | |
+* `tensile_strength::Float64 = 0.`: contact-tensile (cohesive) bond strength | |
[Pa]. | |
-- `tensile_heal_rate::Float64 = 0.`: rate at which contact-tensile bond streng… | |
+* `tensile_heal_rate::Float64 = 0.`: rate at which contact-tensile bond streng… | |
is obtained [1/s]. | |
-- `compressive_strength_prefactor::Float64 = 1285e3`: maximum compressive | |
+* `compressive_strength_prefactor::Float64 = 1285e3`: maximum compressive | |
strength on granular contact (not currently enforced) [m*Pa]. | |
-- `ocean_drag_coeff_vert::Float64 = 0.85`: vertical drag coefficient for ocean | |
+* `ocean_drag_coeff_vert::Float64 = 0.85`: vertical drag coefficient for ocean | |
against ice-floe sides [-]. | |
-- `ocean_drag_coeff_horiz::Float64 = 5e-4`: horizontal drag coefficient for | |
+* `ocean_drag_coeff_horiz::Float64 = 5e-4`: horizontal drag coefficient for | |
ocean against ice-floe bottom [-]. | |
-- `atmosphere_drag_coeff_vert::Float64 = 0.4`: vertical drag coefficient for | |
+* `atmosphere_drag_coeff_vert::Float64 = 0.4`: vertical drag coefficient for | |
atmosphere against ice-floe sides [-]. | |
-- `atmosphere_drag_coeff_horiz::Float64 = 2.5e-4`: horizontal drag coefficient | |
+* `atmosphere_drag_coeff_horiz::Float64 = 2.5e-4`: horizontal drag coefficient | |
for atmosphere against ice-floe bottom [-]. | |
-- `pressure::Float64 = 0.`: current compressive stress on ice floe [Pa]. | |
-- `fixed::Bool = false`: ice floe is fixed in space. | |
-- `rotating::Bool = true`: ice floe is allowed to rotate. | |
-- `enabled::Bool = true`: ice floe interacts with other ice floes. | |
-- `verbose::Bool = true`: display diagnostic information during the function | |
+* `pressure::Float64 = 0.`: current compressive stress on ice floe [Pa]. | |
+* `fixed::Bool = false`: ice floe is fixed in space. | |
+* `rotating::Bool = true`: ice floe is allowed to rotate. | |
+* `enabled::Bool = true`: ice floe interacts with other ice floes. | |
+* `verbose::Bool = true`: display diagnostic information during the function | |
call. | |
-- `ocean_grid_pos::Array{Int, 1} = [0, 0]`: position of ice floe in the ocean | |
+* `ocean_grid_pos::Array{Int, 1} = [0, 0]`: position of ice floe in the ocean | |
grid. | |
-- `atmosphere_grid_pos::Array{Int, 1} = [0, 0]`: position of ice floe in the | |
+* `atmosphere_grid_pos::Array{Int, 1} = [0, 0]`: position of ice floe in the | |
atmosphere grid. | |
-- `n_contacts::Int = 0`: number of contacts with other ice floes. | |
-- `granular_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe | |
+* `n_contacts::Int = 0`: number of contacts with other ice floes. | |
+* `granular_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe | |
from granular interactions [Pa]. | |
-- `ocean_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe from | |
+* `ocean_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe from | |
ocean drag [Pa]. | |
-- `atmosphere_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe | |
+* `atmosphere_stress::Vector{Float64} = [0., 0.]`: resultant stress on ice floe | |
from atmosphere drag [Pa]. | |
# Examples | |
t@@ -651,18 +651,18 @@ plot is saved accoring to the simulation id, the optiona… | |
string, and the `filetype`, and is written to the current folder. | |
# Arguments | |
-- `simulation::Simulation`: the simulation object containing the ice floes. | |
-- `filename_postfix::String`: optional string for the output filename. | |
-- `nbins::Int`: number of bins in the histogram (default = 12). | |
-- `size_type::String`: specify whether to use the `contact` or `areal` radius | |
+* `simulation::Simulation`: the simulation object containing the ice floes. | |
+* `filename_postfix::String`: optional string for the output filename. | |
+* `nbins::Int`: number of bins in the histogram (default = 12). | |
+* `size_type::String`: specify whether to use the `contact` or `areal` radius | |
for the ice-floe size. The default is `contact`. | |
-- `figsize::Tuple`: the output figure size in inches (default = (6,4). | |
-- `filetype::String`: the output file type (default = "png"). | |
-- `verbose::String`: show output file as info message in stdout (default = | |
+* `figsize::Tuple`: the output figure size in inches (default = (6,4). | |
+* `filetype::String`: the output file type (default = "png"). | |
+* `verbose::String`: show output file as info message in stdout (default = | |
true). | |
-- `skip_fixed::Bool`: ommit ice floes that are fixed in space from the size | |
+* `skip_fixed::Bool`: ommit ice floes that are fixed in space from the size | |
distribution (default = true). | |
-- `logy::Bool`: plot y-axis in log scale. | |
+* `logy::Bool`: plot y-axis in log scale. | |
""" | |
function plotIceFloeSizeDistribution(simulation::Simulation; | |
filename_postfix::String = "", |