Enhancement: Field data export

.travis.yml

@@ -1,12 +1,15 @@
 language: python
-dist: xenial
+dist: bionic
 
 python:
-  - "2.7"
-  - "3.4"
+  # EOL 2020-09-13
   - "3.5"
+  # EOL 2021-12-23
   - "3.6"
+  # EOL 2023-06-27
   - "3.7"
+  # EOL 2024-10
+  - "3.8"
 
 install:
     - pip install -r requirements.txt

evtk/__init__.py

@@ -1,4 +1,8 @@
 from pyevtk import *
 
 import warnings
-warnings.warn('the "evtk" package is deprecated, use "pyevtk" instead', DeprecationWarning)
+
+warnings.warn(
+    'the "evtk" package is deprecated, use "pyevtk" instead',
+    DeprecationWarning,
+)

examples/group.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -33,8 +33,8 @@
 from pyevtk.vtk import VtkGroup
 
 g = VtkGroup("./group")
-g.addFile(filepath = "sim0000.vtu", sim_time = 0.0)
-g.addFile(filepath = "sim0001.vtu", sim_time = 1.0)
-g.addFile(filepath = "sim0002.vtu", sim_time = 2.0)
-g.addFile(filepath = "sim0003.vtu", sim_time = 3.0)
+g.addFile(filepath="sim0000.vtu", sim_time=0.0)
+g.addFile(filepath="sim0001.vtu", sim_time=1.0)
+g.addFile(filepath="sim0002.vtu", sim_time=2.0)
+g.addFile(filepath="sim0003.vtu", sim_time=3.0)
 g.save()

examples/image.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -38,19 +38,21 @@
 npoints = (nx + 1) * (ny + 1) * (nz + 1)
 
 # Variables
-pressure = np.random.rand(ncells).reshape( (nx, ny, nz), order = 'C')
-temp = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1))
+pressure = np.random.rand(ncells).reshape((nx, ny, nz), order="C")
+temp = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1))
 
-imageToVTK("./image", cellData = {"pressure" : pressure}, pointData = {"temp" : temp} )
+imageToVTK(
+    "./image", cellData={"pressure": pressure}, pointData={"temp": temp}
+)
 
-fluxx = np.random.rand(ncells).reshape( (nx, ny, nz), order='F')
-fluxy = np.random.rand(ncells).reshape( (nx, ny, nz), order='F')
-fluxz = np.random.rand(ncells).reshape( (nx, ny, nz), order='F')
+fluxx = np.random.rand(ncells).reshape((nx, ny, nz), order="F")
+fluxy = np.random.rand(ncells).reshape((nx, ny, nz), order="F")
+fluxz = np.random.rand(ncells).reshape((nx, ny, nz), order="F")
 flux = (fluxx, fluxy, fluxz)
 
-Efieldx = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1), order='F')
-Efieldy = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1), order='F')
-Efieldz = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1), order='F')
-Efield = (Efieldx,Efieldy,Efieldz)
+Efieldx = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1), order="F")
+Efieldy = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1), order="F")
+Efieldz = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1), order="F")
+Efield = (Efieldx, Efieldy, Efieldz)
 
-imageToVTK("./image", cellData={"flux" : flux}, pointData = {"Efield" : Efieldx} )
+imageToVTK("./image", cellData={"flux": flux}, pointData={"Efield": Efieldx})

examples/lines.py

@@ -48,6 +48,11 @@
 x[2], y[2], z[2] = 0.0, 0.0, 0.0
 x[3], y[3], z[3] = -1.0, 1.0, 1.0
 
-linesToVTK("./lines", x, y, z, cellData = {"vel" : vel}, pointData = {"temp" : temp, "pressure" : pressure})
-
-
+linesToVTK(
+    "./lines",
+    x,
+    y,
+    z,
+    cellData={"vel": vel},
+    pointData={"temp": temp, "pressure": pressure},
+)

examples/lowlevel.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved                     * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved                     *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -34,45 +34,44 @@
 
 nx, ny, nz = 6, 6, 2
 lx, ly, lz = 1.0, 1.0, 1.0
-dx, dy, dz = lx/nx, ly/ny, lz/nz
+dx, dy, dz = lx / nx, ly / ny, lz / nz
 ncells = nx * ny * nz
 npoints = (nx + 1) * (ny + 1) * (nz + 1)
-x = np.arange(0, lx + 0.1*dx, dx, dtype='float64')
-y = np.arange(0, ly + 0.1*dy, dy, dtype='float64')
-z = np.arange(0, lz + 0.1*dz, dz, dtype='float64')
-start, end = (0,0,0), (nx, ny, nz)
+x = np.arange(0, lx + 0.1 * dx, dx, dtype="float64")
+y = np.arange(0, ly + 0.1 * dy, dy, dtype="float64")
+z = np.arange(0, lz + 0.1 * dz, dz, dtype="float64")
+start, end = (0, 0, 0), (nx, ny, nz)
 
 w = VtkFile("./evtk_test", VtkRectilinearGrid)
