pylbo.visualisation.modes.cartesian_3d

Classes

CartesianSlicePlot3D

Class for handling Cartesian 3D plots of the eigenmode solution.

Module Contents

class pylbo.visualisation.modes.cartesian_3d.CartesianSlicePlot3D(data: pylbo.visualisation.modes.mode_data.ModeVisualisationData, u2: numpy.ndarray, u3: numpy.ndarray, time: float, slicing_axis: str, figsize: tuple[int, int], vmin: float = None, vmax: float = None, **kwargs)

Bases: pylbo.visualisation.modes.cartesian_2d.CartesianSlicePlot2D

Class for handling Cartesian 3D plots of the eigenmode solution.

Parameters:

  • data (ModeVisualisationData) – The data for the visualisation.

  • u2 (np.ndarray) – The \(y\) coordinate of the eigenmode solution.

  • u3 (np.ndarray) – The \(z\) coordinate of the eigenmode solution.

  • time (float) – The time at which the eigenmode solution is calculated.

  • slicing_axis (str) – The axis along which the eigenmode solution is sliced.

  • figsize (tuple[int, int]) – The size of the figure.

  • vmin (float) – The minimum value of the colourbar. If None, the minimum value of the solution is used.

  • vmax (float) – The maximum value of the colourbar. If None, the maximum value of the solution is used.

vmin
vmax
_view
_create_figure_layout(figsize: tuple[int, int]) → tuple[matplotlib.figure.Figure, dict]
_create_cbar_axes(width: float) → matplotlib.axes.Axes
_validate_u2(u2: numpy.ndarray, *args, **kwargs) → numpy.ndarray

Validates the combination of u2 and slicing axis.

Parameters:

  • u2 (float) – The \(u_2\) coordinate.

  • slicing_axis (str) – The slicing axis.

  • axis (str) – The coordinate axis corresponding to \(u_2\).

Returns:

The validated \(u_2\) coordinate.

Return type:

float

_validate_u3(u3: numpy.ndarray, *args, **kwargs) → numpy.ndarray

Validates the combination of u3 and slicing axis.

Parameters:

  • u3 (float) – The \(u_3\) coordinate.

  • slicining_axis (str) – The slicing axis.

  • axis (str) – The coordinate axis corresponding to \(u_3\).

Returns:

The validated \(u_3\) coordinate.

Return type:

float

set_plot_arrays() → None
calculate_mode_solution(efdata: numpy.ndarray, u2: numpy.ndarray, u3: numpy.ndarray, t: numpy.ndarray) → numpy.ndarray
draw_eigenfunction() → None
draw_solution() → None
add_axes_labels() → None
draw_textboxes() → None
_clear_contours() → None
_update_view(updated_solution: numpy.ndarray) → None

Updates the axes with the new solution. If a contour plot is used, the contour lines are cleared and redrawn. If an image plot is used, the image is updated.

Parameters:

updated_solution (np.ndarray) – The new solution.

_update_view_clims(solution: numpy.ndarray) → None
_set_t_txt(t)