Skip to content

Commit

Permalink
Document make_velocities
Browse files Browse the repository at this point in the history
  • Loading branch information
FedericoStra committed Aug 12, 2021
1 parent 99b9f91 commit 087926c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/velocities.jl
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,10 @@ end
make_velocity(V::Function, Wprime::Function, mobility::Function)
Creates a function `velocity(dx, x, p, t)` that computes the velocity of the particles
under the influence of an external force `V`, a mutual interaction `Wprime` and the
under the influence of an external velocity `V`, a mutual interaction `Wprime` and the
congestion given by `mobility`.
See also [`make_velocities`](@ref).
"""
function make_velocity(V::Function, Wprime::Function, mobility::Function)
function velocity(dx, x, p, t)
Expand All @@ -194,6 +196,15 @@ function make_velocity(V::Function, Wprime::Function, mobility::Function)
velocity
end

"""
make_velocities((V₁, ...), ((W′₁₁, ...), ...), (mob₁, ...))
Creates a function `velocities(dx, x, p, t)` that computes the velocity of the particles
under the influence of the external velocities `Vᵢ`, mutual interactions `W′ᵢⱼ` and
congestions given by `mobᵢ`.
See also [`make_velocity`](@ref).
"""
function make_velocities(
Vs::Tuple{Vararg{Any,N}},
Wprimes::Tuple{Vararg{Tuple{Vararg{Any,N}},N}},
Expand Down

0 comments on commit 087926c

Please sign in to comment.