pylbm.stencil.Stencil.visualize¶

method

Stencil.visualize(viewer_mod=<module 'pylbm.viewer.matplotlib_viewer' from '/home/docs/checkouts/readthedocs.org/user_builds/pylbm/conda/0.6.0/lib/python3.6/site-packages/pylbm/viewer/matplotlib_viewer.py'>, k=None, unique_velocities=False, view_label=True)¶

plot the velocities

Parameters

viewerpackage used to plot the figure (could be matplotlib, …)

see viewer for more information

klist of stencil index to plot

if None plot all stencils

unique_velocitiesif True plot the unique velocities

view_label: if True show the velocity numbering

Returns

fig

the figure (fig if matplotlib is used)