-w.openGrid(start = start, end = end)
-w.openPiece( start = start, end = end)
+w.openGrid(start=start, end=end)
+w.openPiece(start=start, end=end)
 
 # Point data
 temp = np.random.rand(npoints)
-vx = vy = vz = np.zeros([nx + 1, ny + 1, nz + 1], dtype="float64", order = 'F')
-w.openData("Point", scalars = "Temperature", vectors = "Velocity")
+vx = vy = vz = np.zeros([nx + 1, ny + 1, nz + 1], dtype="float64", order="F")
+w.openData("Point", scalars="Temperature", vectors="Velocity")
 w.addData("Temperature", temp)
-w.addData("Velocity", (vx,vy,vz))
+w.addData("Velocity", (vx, vy, vz))
 w.closeData("Point")
 
 # Cell data
-pressure = np.zeros([nx, ny, nz], dtype="float64", order='F')
-w.openData("Cell", scalars = "Pressure")
+pressure = np.zeros([nx, ny, nz], dtype="float64", order="F")
+w.openData("Cell", scalars="Pressure")
 w.addData("Pressure", pressure)
 w.closeData("Cell")
 
 # Coordinates of cell vertices
 w.openElement("Coordinates")
-w.addData("x_coordinates", x);
-w.addData("y_coordinates", y);
-w.addData("z_coordinates", z);
-w.closeElement("Coordinates");
+w.addData("x_coordinates", x)
+w.addData("y_coordinates", y)
+w.addData("z_coordinates", z)
+w.closeElement("Coordinates")
 
 w.closePiece()
 w.closeGrid()
 
-w.appendData(data = temp)
-w.appendData(data = (vx,vy,vz))
-w.appendData(data = pressure)
+w.appendData(data=temp)
+w.appendData(data=(vx, vy, vz))
+w.appendData(data=pressure)
 w.appendData(x).appendData(y).appendData(z)
 w.save()
-

examples/points.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -39,11 +39,10 @@
 z = np.random.rand(npoints)
 pressure = np.random.rand(npoints)
 temp = np.random.rand(npoints)
-pointsToVTK("./rnd_points", x, y, z, data = {"temp" : temp, "pressure" : pressure})
+pointsToVTK("./rnd_points", x, y, z, data={"temp": temp, "pressure": pressure})
 
 # Example 2
-x = np.arange(1.0,10.0,0.1)
-y = np.arange(1.0,10.0,0.1)
-z = np.arange(1.0,10.0,0.1)
-pointsToVTK("./line_points", x, y, z, data = {"elev" : z})
-
+x = np.arange(1.0, 10.0, 0.1)
+y = np.arange(1.0, 10.0, 0.1)
+z = np.arange(1.0, 10.0, 0.1)
+pointsToVTK("./line_points", x, y, z, data={"elev": z})

examples/poly_lines.py

@@ -61,6 +61,12 @@
 vel[0:3] = 1.0
 vel[4:6] = 5.0
 
-polyLinesToVTK("./poly_lines", x, y, z, pointsPerLine = pointsPerLine, cellData = {"vel" : vel}, pointData = {"temp" : temp, "pressure" : pressure})
-
-
+polyLinesToVTK(
+    "./poly_lines",
+    x,
+    y,
+    z,
+    pointsPerLine=pointsPerLine,
+    cellData={"vel": vel},
+    pointData={"temp": temp, "pressure": pressure},
+)

examples/rectilinear.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -36,18 +36,25 @@
 # Dimensions
 nx, ny, nz = 6, 6, 2
 lx, ly, lz = 1.0, 1.0, 1.0
-dx, dy, dz = lx/nx, ly/ny, lz/nz
+dx, dy, dz = lx / nx, ly / ny, lz / nz
 
 ncells = nx * ny * nz
 npoints = (nx + 1) * (ny + 1) * (nz + 1)
 
 # Coordinates
-x = np.arange(0, lx + 0.1*dx, dx, dtype='float64')
-y = np.arange(0, ly + 0.1*dy, dy, dtype='float64')
-z = np.arange(0, lz + 0.1*dz, dz, dtype='float64')
+x = np.arange(0, lx + 0.1 * dx, dx, dtype="float64")
+y = np.arange(0, ly + 0.1 * dy, dy, dtype="float64")
+z = np.arange(0, lz + 0.1 * dz, dz, dtype="float64")
 
 # Variables
