From 965e4787e7b7bd897d626162a54d94fdae8fd126 Mon Sep 17 00:00:00 2001 From: Mark Bakker Date: Tue, 5 Dec 2023 18:35:41 +0100 Subject: [PATCH] Updated documentation of intnormflux --- timml/model.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/timml/model.py b/timml/model.py index 3c8fa27f..2dc2952c 100644 --- a/timml/model.py +++ b/timml/model.py @@ -178,7 +178,8 @@ def intnormflux_segment(self, x1, y1, x2, y2, method="legendre", ndeg=10): return L * qn / 2.0 def intnormflux(self, xy, method="legendre", ndeg=10): - """Integrated normal (perpendicular) flux over polyline + """Integrated normal (perpendicular) flux over polyline giving + the flux per segment and per aquifer. Flux to the left is positive when going from (x1, y1) to (x2, y2). @@ -196,8 +197,13 @@ def intnormflux(self, xy, method="legendre", ndeg=10): Returns ------- - Qn : np.array of length naq + Qn : np.array of shape (naq, nsegments) integrated normal flux along specified polyline + + Example + ------- + Total flow across polyline can be obtained using np.sum(Qn) + Total flow across segments summed over aquifers using np.sum(Qn, axis=0) """ xy = np.array(xy) # convert to array