aerosandbox.dynamics.point_mass.point_2D
========================================

.. py:module:: aerosandbox.dynamics.point_mass.point_2D


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/aerosandbox/dynamics/point_mass/point_2D/cartesian/index
   /autoapi/aerosandbox/dynamics/point_mass/point_2D/speed_gamma/index


Classes
-------

.. autoapisummary::

   aerosandbox.dynamics.point_mass.point_2D.DynamicsPointMass2DCartesian
   aerosandbox.dynamics.point_mass.point_2D.DynamicsPointMass2DSpeedGamma


Package Contents
----------------

.. py:class:: DynamicsPointMass2DCartesian(mass_props = None, x_e = 0, z_e = 0, u_e = 0, w_e = 0, alpha = 0)

   Bases: :py:obj:`aerosandbox.dynamics.point_mass.point_3D.cartesian.DynamicsPointMass3DCartesian`


   Dynamics instance:
   * simulating a point mass
   * in 2D
   * with velocity parameterized in Cartesian coordinates

   State variables:
       x_e: x-position, in Earth axes. [meters]
       z_e: z-position, in Earth axes. [meters]
       u_e: x-velocity, in Earth axes. [m/s]
       w_e: z-velocity, in Earth axes. [m/s]

   Indirect control variables:
       alpha: Angle of attack. [degrees]

   Control variables:
       Fx_e: Force along the Earth-x axis. [N]
       Fz_e: Force along the Earth-z axis. [N]



   .. py:attribute:: mass_props

      For each state variable, self.state_var = state_var

      For each indirect control variable, self.indirect_control_var = indirect_control_var

      For each control variable, self.control_var = 0


   .. py:attribute:: x_e
      :value: 0



   .. py:attribute:: y_e
      :value: 0



   .. py:attribute:: z_e
      :value: 0



   .. py:attribute:: u_e
      :value: 0



   .. py:attribute:: v_e
      :value: 0



   .. py:attribute:: w_e
      :value: 0



   .. py:attribute:: alpha
      :value: 0



   .. py:attribute:: beta
      :value: 0



   .. py:attribute:: bank
      :value: 0



   .. py:attribute:: Fx_e
      :value: 0



   .. py:attribute:: Fy_e
      :value: 0



   .. py:attribute:: Fz_e
      :value: 0



   .. py:property:: state
      :type: Dict[str, Union[float, aerosandbox.numpy.ndarray]]


      Returns the state variables of this Dynamics instance as a Dict.

      Keys are strings that give the name of the variables.
      Values are the variables themselves.

      This method should look something like:
          >>> {
          >>>     "x_e": self.x_e,
          >>>     "u_e": self.u_e,
          >>>     ...
          >>> }


   .. py:property:: control_variables
      :type: Dict[str, Union[float, aerosandbox.numpy.ndarray]]



   .. py:method:: state_derivatives()

      A function that returns the derivatives with respect to time of the state specified in the `state` property.

      Should return a Dict with the same keys as the `state` property.



.. py:class:: DynamicsPointMass2DSpeedGamma(mass_props = None, x_e = 0, z_e = 0, speed = 0, gamma = 0, alpha = 0)

   Bases: :py:obj:`aerosandbox.dynamics.point_mass.point_3D.speed_gamma_track.DynamicsPointMass3DSpeedGammaTrack`


   Dynamics instance:
   * simulating a point mass
   * in 2D
   * with velocity parameterized in speed-gamma space.

   State variables:
       x_e: x-position, in Earth axes. [meters]
       z_e: z-position, in Earth axes. [meters]
       speed: Speed; equivalent to u_w, the x-velocity in wind axes. [m/s]
       gamma: Flight path angle. [rad]

   Indirect control variables:
       alpha: Angle of attack. [degrees]

   Control variables:
       Fx_w: Force along the wind-x axis. [N]
       Fz_w: Force along the wind-z axis. [N]



   .. py:attribute:: mass_props

      For each state variable, self.state_var = state_var

      For each indirect control variable, self.indirect_control_var = indirect_control_var

      For each control variable, self.control_var = 0


   .. py:attribute:: x_e
      :value: 0



   .. py:attribute:: y_e
      :value: 0



   .. py:attribute:: z_e
      :value: 0



   .. py:attribute:: speed
      :value: 0



   .. py:attribute:: gamma
      :value: 0



   .. py:attribute:: track
      :value: 0



   .. py:attribute:: bank
      :value: 0



   .. py:attribute:: alpha
      :value: 0



   .. py:attribute:: beta
      :value: 0



   .. py:attribute:: Fx_w
      :value: 0



   .. py:attribute:: Fy_w
      :value: 0



   .. py:attribute:: Fz_w
      :value: 0



   .. py:property:: state
      :type: Dict[str, Union[float, aerosandbox.numpy.ndarray]]


      Returns the state variables of this Dynamics instance as a Dict.

      Keys are strings that give the name of the variables.
      Values are the variables themselves.

      This method should look something like:
          >>> {
          >>>     "x_e": self.x_e,
          >>>     "u_e": self.u_e,
          >>>     ...
          >>> }


   .. py:property:: control_variables
      :type: Dict[str, Union[float, aerosandbox.numpy.ndarray]]



   .. py:method:: state_derivatives()

      A function that returns the derivatives with respect to time of the state specified in the `state` property.

      Should return a Dict with the same keys as the `state` property.