simple_linear_operators.py 6 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# Copyright(C) 2013-2018 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

from __future__ import absolute_import, division, print_function

from ..compat import *
from ..domain_tuple import DomainTuple
from ..domains.unstructured_domain import UnstructuredDomain
Martin Reinecke's avatar
Martin Reinecke committed
24
from ..field import Field
Philipp Arras's avatar
Philipp Arras committed
25
from ..multi_domain import MultiDomain
Martin Reinecke's avatar
Martin Reinecke committed
26
from ..multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
27 28
from .endomorphic_operator import EndomorphicOperator
from .linear_operator import LinearOperator
Martin Reinecke's avatar
Martin Reinecke committed
29 30 31 32 33


class VdotOperator(LinearOperator):
    def __init__(self, field):
        self._field = field
Martin Reinecke's avatar
Martin Reinecke committed
34
        self._domain = field.domain
Martin Reinecke's avatar
Martin Reinecke committed
35
        self._target = DomainTuple.scalar_domain()
Martin Reinecke's avatar
Martin Reinecke committed
36
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
37 38

    def apply(self, x, mode):
Martin Reinecke's avatar
Martin Reinecke committed
39
        self._check_mode(mode)
Martin Reinecke's avatar
Martin Reinecke committed
40
        if mode == self.TIMES:
Martin Reinecke's avatar
Martin Reinecke committed
41
            return Field.scalar(self._field.vdot(x))
Martin Reinecke's avatar
Martin Reinecke committed
42
        return self._field*x.local_data[()]
Martin Reinecke's avatar
Martin Reinecke committed
43 44


Martin Reinecke's avatar
Martin Reinecke committed
45 46
class ConjugationOperator(EndomorphicOperator):
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
47
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
48
        self._capability = self._all_ops
Martin Reinecke's avatar
Martin Reinecke committed
49 50 51 52 53 54 55 56

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.conjugate()


class Realizer(EndomorphicOperator):
    def __init__(self, domain):
Martin Reinecke's avatar
Martin Reinecke committed
57
        self._domain = DomainTuple.make(domain)
Martin Reinecke's avatar
Martin Reinecke committed
58
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
59 60 61 62

    def apply(self, x, mode):
        self._check_input(x, mode)
        return x.real
Martin Reinecke's avatar
Martin Reinecke committed
63 64


65
class FieldAdapter(LinearOperator):
Martin Reinecke's avatar
Martin Reinecke committed
66
    """Operator for conversion between Fields and MultiFields.
Philipp Arras's avatar
Philipp Arras committed
67 68 69

    Parameters
    ----------
Martin Reinecke's avatar
Martin Reinecke committed
70 71 72 73 74 75 76 77
    tgt : Domain, tuple of Domain, DomainTuple, dict or MultiDomain:
        If this is a Domain, tuple of Domain or DomainTuple, this will be the
        operator's target, and its domain will be a MultiDomain consisting of
        its domain with the supplied `name`
        If this is a dict or MultiDomain, everything except for `name` will
        be stripped out of it, and the result will be the operator's target.
        Its domain will then be the DomainTuple corresponding to the single
        entry in the operator's domain.
Philipp Arras's avatar
Philipp Arras committed
78 79

    name : String
Martin Reinecke's avatar
Martin Reinecke committed
80
        The relevant key of the MultiDomain.
Philipp Arras's avatar
Philipp Arras committed
81 82
    """

Martin Reinecke's avatar
Martin Reinecke committed
83 84 85 86 87 88 89 90 91
    def __init__(self, tgt, name):
        from ..sugar import makeDomain
        tmp = makeDomain(tgt)
        if isinstance(tmp, DomainTuple):
            self._target = tmp
            self._domain = MultiDomain.make({name: tmp})
        else:
            self._domain = tmp[name]
            self._target = MultiDomain.make({name: tmp[name]})
Martin Reinecke's avatar
Martin Reinecke committed
92
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
93 94 95

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
96
        if isinstance(x, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
97
            return x.values()[0]
Martin Reinecke's avatar
Martin Reinecke committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
        else:
            return MultiField(self._tgt(mode), (x,))

    def __repr__(self):
        key = self.domain.keys()[0]
        return 'FieldAdapter: {}'.format(key)


def ducktape(left, right, name):
    from ..sugar import makeDomain
    from .operator import Operator
    if left is None:  # need to infer left from right
        if isinstance(right, Operator):
            right = right.target
        elif right is not None:
            right = makeDomain(right)
        if isinstance(right, MultiDomain):
            left = right[name]
        else:
            left = MultiDomain.make({name: right})
    else:
        if isinstance(left, Operator):
            left = left.domain
        else:
            left = makeDomain(left)
123
    return FieldAdapter(left, name)
Martin Reinecke's avatar
Martin Reinecke committed
124 125 126 127 128 129 130 131 132 133


class GeometryRemover(LinearOperator):
    """Operator which transforms between a structured and an unstructured
    domain.

    Parameters
    ----------
    domain: Domain, tuple of Domain, or DomainTuple:
        the full input domain of the operator.
134 135 136
    space: int, optional
        The index of the subdomain on which the operator should act
        If None, it acts on all spaces
Martin Reinecke's avatar
Martin Reinecke committed
137 138 139 140 141 142 143 144

    Notes
    -----
    The operator will convert every sub-domain of its input domain to an
    UnstructuredDomain with the same shape. No weighting by volume factors
    is carried out.
    """

145
    def __init__(self, domain, space=None):
Martin Reinecke's avatar
Martin Reinecke committed
146
        self._domain = DomainTuple.make(domain)
147 148 149 150 151 152
        if space is not None:
            tgt = [dom for dom in self._domain]
            tgt[space] = UnstructuredDomain(self._domain[space].shape)
        else:
            tgt = [UnstructuredDomain(dom.shape) for dom in self._domain]
        self._target = DomainTuple.make(tgt)
Martin Reinecke's avatar
Martin Reinecke committed
153
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
154 155 156

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
157
        return x.cast_domain(self._tgt(mode))
Martin Reinecke's avatar
Martin Reinecke committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174


class NullOperator(LinearOperator):
    """Operator corresponding to a matrix of all zeros.

    Parameters
    ----------
    domain : DomainTuple or MultiDomain
        input domain
    target : DomainTuple or MultiDomain
        output domain
    """

    def __init__(self, domain, target):
        from ..sugar import makeDomain
        self._domain = makeDomain(domain)
        self._target = makeDomain(target)
Martin Reinecke's avatar
Martin Reinecke committed
175
        self._capability = self.TIMES | self.ADJOINT_TIMES
Martin Reinecke's avatar
Martin Reinecke committed
176 177 178 179

    @staticmethod
    def _nullfield(dom):
        if isinstance(dom, DomainTuple):
Martin Reinecke's avatar
Martin Reinecke committed
180
            return Field(dom, 0)
Martin Reinecke's avatar
Martin Reinecke committed
181 182 183 184 185
        else:
            return MultiField.full(dom, 0)

    def apply(self, x, mode):
        self._check_input(x, mode)
Martin Reinecke's avatar
Martin Reinecke committed
186
        return self._nullfield(self._tgt(mode))