dof_space.py 1.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
# 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/>.
#
14
# Copyright(C) 2013-2019 Max-Planck-Society
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Philipp Arras's avatar
Philipp Arras committed
17

Martin Reinecke's avatar
Martin Reinecke committed
18
import numpy as np
Philipp Arras's avatar
Philipp Arras committed
19

Martin Reinecke's avatar
Martin Reinecke committed
20
from .structured_domain import StructuredDomain
Martin Reinecke's avatar
Martin Reinecke committed
21
22


Martin Reinecke's avatar
Martin Reinecke committed
23
class DOFSpace(StructuredDomain):
Martin Reinecke's avatar
PEP8  
Martin Reinecke committed
24
25
26
27
    """Generic degree-of-freedom space. It is defined as the domain of some
    DOFDistributor.
    Its entries represent the underlying degrees of freedom of some other
    space, according to the dofdex.
28
29
30
31

    Parameters
    ----------
    dof_weights: 1-D numpy array
Martin Reinecke's avatar
PEP8  
Martin Reinecke committed
32
33
        A numpy array containing the multiplicity of each individual degree of
        freedom.
34
    """
Martin Reinecke's avatar
Martin Reinecke committed
35
36
37

    _needed_for_hash = ["_dvol"]

Martin Reinecke's avatar
Martin Reinecke committed
38
39
40
41
42
43
44
45
46
47
48
49
    def __init__(self, dof_weights):
        self._dvol = tuple(dof_weights)

    @property
    def harmonic(self):
        return False

    @property
    def shape(self):
        return (len(self._dvol),)

    @property
Martin Reinecke's avatar
Martin Reinecke committed
50
    def size(self):
Martin Reinecke's avatar
Martin Reinecke committed
51
52
        return len(self._dvol)

Martin Reinecke's avatar
Martin Reinecke committed
53
    @property
Martin Reinecke's avatar
Martin Reinecke committed
54
55
56
    def scalar_dvol(self):
        return None

Martin Reinecke's avatar
Martin Reinecke committed
57
    @property
Martin Reinecke's avatar
Martin Reinecke committed
58
    def dvol(self):
Martin Reinecke's avatar
Martin Reinecke committed
59
        return np.array(self._dvol)
Martin Reinecke's avatar
Martin Reinecke committed
60
61
62

    def __repr__(self):
        return 'this is a dof space'