postprocessing.paraview.slices
==============================

.. py:module:: postprocessing.paraview.slices


Functions
---------

.. autoapisummary::

   postprocessing.paraview.slices.slices_cp_cmd
   postprocessing.paraview.slices.slices_cp_parser
   postprocessing.paraview.slices.slices_cp


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

.. py:function:: slices_cp_cmd()

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
















   ..
       !! processed by numpydoc !!

.. py:function:: slices_cp_parser()

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





   :Returns:

       parser
           Parser with specified arguments.











   ..
       !! processed by numpydoc !!

.. py:function:: slices_cp(input_file=None, output_directory='./', name='slice', patches='group/wall', span_direction='Z+', lift_direction='Y+', drag_direction='X+', x=None, rho0=None, u0=None, p0=None)

   
   Function to compute slices using Paraview.


   :Parameters:

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

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

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

       **patches** : str or list
           Patch name(s) over which to compute the slice(s). 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** : list
           Coordinates to sample.

       **rho0** : float
           Freestream density.

       **u0** : float
           Freestream velocity magnitude.

       **p0** : float
           Freestream pressure.














   ..
       !! processed by numpydoc !!