Commit c6c62ad6 authored by Reimar H Leike's avatar Reimar H Leike
Browse files

more documentation

parent af1d849c
......@@ -27,6 +27,8 @@ class DomainTuple(object):
This class holds a tuple of :class:`Domain` objects, which together form
the space on which a :class:`Field` is defined.
This corresponds to a tensor product of the corresponding vector
fields.
Notes
-----
......
......@@ -27,6 +27,21 @@ class MultiDomain(object):
_domainCache = {}
def __init__(self, dict, _callingfrommake=False):
"""A tuple of domains corresponding to a direct sum.
This class is the domain of the direct sum of fields living
over (possibly different) domains. To make an instance
of this class call .make(inp)
Parameters
----------
inp : MultiDomain or tuple(DomainTuple)
The already built MultiDomain or a tuple of DomainTuples
Returns
------
A MutliDomain with the input Domains as domains
"""
if not _callingfrommake:
raise NotImplementedError(
'To create a MultiDomain call `MultiDomain.make()`.')
......
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