Solid-body rotation wrapper potential¶
- class galpy.potential.SolidBodyRotationWrapperPotential(*args, **kwargs)[source]¶
Potential wrapper class that implements solid-body rotation around the z-axis. Can be used to make a bar or other perturbation rotate. The potential is rotated by replacing
\[\phi \rightarrow \phi + \Omega \times t + \mathrm{pa}\]with \(\Omega\) the fixed pattern speed and \(\mathrm{pa}\) the position angle at \(t=0\).
- __init__(amp=1.0, pot=None, omega=1.0, pa=0.0, ro=None, vo=None)[source]¶
Initialize a SolidBodyRotationWrapper Potential.
- Parameters:
amp (float, optional) – Amplitude to be applied to the potential. Default is 1.0.
pot (Potential instance or list thereof) – This potential is made to rotate around the z axis by the wrapper.
omega (float or Quantity, optional) – The pattern speed. Default is 1.0.
pa (float or Quantity, optional) – The position angle. Default is 0.0.
ro (float or Quantity, optional) – Distance scale for translation into internal units (default from configuration file).
vo (float or Quantity, optional) – Velocity scale for translation into internal units (default from configuration file).
Notes
2017-08-22 - Started - Bovy (UofT)