:orphan:

Examples
========

.. toctree::
   :maxdepth: 1

   ../examples/howto_mesh_terrain/index

.. contents:: Contents
   :local:
   :depth: 2



.. raw:: html

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


.. raw:: html

    </div>

How to use feflowlib
====================

.. sectionauthor:: Julian Heinze (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following shows a brief example of how the feflowlib can be used.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we show how a simple FEFLOW model consisting of two layers can be converted to ...">

.. only:: html

  .. image:: /auto_examples/howto_feflowlib/images/thumb/sphx_glr_plot_2layers_model_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_feflowlib_plot_2layers_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">How to work with FEFLOW data in pyvista.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we show how a simple FEFLOW model can be converted to a pyvista.UnstructuredGri...">

.. only:: html

  .. image:: /auto_examples/howto_feflowlib/images/thumb/sphx_glr_plot_simulation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_feflowlib_plot_simulation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">How to convert a FEFLOW model and simulate it in OGS.</div>
    </div>


.. raw:: html

    </div>

How to use logparser
=============================

.. sectionauthor:: Tobias Meisel (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebooks provide some examples of how to use the logparser.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This simple example demonstrates how to analyze the OGS (OpenGeoSys) log output to extract perf...">

.. only:: html

  .. image:: /auto_examples/howto_logparser/images/thumb/sphx_glr_plot_logparser_intro_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_logparser_plot_logparser_intro.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this section, we showcase various predefined analyses available in the log parser. We utiliz...">

.. only:: html

  .. image:: /auto_examples/howto_logparser/images/thumb/sphx_glr_plot_logparser_analyses_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_logparser_plot_logparser_analyses.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We address to following:">

.. only:: html

  .. image:: /auto_examples/howto_logparser/images/thumb/sphx_glr_plot_logparser_advanced_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_logparser_plot_logparser_advanced.py`

.. raw:: html

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


.. raw:: html

    </div>

How to use meshlib
==================

.. sectionauthor:: Tobias Meisel (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebooks provide some examples of how to use meshlib.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Read mesh from file (vtu or xdmf) into pyvista mesh">

.. only:: html

  .. image:: /auto_examples/howto_meshlib/images/thumb/sphx_glr_plot_meshseries_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshlib_plot_meshseries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Read mesh from file (vtu or xdmf) into pyvista mesh</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For this example we create meshes from pyvista surfaces.">

.. only:: html

  .. image:: /auto_examples/howto_meshlib/images/thumb/sphx_glr_plot_meshlib_pyvista_input_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshlib_plot_meshlib_pyvista_input.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating meshes from pyvista surfaces</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to create a Borehole Heat Exchanger (BHE) mesh.">

.. only:: html

  .. image:: /auto_examples/howto_meshlib/images/thumb/sphx_glr_plot_bhe_mesh_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshlib_plot_bhe_mesh.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating a BHE mesh (Borehole Heat Exchanger)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example explains how to use functions from meshlib to calculate differences between meshes...">

.. only:: html

  .. image:: /auto_examples/howto_meshlib/images/thumb/sphx_glr_plot_calculate_diff_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshlib_plot_calculate_diff.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Differences between meshes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For this example we create meshes from surface layers.">

.. only:: html

  .. image:: /auto_examples/howto_meshlib/images/thumb/sphx_glr_plot_meshlib_vtu_input_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshlib_plot_meshlib_vtu_input.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating meshes from vtu surface files</div>
    </div>


.. raw:: html

    </div>

How to use meshplotlib
======================

.. sectionauthor:: Florian Zill (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebooks provide some examples of how to use meshplotlib.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we show how to aggregate data in a model over all timesteps as well as plot dif...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_special_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_special.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Analyzing Meshseries Data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For this example we load a 2D meshseries from within the meshplotlib examples. In the meshplotl...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_meshplotlib_2d_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_meshplotlib_2d.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Visualizing 2D model data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For visualizing 3D data it might make sense to plot multiple views / slices. To create them we ...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_meshplotlib_3d_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_meshplotlib_3d.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Visualizing 3D model data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To demonstrate the creation of an animated plot we use a component transport example from the o...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_animation_thumb.gif
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_animation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">How to create Animations</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For this example we load a 2D meshseries from within the meshplotlib examples. This tutorial co...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_with_custom_fig_ax_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_with_custom_fig_ax.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting different process variables on already existing Matplotlib figures / axes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="By default plots with meshplotlib try to retain the true mesh proportions. If the meshes aspect...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_aspect_ratios_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_aspect_ratios.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="For this example we load a 2D meshseries from within the meshplotlib examples. This tutorial co...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_xy_labels_with_shared_axes_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_xy_labels_with_shared_axes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Labeling directional shared axes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we plot the data values on observation points over all timesteps. Since request...">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_observation_points_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_observation_points.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">How to plot data at observation points</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example from the ogs benchmark collection is used for the stress analysis:">

.. only:: html

  .. image:: /auto_examples/howto_meshplotlib/images/thumb/sphx_glr_plot_solid_mechanics_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_meshplotlib_plot_solid_mechanics.py`

.. raw:: html

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


.. raw:: html

    </div>

Using proxy models for nuclear waste heat production
====================================================

.. sectionauthor:: Florian Zill (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebook shows some example usage of the ```nuclearwasteheat``` submodule.
In the context of OGS, this submodule is meant to provide an easy way to calculate
the heat generated by nuclear waste repositories, to apply it in a simulation as
the source term for the temperature process variable.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="First, some minimal example usage:">

.. only:: html

  .. image:: /auto_examples/howto_nuclearwasteheat/images/thumb/sphx_glr_plot_nuclearwasteheat_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_nuclearwasteheat_plot_nuclearwasteheat.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting nuclear waste heat over time</div>
    </div>


.. raw:: html

    </div>

Features of propertylib
=======================

.. sectionauthor:: Florian Zill (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebook shows some example usage of the propertylib submodule.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=":pyogstools.propertylib provides classes (Scalar, Vector, Matrix) which encapsulate unit handli...">

.. only:: html

  .. image:: /auto_examples/howto_propertylib/images/thumb/sphx_glr_plot_propertylib_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_propertylib_plot_propertylib.py`

.. raw:: html

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


.. raw:: html

    </div>

Features of studies
=======================

.. sectionauthor:: Florian Zill, Tobias Meisel (Helmholtz Centre for Environmental Research GmbH - UFZ)

The following jupyter notebook shows some example usage of the studies submodule.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows one possible implementation of how to do a convergence study. It uses the pr...">

.. only:: html

  .. image:: /auto_examples/howto_studies/images/thumb/sphx_glr_plot_convergence_study_steady_state_diffusion_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_studies_plot_convergence_study_steady_state_diffusion.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convergence study (spatial refinement)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows one possible implementation of how to do a convergence study with spatial an...">

.. only:: html

  .. image:: /auto_examples/howto_studies/images/thumb/sphx_glr_plot_convergence_study_nuclear_decay_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_howto_studies_plot_convergence_study_nuclear_decay.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convergence study (spatial & temporal refinement)</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/howto_feflowlib/index.rst
   /auto_examples/howto_logparser/index.rst
   /auto_examples/howto_meshlib/index.rst
   /auto_examples/howto_meshplotlib/index.rst
   /auto_examples/howto_nuclearwasteheat/index.rst
   /auto_examples/howto_propertylib/index.rst
   /auto_examples/howto_studies/index.rst