From 087926cc816f901aae1235f384466975a49e0744 Mon Sep 17 00:00:00 2001 From: Federico Stra Date: Thu, 12 Aug 2021 19:17:36 +0200 Subject: [PATCH] Document `make_velocities` --- src/velocities.jl | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/velocities.jl b/src/velocities.jl index 12b2fb3..810b243 100644 --- a/src/velocities.jl +++ b/src/velocities.jl @@ -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) @@ -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}},