postprocessing.paraview.distributions
=====================================

.. py:module:: postprocessing.paraview.distributions


Functions
---------

.. autoapisummary::

   postprocessing.paraview.distributions.force_distribution_cmd
   postprocessing.paraview.distributions.force_distribution_parser
   postprocessing.paraview.distributions.force_distribution
   postprocessing.paraview.distributions.geometry_distribution_cmd
   postprocessing.paraview.distributions.geometry_distribution_parser
   postprocessing.paraview.distributions.geometry_distribution
   postprocessing.paraview.distributions.compute_section_properties


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

.. py:function:: force_distribution_cmd()

   
   Wrapper around the force_distribution() function to call it from
   the command line with arguments.
















   ..
       !! processed by numpydoc !!

.. py:function:: force_distribution_parser()

   
   Parser for options for the force_distribution() function to call
   it from the command line with arguments.





   :Returns:

       parser
           Parser with specified arguments.











   ..
       !! processed by numpydoc !!

.. py:function:: force_distribution(input_file=None, output_directory='./', name='force_distribution', patches='group/wall', span_direction='Z+', force_direction='Y+', x_start=[0, 0, 0], x_end=[0, 0, 1], n_span=100)

   
   Function to compute a force distribution using Paraview.


   :Parameters:

       **input_file** : str
           Path to file to load with Paraview.

       **output_directory** : str
           Path to directory where the distribution files will be written. Default
           is "./".

       **name** : str
           Name pattern to write out files in the output directory. Default is
           "force_distribution".

       **patches** : str or list
           Patch name(s) over which to compute the force distribution. Default
           is "group/wall".

       **span_direction** : str or list
           Vector direction for span direction either as a string (eg. X) or list
           (eg. [0 0 1]). Should be of magnitude 1. Default is "Z+".

       **force_direction** : str or list
           Vector direction for force direction either as a string (eg. X) or list
           (eg. [0 1 0]). Should be of magnitude 1. Default is "Y+".

       **x_start** : list
           Coordinates to start slices from. Default is [0, 0, 0].

       **x_end** : list
           Coordinates to end slices at. Default is [0, 0, 1].

       **n_span** : int
           Number of spanwise samples. Default is 100.














   ..
       !! processed by numpydoc !!

.. py:function:: geometry_distribution_cmd()

   
   Wrapper around the geometry_distribution() function to call it from the
   command line with arguments.
















   ..
       !! processed by numpydoc !!

.. py:function:: geometry_distribution_parser()

   
   Parser for options for the geometry_distribution() function to call it from the
   command line with arguments.





   :Returns:

       parser
           Parser with specified arguments.











   ..
       !! processed by numpydoc !!

.. py:function:: geometry_distribution(input_file=None, output_directory='./', name='geometry_distribution', patches='group/wall', span_direction='Z+', lift_direction='Y+', drag_direction='X+', x_start=[0, 0, 0], x_end=[0, 0, 1], n_span=100)

   
   Function to compute a force distribution using Paraview.


   :Parameters:

       **input_file** : str
           Path to file to load with Paraview.

       **output_directory** : str
           Path to directory where the distribution files will be written. Default
           is "./".

       **name** : str
           Name pattern to write out files in the output directory. Default is
           "geometry_distribution".

       **patches** : str or list
           Patch name(s) over which to compute the force distribution. Default
           is "group/wall".

       **span_direction** : str or list
           Vector direction for span direction either as a string (eg. X+) or list
           (eg. [0 0 1]). Should be of magnitude 1. Default is "Z+".

       **lift_direction** : str or list
           Vector direction for lift direction either as a string (eg. X+) or list
           (eg. [0 1 0]). Should be of magnitude 1. Default is "Y+".

       **drag_direction** : str or list
           Vector direction for drag direction either as a string (eg. X+) or list
           (eg. [1 0 0]). Should be of magnitude 1. Default is "X+".

       **x_start** : list
           Coordinates to start slices from. Default is [0, 0, 0].

       **x_end** : list
           Coordinates to end slices at. Default is [0, 0, 1].

       **n_span** : int
           Number of spanwise samples. Default is 100.














   ..
       !! processed by numpydoc !!

.. py:function:: compute_section_properties(coords2D)

   
   Compute the chord and twist of an airfoil section given a set of ordered
   points.


   :Parameters:

       **coords2D** : ndarray
           Sorted 2D airfoil coordinates rotated to an X-Y plane, with the flow
           direction as +X and lift direction as +Y.



   :Returns:

       float
           Section chord length, in current working units.

       float
           Section twist, in degrees.

       float
           Section maximum thickness, in current working units.











   ..
       !! processed by numpydoc !!