boinor.threebody.cr3bp_char_quant
=================================

.. py:module:: boinor.threebody.cr3bp_char_quant

.. autoapi-nested-parse::

   @author: Dhruv Jain, Multi-Body Dynamics Research Group, Purdue University.



Classes
-------

.. autoapisummary::

   boinor.threebody.cr3bp_char_quant.SystemChars


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

.. py:class:: SystemChars(name, mu, lstar, tstar)

   Computes and stores the properties (mu, l*, t*) of a CR3BP system
   'mu': mass ratio of P1-P2 primary bodies
   'l*': characterisitic lenght of P1-P2 system
   't*': characterisitic time of P1-P2 system
   If P2 is more massive than P1 then swap the Pi, so that P1 is the more massive body.


   .. py:method:: from_primaries(p1, p2)
      :classmethod:


      Computes and sets the characteristic quanitites based on p1 and p2 bodies.

      :param p1:
      :type p1: ~boinor.bodies.Body
      :param p2:
      :type p2: ~boinor.bodies.Body



   .. py:method:: bodies_char_compute(p1, p2)
      :classmethod:


      Calculates mu, lstar, and tstar of the 'p1' and 'p2' system.

      Also, if M2>M1, then swaps p1 and p2, so that M1>M2

      :param p1:
      :type p1: ~boinor.bodies.Body
      :param p2:
      :type p2: ~boinor.bodies.Body

      :returns: * **name** (*string*) -- System name, format: 'Body1Body2', e.g. 'EarthMoon', 'SunEarth'
                * **mu** (*float, dimensionless*) -- mass ratio of P1-P2 primary bodies
                * **lstar** (*float, km*) -- Characterisitc length of P1-P2 system
                * **tstar** (*float, sec*) -- Characterisitc time of P1-P2 system



   .. py:property:: name

      Name of P1-P2 system.


   .. py:property:: mu

      Mass ratio of P1-P2 primary bodies in CR3BP.


   .. py:property:: lstar

      Characterisitc length of P1-P2 system.


   .. py:property:: tstar

      Characterisitc time of P1-P2 system.