diff --git a/nifty5/domains/dof_space.py b/nifty5/domains/dof_space.py index 967aeb5d70e5a382e898b0ee131855cf64cc9247..e32c9abdd25d2c38fee2b0cb068ac944ba03f549 100644 --- a/nifty5/domains/dof_space.py +++ b/nifty5/domains/dof_space.py @@ -21,7 +21,15 @@ from .structured_domain import StructuredDomain class DOFSpace(StructuredDomain): - """Generic degree-of-freedom space.""" + """Generic degree-of-freedom space. It is defined as the domain of some DOFDistributor. + Its entries represent the underlying degrees of freedom of some other space, according + to the dofdex. + + Parameters + ---------- + dof_weights: 1-D numpy array + A numpy array containing the multiplicity of each individual degree of freedom. + """ _needed_for_hash = ["_dvol"] diff --git a/nifty5/operators/dof_distributor.py b/nifty5/operators/dof_distributor.py index addb5bbb5d46c7a07075b3a288f141f8f5c02a36..ff14160c7e7e852238c80479cf2a77b800b91645 100644 --- a/nifty5/operators/dof_distributor.py +++ b/nifty5/operators/dof_distributor.py @@ -26,8 +26,24 @@ from ..domains.dof_space import DOFSpace class DOFDistributor(LinearOperator): - """Operator transforming between a DOFSpace and any other domain by means - of distribution/projection.""" + """Operator which distributes actual degrees of freedom (dof) according to some + distribution scheme into a higher dimensional space. This distribution scheme is + defined by the dofdex, a degree of freedom index, which associates the entries within + the operators domain to locations in its target. This operators domain is a DOFSpace, + which is defined according to the distribution scheme. + + Parameters + ---------- + dofdex: Field of integers + An integer Field on exactly one Space establishing the association between the + locations in the operators target and the underlying degrees of freedom in its domain. + It has to start at 0 and it increases monotonicly, no empty bins are allowed. + target: Domain, tuple of Domain, or DomainTuple, optional + The target of the operator. If not specified, the domain of the dofdex is used. + space: int, optional: + The index of the sub-domain on which the operator acts. + Can be omitted if `target` only has one sub-domain. + """ def __init__(self, dofdex, target=None, space=None): super(DOFDistributor, self).__init__()