ParticleWireframePlot#

Examples using this class are:

Acoustofluidics 2022: Plotting the Scattering Field

class osaft.plotting.scattering.particle_plots.ParticleWireframePlot(sol, nbr_r_levels=10, nbr_theta_levels=10, resolution=(100, 100), scale_factor=0.1)[source]#

Bases: BaseScatteringPlotter

Plotting class for wireframe plot of the particle

Parameters:

sol (BaseScattering) – solution to be plotted
nbr_r_levels (int, optional) – number of circles shown in the wireframe
Default: 10
nbr_theta_levels (int, optional) – number of radii shown in the wireframe
Default: 10
resolution (int | tuple[int, int], optional) – resolution, if tuple (radial res, tangential res)
Default: (100, 100)
scale_factor (float, optional) – scaling factor for the displacements, if None auto
Default: 0.1

Public Methods:

`plot`([phase, mode, ax])	Plot wireframe
`animate`([frames, interval, mode, ax])	Animate wireframe
`plot_evolution`([mode, layout])	Plot wireframe over one period

animate(frames=64, interval=100.0, mode=None, ax=None)[source]#

Animate wireframe

Parameters:

frames (int, optional) – number of frames for the animation
Default: 64
interval (float, optional) – interval between frames in milliseconds
Default: 100.0
mode (None | int, optional) – mode to be plotted, if None superposition of all modes
Default: None
ax (None | plt.Axes, optional) – if ax is passed, plot will be drawn on ax
Default: None

plot(phase=0, mode=None, ax=None)[source]#

Plot wireframe

Parameters:

phase (float, optional) – phase to be plotted
Default: 0
mode (None | int, optional) – mode to be plotted, if None superposition of all modes
Default: None
ax (None | plt.Axes, optional) – if ax is passed, plot will be drawn on ax
Default: None

Return type:

tuple[plt.Figure, plt.Axes]

plot_evolution(mode=None, layout=(3, 3), **kwargs)[source]#

Plot wireframe over one period

Parameters:

layout (tuple[int, int], optional) – subplot layout of the figure
Default: (3, 3)
mode (None | int, optional) – mode to be plotted, if None superposition of all modes
Default: None

Return type:

tuple[plt.Figure, plt.Axes]