py4py.physics
=============

.. py:module:: py4py.physics

.. autoapi-nested-parse::

   Physics functions

   Things like calculating Keplerian velocity, doppler shifts and the like.



.. autoapisummary::

   py4py.physics.keplerian_velocity
   py4py.physics.doppler_shift_wave
   py4py.physics.doppler_shift_vel


Module Contents
---------------

.. py:function:: keplerian_velocity(mass: float, radius: float) -> float

   Calculates Keplerian velocity at given radius

   :param mass: Object mass in kg
   :type mass: float
   :param radius: Orbital radius in m
   :type radius: float

   :returns: Orbital velocity in m/s
   :rtype: float


.. py:function:: doppler_shift_wave(line: float, vel: float) -> float

   Converts passed line and velocity into red/blue-shifted wavelength

   :param line: Line wavelength (any length unit)
   :type line: float
   :param vel: Doppler shift velocity (m/s)
   :type vel: float

   :returns: Doppler shifted line wavelength (as above)
   :rtype: float


.. py:function:: doppler_shift_vel(line: float, wave: float) -> float

   Converts passed red/blue-shifted wave into velocity

   :param line: Base line wavelength (any length unit)
   :type line: float
   :param wave: Doppler shifted line wavelength (as above)
   :type wave: float

   :returns: Speed of Doppler shift
   :rtype: float