plot_streamlines

plot_streamlines(vector_data, fig=None, tube_radius=None, streamline_kwargs=None, mesh_kwargs=None, plotter_kwargs=None)

Plot streamlines to the Plotter object

Return type:

Plotter

Parameters:

• vector_data – A dataclass containing 3D vector data in 3 component directions

• fig – Pyvista plotter object

• tube_radius – Radius of streamline tube. Defaults to 0.75/224 * vector_data.nz

• streamline_kwargs – PyVista keyword arguments to customize the streamline

• mesh_kwargs – Pyvista mesh keyword arguments to pass to the plotter.

• plotter_kwargs – Additional keyword arguments to pass to the plotter.

Returns:

Plotter object with streamlines added as a mesh

Return type:

pv.Plotter