: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.

.. toctree::
   :maxdepth: 1
   :hidden:

.. evaluate/README.txt


.. 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 these:

- Single evaluation of a dynamic model
- Parametric sweep analysis of a dynamic model
- Parametric response surface ROM evaluation
- Scalar dynamic ROM simulation with state saving and loading
- Field ROM evaluation and results visualization from the twin runtime and postprocessed in Ansys Fluent
- Field ROM evaluation and the transfer of results as inputs stress analysis in Ansys Mechanical
- Field ROM evaluation with inputs parameterized by both scalar and field data, and snapshot generation on demand



.. raw:: html

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


.. raw:: html

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

.. only:: html

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

  :ref:`sphx_glr_examples_evaluate_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/evaluate/images/thumb/sphx_glr_01-electricRange_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_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/evaluate/images/thumb/sphx_glr_02-heatExchangerRS_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_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/evaluate/images/thumb/sphx_glr_03-scalarDROM_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_03-scalarDROM.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Twin evaluation of a scalar dynamic ROM</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 visualize ROM re...">

.. only:: html

  .. image:: /examples/evaluate/images/thumb/sphx_glr_04-TBROM_images_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_04-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/evaluate/images/thumb/sphx_glr_05-TBROM_coSimulation_pyMAPDL_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_05-TBROM_coSimulation_pyMAPDL.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Twin evaluation of a 3D field ROM co-simulation with an FEA model</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/evaluate/images/thumb/sphx_glr_06-TBROM_input_field_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_06-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/evaluate/images/thumb/sphx_glr_07-TBROM_input_numpy_field_thumb.png
    :alt:

  :ref:`sphx_glr_examples_evaluate_07-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>


.. toctree::
   :hidden:
   :includehidden:


   /examples/evaluate/index.rst



.. only:: html

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

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