selection_operator.py 1.94 KB
Newer Older
Philipp Arras's avatar
Philipp Arras committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 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.

Martin Reinecke's avatar
Martin Reinecke committed
19
from .linear_operator import LinearOperator
20
21
22


class SelectionOperator(LinearOperator):
23
24
25
26
27
28
29
30
31
32
    """Extracts from a MultiField a copy of the Field
    living on the subdomain selected by `key`.

    Parameters
    ----------
    domain : :class:`MultiDomain`
        Domain of the MultiFields to be acted on
    key : :class:`str`
        String identifier of the wanted subdomain
    """
33
    def __init__(self, domain, key):
Martin Reinecke's avatar
Martin Reinecke committed
34
        from ..multi.multi_domain import MultiDomain
35
36
37
38
39
40
41
42
43
44
45
        if not isinstance(domain, MultiDomain):
            raise TypeError("Domain must be a MultiDomain")
        self._domain = domain
        self._key = key

    @property
    def domain(self):
        return self._domain

    @property
    def target(self):
Martin Reinecke's avatar
Martin Reinecke committed
46
        return self._domain[self._key]
47
48
49
50
51
52

    @property
    def capability(self):
        return self.TIMES | self.ADJOINT_TIMES

    def apply(self, x, mode):
Philipp Arras's avatar
Philipp Arras committed
53
        # FIXME Is the copying necessary?
54
55
56
57
        self._check_input(x, mode)
        if mode == self.TIMES:
            return x[self._key].copy()
        else:
Martin Reinecke's avatar
Martin Reinecke committed
58
            from ..multi.multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
59
            return MultiField({self._key: x.copy()})