Skip to content

Commit 35ae5c1

Browse files
committed
Fix up documentation
1 parent 899fb43 commit 35ae5c1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sumpy/recurrence_grid.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@
6464

6565

6666
def get_grid(recur, order):
67+
r"""
68+
A function that takes in a recurrence as a polynomial
69+
in s(n), s(n-1), ..., and gets the coefficients of this polynomial as
70+
a polynomial in 1, x_0, x_0^2, ... where x_i is the source location.
71+
72+
:arg recur: A recurrence for derivatives s(n), etc. where s(n) represents
73+
the nth derivative of the Green's function w/respect to the target at the origin.
74+
:arg order: The order of the input recurrence
75+
"""
6776
poly_in_s_n = sp.poly(recur, [s(n-i) for i in range(order)])
6877
coeff_s_n = [poly_in_s_n.coeff_monomial(poly_in_s_n.gens[i]) for i in range(order)]
6978

@@ -75,6 +84,9 @@ def get_grid(recur, order):
7584

7685

7786
def convert(grid):
87+
r"""
88+
Given a grid of coefficients, produce a grid recurrence.
89+
"""
7890
recur_exp = 0
7991
i = sp.symbols("i")
8092
s_terms = []

0 commit comments

Comments
 (0)