boinor.threebody.cr3bp_lib_calc
===============================

.. py:module:: boinor.threebody.cr3bp_lib_calc

.. autoapi-nested-parse::

   @author: Dhruv Jain, Multi-Body Dynaminitial_guesss Research Group, MSAAE Purdue University

   Objectve: Calculates the position [nd] of 5 libration points of a CR3BP system



Functions
---------

.. autoapisummary::

   boinor.threebody.cr3bp_lib_calc.lib_pt_loc
   boinor.threebody.cr3bp_lib_calc.newton_raphson_lib_calc


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

.. py:function:: lib_pt_loc(SysChars, conv_tol=1e-12)

   Computes libration points position [nd] for a CR3BP system

   :param SysChars: Object of Class SystemChars
   :type SysChars: object
   :param conv_tol: convergence tolerance for Newton-Raphson Method
   :type conv_tol: float

   :returns: **lib_loc** -- 5 Libration Points, [nd]
   :rtype: numpy ndarray (5x3)


.. py:function:: newton_raphson_lib_calc(initial_guess, func_coeffs, dfunc_coeffs, conv_tol)

   Uses Newton-Raphson Method to compute a zero of a function

   :param initial_guess: Approximate value of a zero of the function 'func'
   :type initial_guess: float
   :param func_coeffs: Coeffecients of a polynomial function whose zero is to be computed
                       [C_n, C_n-1, C_n-2, ...., C_0]
                       Setup: C_n * x^n + C_n-1 * x^(n-1) ..... C0 * x^0
   :type func_coeffs: numpy ndarray (6x1)
   :param dfunc_coeffs: Coeffecients of the derivative of function 'func' w.r.t 'x' whose zero is to be computed
                        [C_n, C_n-1, C_n-2, ...., C_0]
                        Setup: C_n * x^(n-1) + C_n-1 * x^(n-2) ..... C0 * x^0
   :type dfunc_coeffs: numpy ndarray (6x1)
   :param conv_tol: convergence tolerance for Newton-Raphson Method
   :type conv_tol: float

   :returns: **initial_guess** -- zero of function 'func_coeffs' within conv_tol
   :rtype: float