aerosandbox.geometry.propulsor
==============================

.. py:module:: aerosandbox.geometry.propulsor


Attributes
----------

.. autoapisummary::

   aerosandbox.geometry.propulsor.p_disk


Classes
-------

.. autoapisummary::

   aerosandbox.geometry.propulsor.Propulsor


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

.. py:class:: Propulsor(name = 'Untitled', xyz_c = None, xyz_normal = None, radius = 1.0, length = 0.0, color = None, analysis_specific_options = None)

   Bases: :py:obj:`aerosandbox.AeroSandboxObject`


   Definition for a Propulsor, which could be a propeller, a rotor, or a jet engine.

   Assumes a disk- or cylinder-shaped propulsor.


   .. py:attribute:: name
      :value: 'Untitled'



   .. py:attribute:: xyz_c


   .. py:attribute:: xyz_normal


   .. py:attribute:: radius
      :value: 1.0



   .. py:attribute:: length
      :value: 0.0



   .. py:attribute:: color
      :value: None



   .. py:attribute:: analysis_specific_options
      :value: None



   .. py:method:: __repr__()


   .. py:method:: xsec_area()

      Returns the cross-sectional area of the propulsor, in m^2.



   .. py:method:: xsec_perimeter()

      Returns the cross-sectional perimeter of the propulsor, in m.



   .. py:method:: volume()

      Returns the volume of the propulsor, in m^3.



   .. py:method:: compute_frame()

      Computes the local coordinate frame of the propulsor, in aircraft geometry axes.

      xg_local is aligned with the propulsor's normal vector.

      zg_local is roughly aligned with the z-axis of the aircraft geometry axes, but projected onto the propulsor's plane.

      yg_local is the cross product of zg_local and xg_local.

      Returns: A tuple:
          xg_local: The x-axis of the local coordinate frame, in aircraft geometry axes.
          yg_local: The y-axis of the local coordinate frame, in aircraft geometry axes.
          zg_local: The z-axis of the local coordinate frame, in aircraft geometry axes.




   .. py:method:: get_disk_3D_coordinates(theta = None, l_over_length = None)


   .. py:method:: translate(xyz)

      Returns a copy of this propulsor that has been translated by `xyz`.

      :param xyz: The amount to translate the propulsor, in meters. Given in aircraft geometry axes, as with everything else.

      Returns: A copy of this propulsor, translated by `xyz`.



.. py:data:: p_disk