postprocessing.paraview.geometry
================================

.. py:module:: postprocessing.paraview.geometry


Functions
---------

.. autoapisummary::

   postprocessing.paraview.geometry.extract_geometry_cmd
   postprocessing.paraview.geometry.extract_geometry_parser
   postprocessing.paraview.geometry.extract_geometry


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

.. py:function:: extract_geometry_cmd()

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
















   ..
       !! processed by numpydoc !!

.. py:function:: extract_geometry_parser()

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





   :Returns:

       parser
           Parser with specified arguments.











   ..
       !! processed by numpydoc !!

.. py:function:: extract_geometry(input_file=None, output_directory='./', patches='group/wall', overwrite='False')

   
   Function to extract a geometry from an OpenFOAM mesh and write it as an
   STL.


   :Parameters:

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

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

       **patches** : str or list
           Patch name(s) to include in the geometry. Default is "group/wall".

       **overwrite** : str
           Flag to overwrite existing temporary geometry and geometry files.
           Default is False.














   ..
       !! processed by numpydoc !!