aerosandbox.dynamics.rigid_body.common_rigid_body
=================================================

.. py:module:: aerosandbox.dynamics.rigid_body.common_rigid_body


Classes
-------

.. autoapisummary::

   aerosandbox.dynamics.rigid_body.common_rigid_body._DynamicsRigidBodyBaseClass


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

.. py:class:: _DynamicsRigidBodyBaseClass(mass_props = None, **state_variables_and_indirect_control_variables)

   Bases: :py:obj:`aerosandbox.dynamics.point_mass.common_point_mass._DynamicsPointMassBaseClass`, :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: add_moment(Mx = 0, My = 0, Mz = 0, axes='body')
      :abstractmethod:


      Adds a moment (in whichever axis system you choose) to this Dynamics instance.

      :param Mx: Moment about the x-axis in the axis system chosen. Assumed these moments are applied about the center of mass. [Nm]
      :param My: Moment about the y-axis in the axis system chosen. Assumed these moments are applied about the center of mass. [Nm]
      :param Mz: Moment about the z-axis in the axis system chosen. Assumed these moments are applied about the center of mass. [Nm]
      :param axes: The axis system that the specified moment is in. One of:
                   * "geometry"
                   * "body"
                   * "wind"
                   * "stability"
                   * "earth"

      Returns: None (in-place)




   .. py:property:: op_point

      Returns an OperatingPoint object that represents the current state of the dynamics instance.

      This OperatingPoint object is effectively a subset of the state variables, and is used to compute aerodynamic
      forces and moments.


   .. py:property:: alpha

      The angle of attack, in degrees.


   .. py:property:: beta

      The sideslip angle, in degrees.


   .. py:property:: rotational_kinetic_energy

      Computes the kinetic energy [J] from rotational motion.

      KE = 0.5 * I * w^2

      :returns: Kinetic energy [J]


   .. py:property:: kinetic_energy

      Computes the kinetic energy [J] from translational and rotational motion.

      KE = 0.5 * m * v^2 + 0.5 * I * w^2

      :returns: Kinetic energy [J]