ogstools.meshplotlib.plot_features module

Specialized plot features.

ogstools.meshplotlib.plot_features.plot_layer_boundaries(ax, surf, projection)

Plot the material boundaries of a surface on a matplotlib axis.

Parameters:

• ax (Axes) –

• surf (DataSet) –

• projection (int) –

Return type:

None

ogstools.meshplotlib.plot_features.plot_element_edges(ax, surf, projection)

Plot the element edges of a surface on a matplotlib axis.

Parameters:

• ax (Axes) –

• surf (DataSet) –

• projection (int) –

Return type:

None

ogstools.meshplotlib.plot_features.plot_streamlines(ax, mesh, mesh_property, projection=None, plot_type='streamlines')

Plot the vector streamlines or arrows on a matplotlib axis.

Parameters:

• ax (Axes) – Matplotlib axis to plot onto

• mesh (DataSet) – Mesh containing the vector property

• mesh_property (Vector) – Vector property to visualize

• projection (int | None) – Index of flat dimension (e.g. 2 for z axis), gets automatically determined if not given

• plot_type (Literal['streamlines', 'arrows', 'lines']) – Whether to plot streamlines, arrows or lines.

Return type:

None

ogstools.meshplotlib.plot_features.plot_on_top(ax, surf, contour, scaling=1.0)

Parameters:

• ax (Axes) –

• surf (DataSet) –

• contour (Callable[[ndarray], ndarray]) –

• scaling (float) –

Return type:

None

ogstools.meshplotlib.plot_features.plot_contour(ax, mesh, style, lw, projection=2)

Parameters:

• ax (Axes) –

• mesh (DataSet) –

• style (str) –

• lw (int) –

• projection (int) –

Return type:

None