:orphan:

.. _ref_example_gallery:

=========
Examples
=========
End-to-end examples show how you can use PyTwin. If the ``pytwin`` package is installed on your machine,
you can download these examples as Python files or Jupyter notebooks and run them locally.


.. raw:: html

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


.. raw:: html

    </div>

Twin evaluation examples
=========================
These examples show how to use the evaluation workflow in a TWIN file.
Included are multiple workflow demonstrations such as single evaluation of a dynamic model, parametric sweep analysis
(static/dynamic models), evaluation with states saving and loading.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Twin evaluation">

.. only:: html

  .. image:: /examples/01-twin_examples/images/thumb/sphx_glr_00-coupledClutches_thumb.png
    :alt:

  :ref:`sphx_glr_examples_01-twin_examples_00-coupledClutches.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Parametric dynamic twin evaluation">

.. only:: html

  .. image:: /examples/01-twin_examples/images/thumb/sphx_glr_01-electricRange_thumb.png
    :alt:

  :ref:`sphx_glr_examples_01-twin_examples_01-electricRange.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parametric dynamic twin evaluation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Parametric twin evaluation of a response surface ROM">

.. only:: html

  .. image:: /examples/01-twin_examples/images/thumb/sphx_glr_02-heatExchangerRS_thumb.png
    :alt:

  :ref:`sphx_glr_examples_01-twin_examples_02-heatExchangerRS.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parametric twin evaluation of a response surface ROM</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Twin evaluation of a scalar dynamic ROM">

.. only:: html

  .. image:: /examples/01-twin_examples/images/thumb/sphx_glr_03-scalarDROM_thumb.png
    :alt:

  :ref:`sphx_glr_examples_01-twin_examples_03-scalarDROM.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Twin evaluation of a scalar dynamic ROM</div>
    </div>


.. raw:: html

    </div>

TBROM evaluation examples
=========================
These examples show how to use PyTwin to evaluate field results from TBROM included in a TWIN file.
Multiple workflows are demonstrated such as image and field data generation (with possible processing of data to other
Ansys tools like Fluent or Mechanical), TBROM evaluation with input field parameterization, output field visualization
for detailed post processing (including projection on CFD/FEA meshes).



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how PyTwin can be used to load and evaluate a twin model to visualize ROM re...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_00-TBROM_images_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_00-TBROM_images.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D field ROM example for images generation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how PyTwin can be used to load and evaluate a twin model to predict CFD resu...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_01-TBROM_dataTransfer_pyMAPDL_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_01-TBROM_dataTransfer_pyMAPDL.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Twin evaluation of a 3D field ROM and data transfer to FEA model inputs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use PyTwin to load and evaluate a twin model that has a field ROM wit...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_02-TBROM_input_field_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_02-TBROM_input_field.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D field ROM example for input field snapshot projection and snapshot generation on demand</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how the example given in ref_example_TBROM_inputField can be modified to tak...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_03-TBROM_input_numpy_field_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_03-TBROM_input_numpy_field.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D field ROM example for field snapshot input and output as Numpy array</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how PyTwin can be used to load and evaluate a twin model, and visualize the ...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_04-TBROM_CFD_mesh_based_visualization_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_04-TBROM_CFD_mesh_based_visualization.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D field ROM example with CFD mesh based visualization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how PyTwin can be used to load and evaluate a twin model, and visualize the ...">

.. only:: html

  .. image:: /examples/02-tbrom_examples/images/thumb/sphx_glr_05-TBROM_FEA_mesh_based_visualization_thumb.png
    :alt:

  :ref:`sphx_glr_examples_02-tbrom_examples_05-TBROM_FEA_mesh_based_visualization.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">3D field ROM example with FEA mesh based visualization</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/01-twin_examples/index.rst
   /examples/02-tbrom_examples/index.rst



.. only:: html

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

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