-
Notifications
You must be signed in to change notification settings - Fork 98
/
planarForce.py
199 lines (166 loc) · 5.69 KB
/
planarForce.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
###############################################################################
# plabarForce.py: top-level class for a 2D force, conservative
# (planarPotential) or not (planarDissipativeForce)
#
###############################################################################
import copy
import numpy
from ..util import config, conversion
from ..util._optional_deps import _APY_LOADED
from ..util.conversion import (
physical_compatible,
physical_conversion,
potential_physical_input,
)
from .Force import Force
if _APY_LOADED:
from astropy import units
class planarForce:
"""Top-level class for any 2D force, conservative or dissipative"""
def __init__(self, amp=1.0, ro=None, vo=None):
"""
Initialize 2D Force.
Parameters
----------
amp : float
Amplitude to be applied when evaluating the potential and its forces.
ro : float or Quantity, optional
Physical distance scale (in kpc or as Quantity). Default is from the configuration file.
vo : float or Quantity, optional
Physical velocity scale (in km/s or as Quantity). Default is from the configuration file.
Notes
-----
- 2023-05-29 - Written to generalize planarPotential to force that may or may not be conservative - Bovy (UofT)
"""
self._amp = amp
self.dim = 2
self.isNonAxi = True
self.isRZ = False
self.hasC = False
self.hasC_dxdv = False
self.hasC_dens = False
# Parse ro and vo
if ro is None:
self._ro = config.__config__.getfloat("normalization", "ro")
self._roSet = False
else:
self._ro = conversion.parse_length_kpc(ro)
self._roSet = True
if vo is None:
self._vo = config.__config__.getfloat("normalization", "vo")
self._voSet = False
else:
self._vo = conversion.parse_velocity_kms(vo)
self._voSet = True
return None
def __mul__(self, b):
"""
Multiply a planarPotential's amplitude by a number.
Parameters
----------
b : number
The number to multiply the amplitude by.
Returns
-------
planarPotential instance
A new instance with amplitude = (old amplitude) x b.
Notes
-----
- 2019-01-27: Written - Bovy (UofT)
"""
if not isinstance(b, (int, float)):
raise TypeError(
"Can only multiply a planarPotential instance with a number"
)
out = copy.deepcopy(self)
out._amp *= b
return out
# Similar functions
__rmul__ = __mul__
def __div__(self, b):
return self.__mul__(1.0 / b)
__truediv__ = __div__
def __add__(self, b):
"""
Add planarPotential instances together to create a multi-component potential (e.g., pot= pot1+pot2+pot3)
Parameters
----------
b : planarPotential instance or a list thereof
Returns
-------
list of planarPotential instances
Represents the combined potential
Notes
-----
- 2019-01-27 - Written - Bovy (UofT)
"""
from ..potential import flatten as flatten_pot
if not isinstance(flatten_pot([b])[0], (Force, planarForce)):
raise TypeError(
"""Can only combine galpy Potential"""
"""/planarPotential objects with """
"""other such objects or lists thereof"""
)
assert physical_compatible(self, b), (
"""Physical unit conversion parameters (ro,vo) are not """
"""compatible between potentials to be combined"""
)
if isinstance(b, list):
return [self] + b
else:
return [self, b]
# Define separately to keep order
def __radd__(self, b):
from ..potential import flatten as flatten_pot
if not isinstance(flatten_pot([b])[0], (Force, planarForce)):
raise TypeError(
"""Can only combine galpy Force objects with """
"""other Force objects or lists thereof"""
)
assert physical_compatible(self, b), (
"""Physical unit conversion parameters (ro,vo) are not """
"""compatible between potentials to be combined"""
)
# If we get here, b has to be a list
return b + [self]
def turn_physical_off(self):
"""
Turn off automatic returning of outputs in physical units.
Returns
-------
None
Notes
-----
- 2016-01-30 - Written - Bovy (UofT)
"""
self._roSet = False
self._voSet = False
return None
def turn_physical_on(self, ro=None, vo=None):
"""
Turn on automatic returning of outputs in physical units.
Parameters
----------
ro : float or Quantity, optional
Reference distance in kpc. Default is None.
vo : float or Quantity, optional
Reference velocity in km/s. Default is None.
Returns
-------
None
Notes
-----
- 2016-01-30 - Written - Bovy (UofT)
- 2020-04-22 - Don't turn on a parameter when it is False - Bovy (UofT)
"""
if not ro is False:
self._roSet = True
ro = conversion.parse_length_kpc(ro)
if not ro is None:
self._ro = ro
if not vo is False:
self._voSet = True
vo = conversion.parse_velocity_kms(vo)
if not vo is None:
self._vo = vo
return None