baseunit.py 6.69 KB
Newer Older
1
2
3
4
5
6
#!/bin/env python


"""
Module simtk.unit.baseunit

7
8
9
10
11
12
13
14
15
16
17
Contains BaseUnit class, which is a component of the Unit class.

This is part of the OpenMM molecular simulation toolkit originating from
Simbios, the NIH National Center for Physics-Based Simulation of
Biological Structures at Stanford, funded under the NIH Roadmap for
Medical Research, grant U54 GM072970. See https://simtk.org.

Portions copyright (c) 2012 Stanford University and the Authors.
Authors: Christopher M. Bruns
Contributors: Peter Eastman

Justin MacCallum's avatar
Justin MacCallum committed
18
Permission is hereby granted, free of charge, to any person obtaining a
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
35
36
37
38
39
40
41
42
"""

__author__ = "Christopher M. Bruns"
__version__ = "0.6"

class BaseUnit(object):
    '''
    Physical unit expressed in exactly one BaseDimension.
Justin MacCallum's avatar
Justin MacCallum committed
43

44
45
46
47
48
49
    For example, meter_base_unit could be a BaseUnit for the length dimension.
    The BaseUnit class is used internally in the more general Unit class.
    '''

    def __init__(self, base_dim, name, symbol):
        """Creates a new BaseUnit.
Justin MacCallum's avatar
Justin MacCallum committed
50

51
52
53
54
        Parameters
         - self: The newly created BaseUnit.
         - base_dim: (BaseDimension) The dimension of the new unit, e.g. 'mass'
         - name: (string) Name of the unit, e.g. "kilogram"
55
         - symbol: (string) Symbol for the unit, e.g. 'kg'.  This symbol will appear in
56
57
58
59
60
61
62
63
64
            Quantity string descriptions.
        """
        self.dimension = base_dim
        self.name = name
        self.symbol = symbol
        self._conversion_factor_to = {}
        self._conversion_factor_to[self] = 1.0
        self._conversion_factor_to_by_name = {}
        self._conversion_factor_to_by_name[self.name] = 1.0
Justin MacCallum's avatar
Justin MacCallum committed
65

Peter Eastman's avatar
Peter Eastman committed
66
    def __lt__(self, other):
67
68
69
70
        """
        Comparison function that sorts BaseUnits by BaseDimension
        """
        # First sort on dimension
Peter Eastman's avatar
Peter Eastman committed
71
72
        if self.dimension != other.dimension:
            return self.dimension < other.dimension
73
        # Second on conversion factor
Peter Eastman's avatar
Peter Eastman committed
74
        return self.conversion_factor_to(other) < 1.0
75
76
77
78
79
80

    def iter_base_dimensions(self):
        """
        Returns a dictionary of BaseDimension:exponent pairs, describing the dimension of this unit.
        """
        yield (self.dimension, 1)
Justin MacCallum's avatar
Justin MacCallum committed
81

82
83
    def iter_base_units(self):
        yield (self, 1)
Justin MacCallum's avatar
Justin MacCallum committed
84

85
86
87
88
89
90
91
    def get_dimension_tuple(self):
        """
        Returns a sorted tuple of (BaseDimension, exponent) pairs, that can be used as a dictionary key.
        """
        l = list(self.iter_base_dimensions())
        l.sort()
        return tuple(l)
Justin MacCallum's avatar
Justin MacCallum committed
92

93
94
95
96
97
98
99
    def __str__(self):
        """Returns a string with the name of this BaseUnit
        """
        return self.name

    def __repr__(self):
        return 'BaseUnit(base_dim=%s, name="%s", symbol="%s")' % (self.dimension, self.name, self.symbol)
Justin MacCallum's avatar
Justin MacCallum committed
100

101
102
103
    def define_conversion_factor_to(self, other, factor):
        """
        Defines a conversion factor between two BaseUnits.
Justin MacCallum's avatar
Justin MacCallum committed
104

105
        self * factor = other
Justin MacCallum's avatar
Justin MacCallum committed
106

107
108
109
110
        Parameters:
         - self: (BaseUnit) 'From' unit in conversion.
         - other: (BaseUnit) 'To' unit in conversion.
         - factor: (float) Conversion factor.
Justin MacCallum's avatar
Justin MacCallum committed
111

112
113
114
        After calling this method, both self and other will have stored
        conversion factors for one another, plus all other BaseUnits which
        self and other have previously defined.
Justin MacCallum's avatar
Justin MacCallum committed
115

116
117
        Both self and other must have the same dimension, otherwise a TypeError
        will be raised.
Justin MacCallum's avatar
Justin MacCallum committed
118

119
120
121
122
123
        Returns None.
        """
        if self.dimension != other.dimension:
            raise TypeError('Cannot define conversion for BaseUnits with different dimensions.')
        assert(factor != 0)
Justin MacCallum's avatar
Justin MacCallum committed
124
        assert(not self is other)
125
126
127
128
129
130
        # import all transitive conversions
        self._conversion_factor_to[other] = factor
        self._conversion_factor_to_by_name[other.name] = factor
        for (unit, cfac) in other._conversion_factor_to.items():
            if unit is self: continue
            if self._conversion_factor_to.has_key(unit): continue
Justin MacCallum's avatar
Justin MacCallum committed
131
            self._conversion_factor_to[unit] = factor * cfac
132
            unit._conversion_factor_to[self] = pow(factor * cfac, -1)
Justin MacCallum's avatar
Justin MacCallum committed
133
            self._conversion_factor_to_by_name[unit.name] = factor * cfac
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
            unit._conversion_factor_to_by_name[self.name] = pow(factor * cfac, -1)
        # and for the other guy
        invFac = pow(factor, -1.0)
        other._conversion_factor_to[self] = invFac
        other._conversion_factor_to_by_name[self.name] = invFac
        for (unit, cfac) in self._conversion_factor_to.items():
            if unit is other: continue
            if other._conversion_factor_to.has_key(unit): continue
            other._conversion_factor_to[unit] = invFac * cfac
            unit._conversion_factor_to[other] = pow(invFac * cfac, -1)
            other._conversion_factor_to_by_name[unit.name] = invFac * cfac
            unit._conversion_factor_to_by_name[other.name] = pow(invFac * cfac, -1)

    def conversion_factor_to(self, other):
        """Returns a conversion factor from this BaseUnit to another BaseUnit.
Justin MacCallum's avatar
Justin MacCallum committed
149

150
151
        It does not matter which existing BaseUnit you define the conversion factor to.
        Conversions for all other known BaseUnits will be computed at the same time.
Justin MacCallum's avatar
Justin MacCallum committed
152

153
154
        Raises TypeError if dimension does not match.
        Raises LookupError if no conversion has been defined. (see define_conversion_factor_to).
Justin MacCallum's avatar
Justin MacCallum committed
155

156
157
158
159
160
161
162
163
164
165
166
167
168
        """
        if self is other: return 1.0
        if self.dimension != other.dimension:
            raise TypeError('Cannot get conversion for BaseUnits with different dimensions.')
        if not other.name in self._conversion_factor_to_by_name:
            raise LookupError('No conversion defined from BaseUnit "%s" to "%s".' % (self, other))
        return self._conversion_factor_to_by_name[other.name]

# run module directly for testing
if __name__=='__main__':
    # Test the examples in the docstrings
    import doctest, sys
    doctest.testmod(sys.modules[__name__])