ogstools.mesh.cosim module

ogstools.mesh.cosim.from_simulator(simulation, name, node_properties=None, cell_properties=None, field_properties=None)

Constructs a pyvista mesh from a running simulation. It always contains points (geometry) and cells (topology) and optionally the given node-based or cell-based properties Properties must be added afterwards

param simulator:

Initialized and not finalized simulator object

param name:

Name of the submesh (e.g. domain, left, … )

param node_properties:

Given properties will be added to the mesh None or [] -> no properties will be added

param cell_properties:

Given properties will be added to the mesh None or [] -> no properties will be added

returns:

A Mesh (Pyvista Unstructured Grid) object

Return type:

UnstructuredGrid