multi_field.py 5.75 KB
Newer Older
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
20
21
22
23
24
25
26
27
28
29
30
31
from ..field import Field
import numpy as np
from .multi_domain import MultiDomain


class MultiField(object):
    def __init__(self, val):
        """
        Parameters
        ----------
        val : dict
        """
        self._val = val
32
33
        self._domain = MultiDomain.make(
            {key: val.domain for key, val in self._val.items()})
Martin Reinecke's avatar
Martin Reinecke committed
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

    def __getitem__(self, key):
        return self._val[key]

    def keys(self):
        return self._val.keys()

    def items(self):
        return self._val.items()

    def values(self):
        return self._val.values()

    @property
    def domain(self):
49
        return self._domain
Martin Reinecke's avatar
Martin Reinecke committed
50

Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
51
52
53
54
    @property
    def dtype(self):
        return {key: val.dtype for key, val in self._val.items()}

55
56
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
57
        dtype = MultiField.build_dtype(dtype, domain)
58
59
        return MultiField({key: Field.from_random(random_type, domain[key],
                                                  dtype[key], **kwargs)
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
60
                           for key in domain.keys()})
61

62
63
64
65
66
67
68
69
70
71
72
73
    def fill(self, fill_value):
        """Fill `self` uniformly with `fill_value`

        Parameters
        ----------
        fill_value: float or complex or int
            The value to fill the field with.
        """
        for val in self._val.values():
            val.fill(fill_value)
        return self

Martin Reinecke's avatar
Martin Reinecke committed
74
    def _check_domain(self, other):
75
        if other._domain != self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
            raise ValueError("domains are incompatible.")

    def vdot(self, x):
        result = 0.
        self._check_domain(x)
        for key, sub_field in self.items():
            result += sub_field.vdot(x[key])
        return result

    def lock(self):
        for v in self.values():
            v.lock()
        return self

Martin Reinecke's avatar
Martin Reinecke committed
90
91
92
93
    @property
    def locked(self):
        return all(v.locked for v in self.values())

Martin Reinecke's avatar
Martin Reinecke committed
94
95
    def copy(self):
        return MultiField({key: val.copy() for key, val in self.items()})
96

Martin Reinecke's avatar
Martin Reinecke committed
97
98
99
100
101
102
    def locked_copy(self):
        if self.locked:
            return self
        return MultiField({key: val.locked_copy()
                          for key, val in self.items()})

103
104
    def empty_copy(self):
        return MultiField({key: val.empty_copy() for key, val in self.items()})
Martin Reinecke's avatar
Martin Reinecke committed
105

Martin Reinecke's avatar
Martin Reinecke committed
106
107
108
109
110
111
112
113
    @staticmethod
    def build_dtype(dtype, domain):
        if isinstance(dtype, dict):
            return dtype
        if dtype is None:
            dtype = np.float64
        return {key: dtype for key in domain.keys()}

Martin Reinecke's avatar
Martin Reinecke committed
114
    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
115
    def empty(domain, dtype=None):
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
116
        dtype = MultiField.build_dtype(dtype, domain)
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
117
        return MultiField({key: Field.empty(dom, dtype=dtype[key])
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
118
                           for key, dom in domain.items()})
Martin Reinecke's avatar
Martin Reinecke committed
119
120

    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
121
122
    def full(domain, val):
        return MultiField({key: Field.full(dom, val)
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
123
                           for key, dom in domain.items()})
Martin Reinecke's avatar
Martin Reinecke committed
124

Martin Reinecke's avatar
fixes    
Martin Reinecke committed
125
126
127
128
129
130
131
132
133
    def to_global_data(self):
        return {key: val.to_global_data() for key, val in self._val.items()}

    @staticmethod
    def from_global_data(domain, arr, sum_up=False):
        return MultiField({key: Field.from_global_data(domain[key],
                                                       val, sum_up)
                           for key, val in arr.items()})

Martin Reinecke's avatar
Martin Reinecke committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
    def norm(self):
        """ Computes the L2-norm of the field values.

        Returns
        -------
        norm : float
            The L2-norm of the field values.
        """
        return np.sqrt(np.abs(self.vdot(x=self)))

    def __neg__(self):
        return MultiField({key: -val for key, val in self.items()})

    def conjugate(self):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
148
149
        return MultiField({key: sub_field.conjugate()
                           for key, sub_field in self.items()})
Martin Reinecke's avatar
Martin Reinecke committed
150

151
152
153
154
155
156
157
158
159
160
161
    def equivalent(self, other):
        if self is other:
            return True
        if not isinstance(other, MultiField):
            return False
        if self._domain != other._domain:
            return False
        for key, val in self._val.items():
            if not val.equivalent(other[key]):
                return False
        return True
Martin Reinecke's avatar
Martin Reinecke committed
162

163

Martin Reinecke's avatar
Martin Reinecke committed
164
165
166
167
168
169
170
171
172
173
for op in ["__add__", "__radd__", "__iadd__",
           "__sub__", "__rsub__", "__isub__",
           "__mul__", "__rmul__", "__imul__",
           "__div__", "__rdiv__", "__idiv__",
           "__truediv__", "__rtruediv__", "__itruediv__",
           "__floordiv__", "__rfloordiv__", "__ifloordiv__",
           "__pow__", "__rpow__", "__ipow__",
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
174
175
176
177
178
179
180
181
            if isinstance(other, MultiField):
                self._check_domain(other)
                result_val = {key: getattr(sub_field, op)(other[key])
                              for key, sub_field in self.items()}
            else:
                result_val = {key: getattr(val, op)(other)
                              for key, val in self.items()}
            return MultiField(result_val)
Martin Reinecke's avatar
Martin Reinecke committed
182
183
        return func2
    setattr(MultiField, op, func(op))