:orphan:


.. _gallery:

========
Examples
========

These examples show how the PyEnSight interfaces work and
demonstrate postprocessing workflows leveraging these interfaces.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>


Basic examples
==============

These basic examples use the PyEnSight API to produce simple scenes.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This most basic EnSight processing example loads some data from an EnSight installation and generates a simplistic scene.">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_00-basic_example_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_00-basic_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Basic usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="EnSight is a simulation results postprocessing engine with an advanced rendering and display component. PyEnSight provides direct, Jupyter Notebook/Juptyer lab-aware access to the rendering component through renderables. This example explores the variety of renderables that available.">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_01-renderables_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_01-renderables.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Renderables</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight Calculator to compute the Spatial Mean of a field variable. Display this constant value, and the create graph over time.">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_02-calc_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_02-calc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Calculator usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight Particle Trace (aka Streamline/Pathline) to visualize a vector through the domain. Create Streamline, animate, allow for dynamic change.">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_03-ptrace_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_03-ptrace.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Particle Trace (Streamline/Pathline) usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight Particle Trace for Pathline (transient streamline). Create a Pathline and Animate it.">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_04-ptrace_pathline_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_04-ptrace_pathline.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pathline (transient streamline) Creation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight to investigate two types of surface streamlines:">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_05-surface_traces_lic_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_05-surface_traces_lic.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Surface Restricted Traces and Line Integral Convolution</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight Net Force Tool in order to Calculate the Net Aerodynamic Forces">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_06-aero_forces_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_06-aero_forces.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Calculate the Net Aerodynamic Forces</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Utilize EnSight to demonstrate the value of Volume Rendering as a tool to visualize flow in 3D">

.. only:: html

  .. image:: /_examples/00-basic/images/thumb/sphx_glr_07-volume_render_thumb.png
    :alt:

  :ref:`sphx_glr__examples_00-basic_07-volume_render.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Volume Rendering to Visualize Flow</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


Intermediate examples
=====================

These intermediate examples use the PyEnSight API for more
complex workflows that employ calculator functions, queries, viewports,
and annotations.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A common operation is to load two different datasets, usually design points, into the same EnSight session using separate cases. This example loads two Fluent design points and displays them in different viewports. It then computes the difference between the temperature fields and displays the result in a third viewport.">

.. only:: html

  .. image:: /_examples/25-intermediate/images/thumb/sphx_glr_00-designpoints_thumb.png
    :alt:

  :ref:`sphx_glr__examples_25-intermediate_00-designpoints.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Design point comparison</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A query is basically a collection of x,y values. In addition to the raw values, each point is potentially a location in 3D space and a notion of &quot;gaps&quot; between values. In most cases, a query is drawn as a line on an EnSight plotter object. It can also be drawn as points and, using the &quot;gaps&quot;, as a collection of independent line groups.">

.. only:: html

  .. image:: /_examples/25-intermediate/images/thumb/sphx_glr_01-queries_thumb.png
    :alt:

  :ref:`sphx_glr__examples_25-intermediate_01-queries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Queries</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="EnSight Utilities">

.. only:: html

  .. image:: /_examples/25-intermediate/images/thumb/sphx_glr_02-utils_thumb.png
    :alt:

  :ref:`sphx_glr__examples_25-intermediate_02-utils.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">EnSight Utilities</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


Advanced examples
=================

These advanced examples use more sophisticated features of the
PyEnSight API, including events, parallelism, direct data access, and techniques
that improve performance.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Every attribute change may have an event callback associated with it. This example explores different connection mechanisms and different mechanisms for getting data values.">

.. only:: html

  .. image:: /_examples/50-advanced/images/thumb/sphx_glr_00-events_thumb.png
    :alt:

  :ref:`sphx_glr__examples_50-advanced_00-events.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Asynchronous event support</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The PyEnsight interface relies very heavily on the performance of communication between the PyEnSight interpreter and the EnSight instance.  This communication, while fast, is not nearly as fast as running Python directly within the EnSight instance.  In this example, some (unexpected) performance bottlenecks will be discussed along with methods that can be used to assert finer-grained control over Python code execution.">

.. only:: html

  .. image:: /_examples/50-advanced/images/thumb/sphx_glr_01-remote_exec_thumb.png
    :alt:

  :ref:`sphx_glr__examples_50-advanced_01-remote_exec.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Remote Function Execution</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /_examples/00-basic/index.rst
   /_examples/25-intermediate/index.rst
   /_examples/50-advanced/index.rst



.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_