From 39fed6f8a2446fe5349af176a958bb710995f6d8 Mon Sep 17 00:00:00 2001
From: Stephan Seitz <stephan.seitz@fau.de>
Date: Wed, 15 Jan 2020 11:56:58 +0100
Subject: [PATCH] Add to docstring to fd.Diff.interpolated_access
---
pystencils/fd/derivative.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/pystencils/fd/derivative.py b/pystencils/fd/derivative.py
index e3fa11108..16776a130 100644
--- a/pystencils/fd/derivative.py
+++ b/pystencils/fd/derivative.py
@@ -112,6 +112,11 @@ class Diff(sp.Expr):
return "D(%s)" % self.arg
def interpolated_access(self, offset):
+ """Represents an interpolated access on a spatially differentiated field
+
+ Args:
+ offset (Tuple[sympy.Expr]): Absolute position to determine the value of the spatial derivative
+ """
from pystencils.interpolation_astnodes import DiffInterpolatorAccess
assert isinstance(self.argument, Field), "Must be field to enable interpolated accesses"
return DiffInterpolatorAccess(self.argument.interpolated_access(offset), self.target)
--
GitLab