From ba4f2609372962159a0e6e76905beeeb5743d99d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20He=C3=9F?= <rene.hess@iwr.uni-heidelberg.de>
Date: Wed, 19 Sep 2018 15:23:39 +0200
Subject: [PATCH] Add documentation
---
python/dune/perftool/sumfact/geometry.py | 3 ---
python/dune/perftool/sumfact/symbolic.py | 7 ++++---
python/dune/perftool/sumfact/tabulation.py | 11 +++++++++++
3 files changed, 15 insertions(+), 6 deletions(-)
diff --git a/python/dune/perftool/sumfact/geometry.py b/python/dune/perftool/sumfact/geometry.py
index 25225ba2..8455f78b 100644
--- a/python/dune/perftool/sumfact/geometry.py
+++ b/python/dune/perftool/sumfact/geometry.py
@@ -35,9 +35,6 @@ from dune.perftool.sumfact.realization import (name_buffer_storage,
)
from dune.perftool.sumfact.switch import get_facedir, get_facemod
from dune.perftool.sumfact.symbolic import SumfactKernelInterfaceBase, SumfactKernel
-from dune.perftool.sumfact.tabulation import (quadrature_points_per_direction,
- BasisTabulationMatrix,
- )
from dune.perftool.sumfact.vectorization import attach_vectorization_info
from dune.perftool.tools import get_pymbolic_basename
from dune.perftool.options import get_form_option, option_switch
diff --git a/python/dune/perftool/sumfact/symbolic.py b/python/dune/perftool/sumfact/symbolic.py
index 424b8714..bed72373 100644
--- a/python/dune/perftool/sumfact/symbolic.py
+++ b/python/dune/perftool/sumfact/symbolic.py
@@ -271,9 +271,10 @@ class SumfactKernel(SumfactKernelBase, ImmutableRecord, prim.Variable):
Arguments:
----------
- matrix_sequence: A tuple of BasisTabulationMatrixBase instances
- The list of tensors to be applied to the input.
- Order of application is from 0 up.
+ matrix_sequence: A tuple of BasisTabulationMatrixBase instances The
+ list of tensors to be applied to the input ordered from direction 0
+ to d-1. This might not be the order in which the tensors will be
+ applied.
buffer: A string identifying the flip flop buffer in use
for intermediate results. The memory is expected to be
pre-initialized with the input or you have to provide
diff --git a/python/dune/perftool/sumfact/tabulation.py b/python/dune/perftool/sumfact/tabulation.py
index de13c45c..e913ed62 100644
--- a/python/dune/perftool/sumfact/tabulation.py
+++ b/python/dune/perftool/sumfact/tabulation.py
@@ -51,6 +51,17 @@ class BasisTabulationMatrix(BasisTabulationMatrixBase, ImmutableRecord):
slice_size=None,
slice_index=None,
):
+ """
+ Arguments:
+ ----------
+ basis_size: Number of 1D basis functions in this direction
+ transpose: Do we need the transposed of this matrix
+ derivative: Do we use derivaties of the basis functions for this direction
+ face: On a face with the normal direction equal to direction this is facemod (else it is None)
+ direction: Direction corresponding to this matrix
+ slice_size: Number of slices for this direction
+ slice_index: To which slice does this belong
+ """
assert(isinstance(basis_size, int))
ImmutableRecord.__init__(self,
basis_size=basis_size,
--
GitLab