Commit 765a6cc6 authored by Philipp Arras's avatar Philipp Arras
Browse files

Docstring

parent 90cd3bf1
Pipeline #74994 passed with stages
in 25 minutes and 15 seconds
......@@ -27,7 +27,7 @@ class ContractionOperator(LinearOperator):
"""A :class:`LinearOperator` which sums up fields into the direction of
subspaces.
This Operator sums up a field with is defined on a :class:`DomainTuple`
This Operator sums up a field which is defined on a :class:`DomainTuple`
to a :class:`DomainTuple` which is a subset of the former.
Parameters
......@@ -72,6 +72,19 @@ class ContractionOperator(LinearOperator):
def IntegrationOperator(domain, spaces):
"""A :class:`LinearOperator` which integrates fields into the direction
of subspaces.
This Operator integrates a field which is defined on a :class:`DomainTuple`
to a :class:`DomainTuple` which is a subset of the former.
Parameters
----------
domain : Domain, tuple of Domain or DomainTuple
spaces : None, int or tuple of int
The elements of "domain" which are contracted.
If `None`, everything is contracted
"""
domain = DomainTuple.make(domain)
swgt = domain.scalar_weight(spaces)
return ContractionOperator(domain, spaces, swgt)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment