:py:mod:`vlm_class`
===================

.. py:module:: vlm_class


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

Classes
~~~~~~~

.. autoapisummary::

   vlm_class.VortexLatticeMethod




Attributes
~~~~~~~~~~

.. autoapisummary::

   vlm_class.default_input_dict


.. py:class:: VortexLatticeMethod(solver_input_dict)

   Bases: :py:obj:`object`

   .. py:method:: __assemble_input_dict__()


   .. py:method:: declare_outputs(outputs)

      
      Declare outputs to be saved
















      ..
          !! processed by numpydoc !!

   .. py:method:: evaluate()


   .. py:method:: plot_unsteady(meshes, wake_mesh, surface_data, wake_data, wake_form='grid', bounds=None, cmap='jet', interactive=False, camera=False, screenshot=False, name='sample_vlm_ani')


   .. py:method:: setup_flow_properties()

      
      Input velocity options
      - mach + sos to get V_inf
      - V_inf as a:
          - scalar
          - vector
          - grid

      Ways to input velocity:
      - Mach*sos and alpha as a scalar
      - Mach*sos and alpha across num_nodes
      - V_inf and alpha as a scalar
      - V_inf and alpha across num_nodes
      - nodal velocity across num_nodes, grid points and 3

      Steps to propagate velocities:
      - take one of the inputs from above list
      - convert to 3-components (x,y,z) 
          - this is a vector representing the flow field
      - loop over mesh list and make velocity across the nodes
          - V_vec --> nodal velocities (nn, nc, ns, 3) using einsum















      ..
          !! processed by numpydoc !!


.. py:data:: default_input_dict