plot_nodal_responses_animation

opstool.vis.pyvista.plot_nodal_responses_animation(odb_tag=1, framerate=None, savefig='NodalRespAnimation.gif', off_screen=True, defo_scale=1.0, show_defo=True, interpolate_beam_disp=False, resp_type='disp', resp_dof=('UX', 'UY', 'UZ'), unit_symbol=None, unit_factor=None, show_bc=False, bc_scale=1.0, show_mp_constraint=False, show_max_min=True, cpos='iso', show_undeformed=False, style='surface', show_outline=False, lazy_load=False)

Visualize node response animation.

Return type:

Plotter

Parameters

odb_tag: Union[int, str], default: 1

Tag of output databases (ODB) to be visualized.

framerate: int, default: 5

Framerate for the display, i.e., the number of frames per second.

savefig: str, default: NodalRespAnimation.gif

Path to save the animation. The suffix can be .gif or .mp4.

off_screen: bool, default: True

Whether to display the plotting window. If True, the plotting window will not be displayed.

defo_scale: Union[float, int, bool] = 1.0

Scales the size of the deformation presentation. If set to False, the deformed shape will not be scaled (original deformation). If set to True or “auto”, the deformed shape will be scaled by the default scale (i.e., 1/20 of the maximum model dimensions). If set to a float or int, it will scale the deformed shape by that factor.

interpolate_beam_disp: bool, default: False, added since version 1.0.25.

Whether to interpolate beam displacements. Shape functions will be used to interpolate the displacements of beam elements for a smoother visualization. If you have a large number of beam elements, enabling this option may slow down the plotting process, and it is recommended to disable it. If True, You need to ensure that the data has been saved in CreateODB with interpolate_beam_disp=True for this option to take effect.

show_defo: bool, default: True

Whether to display the deformed shape.

resp_type: str, default: disp

Type of response to be visualized. Optional: “disp”, “vel”, “accel”, “reaction”, “reactionIncInertia”, “rayleighForces”, “pressure”.

resp_dof: str, default: (“UX”, “UY”, “UZ”)

Component to be visualized. Optional: “UX”, “UY”, “UZ”, “RX”, “RY”, “RZ”. You can also pass on a list or tuple to display multiple dimensions, for example, [“UX”, “UY”], [“UX”, “UY”, “UZ”], [“RX”, “RY”, “RZ”], [“RX”, “RY”], [“RY”, “RZ”], [“RX”, “RZ”], and so on.

unit_symbol: str, default: None

Unit symbol to be displayed in the plot.

unit_factor: float, default: None

The multiplier used to convert units. For example, if you want to visualize stress and the current data unit is kPa, you can set unit_symbol="kPa" and unit_factor=1.0. If you want to visualize in MPa, you can set unit_symbol="MPa" and unit_factor=0.001.

show_bc: bool, default: True

Whether to display boundary supports.

bc_scale: float, default: 1.0

Scale the size of boundary support display.

show_mp_constraint: bool, default: False

Whether to show multipoint (MP) constraint.

show_max_min: bool, default: True

Whether to show the maximum and minimum labels on the plot.

cpos: str, default: iso

Model display perspective, optional: “iso”, “xy”, “yx”, “xz”, “zx”, “yz”, “zy”. If 3d, defaults to “iso”. If 2d, defaults to “xy”.

show_undeformed: bool, default: False

Whether to show the undeformed shape of the model.

show_outline: bool, default: False

Whether to display the outline of the model.

style: str, default: surface

Visualization mesh style of surfaces and solids. One of the following: style=’surface’, style=’wireframe’, style=’points’, style=’points_gaussian’. Defaults to ‘surface’. Note that ‘wireframe’ only shows a wireframe of the outer geometry.

lazy_load: bool, default: False, added since version 1.0.25.

Whether to lazily load the response data. If True, the response data will be loaded on demand when needed for plotting. This can save memory when dealing with large datasets. If False, all response data will be loaded into memory at once. If you encounter memory issues, consider setting this parameter to True, elsewise, set it to False for plotting in safety.

Returns

Plotting object of PyVista to display vtk meshes or numpy arrays. See pyvista.Plotter.

You can use Plotter.show. to display the plotting window.

You can also use Plotter.export_html. to export this plotter as an interactive scene to an HTML file.