ogstools.mesh.cosim module#

ogstools.mesh.cosim.from_simulator(simulation, name, node_properties=None, cell_properties=None, field_properties=None)[source]#

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

Parameters:

simulator – Initialized and not finalized simulator object
name (str) – Name of the submesh (e.g. domain, left, … )
node_properties (Sequence[str] | None) – Given properties will be added to the mesh None or [] -> no properties will be added
cell_properties (Sequence[str] | None) – Given properties will be added to the mesh None or [] -> no properties will be added

Return type:

UnstructuredGrid

Returns:

A Mesh (Pyvista Unstructured Grid) object