plopm.utils.write_vtk module#

Create VTK files from OPM Flow simulation results.

The module runs a minimal OPM Flow job when grid geometry is unavailable, populates VTU cell-data arrays for selected restart steps, and writes the PVD collection used to open the resulting time series.

make_vtks(flow, names, output, save, restart, variables, vtkformat_list, vtknames, gif, vtk, filters, scales, mass, mass_all, caprock, stress, filterss)[source]#

Create VTK time-series output for the configured cases.

A minimal OPM Flow run creates the grid-only VTU file when needed. Selected properties are then read from INIT or UNRST output and written to one VTU file per restart step.

Parameters:
flowstr

Command used to run OPM Flow.

nameslist

Simulation-case stems grouped by the CLI input.

outputstr

Directory in which VTK files are written.

savelist

Optional output stems for each case.

restartlist

Restart report steps to export.

variableslist

Variables or expressions written as cell data.

vtkformat_listlist

VTK data type selected for each variable.

vtknameslist

Optional VTK array names for each variable.

gif, vtkbool

Output-mode flags passed to the simulation readers.

filterslist

Property filters used while loading each case.

scaleslist[str]

Scale factor applied to each variable.

mass, mass_alllist[str]

Mass variables and all supported mass-related variables.

caprocklist[str]

Supported caprock-integrity variables.

stressfloat

Vertical stress coefficient used for caprock quantities.

filtersslist[str]

Filter expressions applied while reading exported quantities.

Returns:
list[str]

Names of the generated PVD collection files.

Parameters:
Return type:

list