:py:mod:`pm_class`
==================

.. py:module:: pm_class


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

Classes
~~~~~~~

.. autoapisummary::

   pm_class.PanelMethod




Attributes
~~~~~~~~~~

.. autoapisummary::

   pm_class.current_directory
   pm_class.default_input_dict
   pm_class.default_mesh_path
   pm_class.output_options_dict


.. py:class:: PanelMethod(solver_input_dict, threshold_angle=125.0, skip_geometry=False)

   Bases: :py:obj:`object`

   .. py:method:: __assemble_input_dict__()


   .. py:method:: compute_TE_properties(threshold_angle=125, plot=False)

      
      Computing trailing edge properties to set the Kutta condition
















      ..
          !! processed by numpydoc !!

   .. py:method:: compute_cell_adjacency(radius=1e-10)

      
      Computing cell adjacency informatiom.
















      ..
          !! processed by numpydoc !!

   .. py:method:: declare_outputs(outputs)

      
      Declare outputs to be saved
















      ..
          !! processed by numpydoc !!

   .. py:method:: evaluate()

      
      Function call to set up and run the panel method.

      The output is a dictionary containing the string names set
      in self.declare_outputs()















      ..
          !! processed by numpydoc !!

   .. py:method:: generate_wake_connectivity()


   .. py:method:: import_mesh()

      
      Importing the mesh using meshio.
















      ..
          !! processed by numpydoc !!

   .. py:method:: insert_TE_properties(TE_properties)


   .. py:method:: insert_cell_adjacency(cell_adjacency_data)


   .. py:method:: insert_grid_data(mesh, cell_adjacency_data, TE_properties)


   .. py:method:: insert_mesh(mesh)


   .. py:method:: overwrite_mesh(mesh)


   .. py:method:: plot(data_to_plot, bounds=None, cmap='jet', camera=False, screenshot=False)

      
      Plotting function for scalar field variables.
















      ..
          !! processed by numpydoc !!

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


   .. py:method:: print_output_options(output_names=False)

      
      Prints the output options with a description + shape
      If no input is provided, the entire dictionary is printed.

      Inputs:
      - output_names: list

      Returns the output options dictionary 















      ..
          !! processed by numpydoc !!

   .. py:method:: setup_flow_properties()

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
















      ..
          !! processed by numpydoc !!

   .. py:method:: setup_grid_properties(threshold_angle=125, plot=False)

      
      Sets up the mesh, cell adjacency, and trailing edge properties.

      The trailing edge can be tweaked using the threshold angle input.















      ..
          !! processed by numpydoc !!


.. py:data:: current_directory

   

.. py:data:: default_input_dict

   

.. py:data:: default_mesh_path

   

.. py:data:: output_options_dict