aerosandbox.aerodynamics.aero_3D.singularities.point_source
===========================================================

.. py:module:: aerosandbox.aerodynamics.aero_3D.singularities.point_source


Attributes
----------

.. autoapisummary::

   aerosandbox.aerodynamics.aero_3D.singularities.point_source.args


Functions
---------

.. autoapisummary::

   aerosandbox.aerodynamics.aero_3D.singularities.point_source.calculate_induced_velocity_point_source


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

.. py:function:: calculate_induced_velocity_point_source(x_field, y_field, z_field, x_source, y_source, z_source, sigma = 1, viscous_radius=0)

   Calculates the induced velocity at a point:
       [x_field, y_field, z_field]
   in a 3D potential-flow flowfield.

   In this flowfield, the following singularity elements are assumed:
       * A single point source

   This function consists entirely of scalar, elementwise NumPy ufunc operations - so it can be vectorized as
   desired assuming input dimensions/broadcasting are compatible.

   :param x_field: x-coordinate of the field point
   :param y_field: y-coordinate of the field point
   :param z_field: z-coordinate of the field point
   :param x_left: x-coordinate of the left vertex of the bound vortex
   :param y_left: y-coordinate of the left vertex of the bound vortex
   :param z_left: z-coordinate of the left vertex of the bound vortex
   :param x_right: x-coordinate of the right vertex of the bound vortex
   :param y_right: y-coordinate of the right vertex of the bound vortex
   :param z_right: z-coordinate of the right vertex of the bound vortex
   :param gamma: The strength of the horseshoe vortex filament.
   :param trailing_vortex_direction: The direction that the trailing legs of the horseshoe vortex extend. Usually,
   :param this is modeled as the direction of the freestream.:
   :param viscous_radius: To prevent a vortex singularity, here we use a Kaufmann vortex model. This parameter
   :param governs the radius of this vortex model. It should be significantly smaller (e.g.:
   :param at least an order of:
   :param magnitude smaller) than the smallest bound leg in the analysis in question.:

   Returns: u, v, and w:
       The x-, y-, and z-direction induced velocities.


.. py:data:: args