-pressure = np.random.rand(ncells).reshape( (nx, ny, nz))
-temp = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1))
-
-gridToVTK("./rectilinear", x, y, z, cellData = {"pressure" : pressure}, pointData = {"temp" : temp})
+pressure = np.random.rand(ncells).reshape((nx, ny, nz))
+temp = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1))
+
+gridToVTK(
+    "./rectilinear",
+    x,
+    y,
+    z,
+    cellData={"pressure": pressure},
+    pointData={"temp": temp},
+)

examples/structured.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python
 
 # ***********************************************************************************
-# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    * 
+# * Copyright 2010 - 2016 Paulo A. Herrera. All rights reserved.                    *
 # *                                                                                 *
 # * Redistribution and use in source and binary forms, with or without              *
 # * modification, are permitted provided that the following conditions are met:     *
@@ -37,15 +37,15 @@
 # Dimensions
 nx, ny, nz = 6, 6, 2
 lx, ly, lz = 1.0, 1.0, 1.0
-dx, dy, dz = lx/nx, ly/ny, lz/nz
+dx, dy, dz = lx / nx, ly / ny, lz / nz
 
 ncells = nx * ny * nz
 npoints = (nx + 1) * (ny + 1) * (nz + 1)
 
 # Coordinates
-X = np.arange(0, lx + 0.1*dx, dx, dtype='float64')
-Y = np.arange(0, ly + 0.1*dy, dy, dtype='float64')
-Z = np.arange(0, lz + 0.1*dz, dz, dtype='float64')
+X = np.arange(0, lx + 0.1 * dx, dx, dtype="float64")
+Y = np.arange(0, ly + 0.1 * dy, dy, dtype="float64")
+Z = np.arange(0, lz + 0.1 * dz, dz, dtype="float64")
 
 x = np.zeros((nx + 1, ny + 1, nz + 1))
 y = np.zeros((nx + 1, ny + 1, nz + 1))
@@ -56,12 +56,19 @@
 for k in range(nz + 1):
     for j in range(ny + 1):
         for i in range(nx + 1):
-            x[i,j,k] = X[i] + (0.5 - rnd.random()) * 0.1 * dx 
-            y[i,j,k] = Y[j] + (0.5 - rnd.random()) * 0.1 * dy
-            z[i,j,k] = Z[k] + (0.5 - rnd.random()) * 0.1 * dz
+            x[i, j, k] = X[i] + (0.5 - rnd.random()) * 0.1 * dx
+            y[i, j, k] = Y[j] + (0.5 - rnd.random()) * 0.1 * dy
+            z[i, j, k] = Z[k] + (0.5 - rnd.random()) * 0.1 * dz
 
 # Variables
-pressure = np.random.rand(ncells).reshape( (nx, ny, nz))
-temp = np.random.rand(npoints).reshape( (nx + 1, ny + 1, nz + 1))
+pressure = np.random.rand(ncells).reshape((nx, ny, nz))
+temp = np.random.rand(npoints).reshape((nx + 1, ny + 1, nz + 1))
 
-gridToVTK("./structured", x, y, z, cellData = {"pressure" : pressure}, pointData = {"temp" : temp})
+gridToVTK(
+    "./structured",
+    x,
+    y,
+    z,
+    cellData={"pressure": pressure},
+    pointData={"temp": temp},
+)

examples/unstructured.py

@@ -48,11 +48,14 @@
 x[4], y[4], z[4] = 1.0, 1.0, 0.0
 x[5], y[5], z[5] = 2.0, 1.0, 0.0
 
+point_data = {"test_pd": np.array([1, 2, 3, 4, 5, 6])}
+cell_data = {"test_cd": np.array([1, 2, 3])}
+field_data = {"test_fd": np.array([1.0, 2.0])}
 # Define connectivity or vertices that belongs to each element
 conn = np.zeros(10)
 
-conn[0], conn[1], conn[2] = 0, 1, 3              # first triangle
-conn[3], conn[4], conn[5] = 1, 4, 3              # second triangle
+conn[0], conn[1], conn[2] = 0, 1, 3  # first triangle
+conn[3], conn[4], conn[5] = 1, 4, 3  # second triangle
 conn[6], conn[7], conn[8], conn[9] = 1, 2, 5, 4  # rectangle
 
 # Define offset of last vertex of each element
@@ -67,4 +70,15 @@
 ctype[0], ctype[1] = VtkTriangle.tid, VtkTriangle.tid
 ctype[2] = VtkQuad.tid
 
-unstructuredGridToVTK("unstructured", x, y, z, connectivity = conn, offsets = offset, cell_types = ctype, cellData = None, pointData = None)
+unstructuredGridToVTK(
+    "unstructured",
+    x,
+    y,
+    z,
+    connectivity=conn,
+    offsets=offset,
+    cell_types=ctype,
+    cellData=cell_data,
+    pointData=point_data,
+    fieldData=field_data,
+)