Add documentation

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

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

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,