Skip to content

Commit 965e478

Browse files
committed
Updated documentation of intnormflux
1 parent 5282197 commit 965e478

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

timml/model.py

+8-2
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ def intnormflux_segment(self, x1, y1, x2, y2, method="legendre", ndeg=10):
178178
return L * qn / 2.0
179179

180180
def intnormflux(self, xy, method="legendre", ndeg=10):
181-
"""Integrated normal (perpendicular) flux over polyline
181+
"""Integrated normal (perpendicular) flux over polyline giving
182+
the flux per segment and per aquifer.
182183
183184
Flux to the left is positive when going from (x1, y1) to (x2, y2).
184185
@@ -196,8 +197,13 @@ def intnormflux(self, xy, method="legendre", ndeg=10):
196197
197198
Returns
198199
-------
199-
Qn : np.array of length naq
200+
Qn : np.array of shape (naq, nsegments)
200201
integrated normal flux along specified polyline
202+
203+
Example
204+
-------
205+
Total flow across polyline can be obtained using np.sum(Qn)
206+
Total flow across segments summed over aquifers using np.sum(Qn, axis=0)
201207
"""
202208

203209
xy = np.array(xy) # convert to array

0 commit comments

Comments
 (0)