summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2016-02-13 11:02:42 +0100
committerAnton Khirnov <anton@khirnov.net>2016-02-13 11:40:48 +0100
commit5c4aa531fbaf2bf425620c22279810c9df1b3800 (patch)
tree129bab15708dd07cba387f419ec4104c6754fd01
parent0ac59706a5f63effedba2e97208db850dc3a70c2 (diff)
nonlin_ode: fix a typo in the documentation
-rw-r--r--nonlin_ode.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/nonlin_ode.py b/nonlin_ode.py
index 4944541..754f410 100644
--- a/nonlin_ode.py
+++ b/nonlin_ode.py
@@ -41,11 +41,11 @@ def nonlin_solve_1d(initial_guess, Fs, args, maxiter = 100, atol = 1e-14, grid =
initial_guess (SeriesExpansion): The initial guess, from which the iteration is started.
The spectral basis and its order are inferred from the
initial guess.
- Fs (list of callables): The right-hand side of the ODE and its derivatives. I.e. Fs[0] is F,
- Fs[i] is d^i F / dx^i. The order of the equation n is determined by
+ Fs (list of callables): The right-hand side of the ODE and its variational derivatives. I.e. Fs[0] is F,
+ Fs[i] is δF / δu^(i). The order of the equation n is determined by
the length of Fs minus one. Each callable must accept 3 parameters:
- a numpy array containing the values of x
- - an iterable of n numpy arrays containing the values of F and
+ - an iterable of n numpy arrays containing the values of u and
its derivatives at x
- a tuple of additional parameters passed to nonlin_solve_1d as args
args (tuple): Extra parameters passed to the Fs.