From c120504edd0e2740b54c0ae1a0ca82663a78b7aa Mon Sep 17 00:00:00 2001
From: Alex Fikl <alexfikl@gmail.com>
Date: Tue, 17 Apr 2018 21:26:18 -0500
Subject: [PATCH] qbx: add some docs
---
sumpy/qbx.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/sumpy/qbx.py b/sumpy/qbx.py
index 73f7ec3d..554771e7 100644
--- a/sumpy/qbx.py
+++ b/sumpy/qbx.py
@@ -386,6 +386,17 @@ class LayerPotentialMatrixBlockGenerator(LayerPotentialBase):
def __call__(self, queue, targets, sources, centers, expansion_radii,
index_set, **kwargs):
+ """
+ :arg targets: target point coordinates.
+ :arg sources: source point coordinates.
+ :arg centers: QBX target expansion centers.
+ :arg expansion_radii: radii for each expansion center.
+ :arg index_set: a :class:`sumpy.tools.MatrixBlockIndex` object used
+ to define the various blocks.
+ :return: a tuple of one-dimensional arrays of kernel evaluations at
+ target-source pairs described by `index_set`.
+ """
+
knl = self.get_cached_optimized_kernel()
tgtindices, srcindices = index_set.linear_indices()
--
GitLab