VTUinterface

VTUinterface is a python package for easy accessing VTU/PVD files as outputed by Finite Element software like OpenGeoSys. It uses the VTK python wrapper and linear interpolation between time steps and grid points to access any points in space and time within the simulation domain.

VTUinterface together with ogs6py can be viewed in action here:

0. Installation

Note: VTUinterface requires the vtk wrapper for python. Alternatively, a version based on MESHIO is also under development. clone the repository and use pip to install the package

# pip install [--user] https://github.com/joergbuchwald/VTUinterface/archive/refs/heads/master.zip

1. Documentation for VTUinterface

You can find the documentation under https://joergbuchwald.github.io/VTUinterface-doc/

2. Quick start

CAUTION: naming style of methods has changed (2021-05-20)

Basic Usage (python)

Although, a python package, VTUinterface is tested to work through PyCall under julia as well:

Basic Usage (julia)

Unittests can be run via

# python tests/test_vtuinterface.py

from the project root directory.

3. FAQ/Troubleshooting

Installation:

• If the vtk whell can't be found on PyPI you can checkout pyvista/pyvista#2064 for unofficial wheels.

As the input data is triangulated with QHull for the linear interpolation it might fail at boundaries or if a wrong input dimension is given. Possible solutions:

• In order for interpolation to work correctly providing the correct dimension (set via dim keyword) of the problem is crucial.
• As the dim keyword specifies also the coordinates to use, VTUinterface assumes that dim=1 refers to the x coordinate and dim=2 implies that the problem lies in the xy-plane by default. This can be changed by specifying one_d_axis for one dimension or two_d_planenormal for two dimensions.
• For some meshes it might help to adjust the number of points taken into account by the triangulation, which can be done using the nneighbors keyword. Default value is 20.
• Especially along boundaries, linear interpolation with the QHULL method often fails, this can be resolved by using nearest neighbor interpolation.
• Alternatively, you can change now the interpolation_backend from scipy to vtk and try out different interpolation kernels.