multi_field.py 8.21 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
57
58
59
60
61
62
63
64
    @property
    def real(self):
        """MultiField : The real part of the multi field"""
        return MultiField({key: field.real for key, field in self.items()})

    @property
    def imag(self):
        """MultiField : The imaginary part of the multi field"""
        return MultiField({key: field.imag for key, field in self.items()})

65
66
    @staticmethod
    def from_random(random_type, domain, dtype=np.float64, **kwargs):
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
67
        dtype = MultiField.build_dtype(dtype, domain)
68
69
        return MultiField({key: Field.from_random(random_type, domain[key],
                                                  dtype[key], **kwargs)
Martin Reinecke's avatar
fixes    
Martin Reinecke committed
70
                           for key in domain.keys()})
71

72
73
74
75
76
77
78
79
80
81
82
83
    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
84
    def _check_domain(self, other):
85
        if other._domain != self._domain:
Martin Reinecke's avatar
Martin Reinecke committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
            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
100
101
102
103
    @property
    def locked(self):
        return all(v.locked for v in self.values())

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

Martin Reinecke's avatar
Martin Reinecke committed
107
108
109
110
111
112
    def locked_copy(self):
        if self.locked:
            return self
        return MultiField({key: val.locked_copy()
                          for key, val in self.items()})

113
114
    def empty_copy(self):
        return MultiField({key: val.empty_copy() for key, val in self.items()})
Martin Reinecke's avatar
Martin Reinecke committed
115

Martin Reinecke's avatar
Martin Reinecke committed
116
117
118
119
120
121
122
123
    @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
124
    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
125
    def empty(domain, dtype=None):
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
126
        dtype = MultiField.build_dtype(dtype, domain)
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
127
        return MultiField({key: Field.empty(dom, dtype=dtype[key])
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
128
                           for key, dom in domain.items()})
Martin Reinecke's avatar
Martin Reinecke committed
129
130

    @staticmethod
Martin Reinecke's avatar
step 1    
Martin Reinecke committed
131
132
    def full(domain, val):
        return MultiField({key: Field.full(dom, val)
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
133
                           for key, dom in domain.items()})
Martin Reinecke's avatar
Martin Reinecke committed
134

Martin Reinecke's avatar
fixes    
Martin Reinecke committed
135
136
137
138
139
140
141
142
143
    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
144
145
146
147
148
149
150
151
152
153
    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)))

154
155
156
157
158
159
160
161
162
163
    def squared_norm(self):
        """ Computes the square of the L2-norm of the field values.

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

Martin Reinecke's avatar
Martin Reinecke committed
164
165
166
167
    def __neg__(self):
        return MultiField({key: -val for key, val in self.items()})

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

171
172
173
    def isEquivalentTo(self, other):
        """Determines (as quickly as possible) whether `self`'s content is
        identical to `other`'s content."""
174
175
176
177
178
179
180
        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():
181
            if not val.isEquivalentTo(other[key]):
182
183
                return False
        return True
Martin Reinecke's avatar
Martin Reinecke committed
184

185
186
187
188
189
190
191
    def isSubsetOf(self, other):
        """Determines (as quickly as possible) whether `self`'s content is
        a subset of `other`'s content."""
        if self is other:
            return True
        if not isinstance(other, MultiField):
            return False
Martin Reinecke's avatar
Martin Reinecke committed
192
193
194
        if len(set(self._domain.keys()) - set(other._domain.keys())) > 0:
            return False
        for key in self._domain.keys():
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
195
            if other._domain[key] is not self._domain[key]:
196
                return False
Martin Reinecke's avatar
Martin Reinecke committed
197
            if not other[key].isSubsetOf(self[key]):
198
199
                return False
        return True
200

201

Martin Reinecke's avatar
Martin Reinecke committed
202
203
204
205
206
207
208
for op in ["__add__", "__radd__",
           "__sub__", "__rsub__",
           "__mul__", "__rmul__",
           "__div__", "__rdiv__",
           "__truediv__", "__rtruediv__",
           "__floordiv__", "__rfloordiv__",
           "__pow__", "__rpow__",
Martin Reinecke's avatar
Martin Reinecke committed
209
210
211
           "__lt__", "__le__", "__gt__", "__ge__", "__eq__", "__ne__"]:
    def func(op):
        def func2(self, other):
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
212
            if isinstance(other, MultiField):
Martin Reinecke's avatar
Martin Reinecke committed
213
214
215
216
217
218
                if self._domain == other._domain:
                    result_val = {key: getattr(sub_field, op)(other[key])
                                  for key, sub_field in self.items()}
                else:
                    if not self._domain.compatibleTo(other.domain):
                        raise ValueError("domain mismatch")
Martin Reinecke's avatar
Martin Reinecke committed
219
220
221
222
223
                    s1 = set(self._domain.keys())
                    s2 = set(other._domain.keys())
                    common_keys = s1 & s2
                    only_self_keys = s1 - s2
                    only_other_keys = s2 - s1
Martin Reinecke's avatar
Martin Reinecke committed
224
                    result_val = {}
Martin Reinecke's avatar
Martin Reinecke committed
225
226
227
228
229
230
231
232
233
                    for key in common_keys:
                        result_val[key] = getattr(self[key], op)(other[key])
                    if op in ("__add__", "__radd__"):
                        for key in only_self_keys:
                            result_val[key] = self[key].copy()
                        for key in only_other_keys:
                            result_val[key] = other[key].copy()
                    elif op in ("__mul__", "__rmul__"):
                        pass
Philipp Arras's avatar
Philipp Arras committed
234
                    else:
Martin Reinecke's avatar
Martin Reinecke committed
235
                        for key in only_self_keys:
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
236
237
                            result_val[key] = getattr(
                                self[key], op)(self[key]*0.)
Martin Reinecke's avatar
Martin Reinecke committed
238
                        for key in only_other_keys:
Martin Reinecke's avatar
tweaks    
Martin Reinecke committed
239
240
                            result_val[key] = getattr(
                                other[key]*0., op)(other[key])
Martin Reinecke's avatar
cleanup    
Martin Reinecke committed
241
242
243
244
            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
245
246
        return func2
    setattr(MultiField, op, func(op))