plot_nodal_responses_animation

opstool.vis.plotly.plot_nodal_responses_animation(odb_tag=1, framerate=None, 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=True, bc_scale=1.0, show_mp_constraint=False, show_undeformed=False, style='surface', show_outline=False, show_max_min=False, lazy_load=False)

Visualize node response animation.

Return type:

Figure

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. For example, if an earthquake analysis has 1000 steps and you want to complete the demonstration in ten seconds, you should set framerate = 1000/10 = 100.

defo_scale: float, default: 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.

show_defo: bool, default: True

Whether to display the deformed shape.

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.

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. This feature is added since v1.0.15.

unit_factor: float, default: None

This feature is added since v1.0.15. 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_undeformed: bool, default: False

Whether to show the undeformed shape of the model. Set to False can improve the performance of the visualization.

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’ or style=’wireframe’ Defaults to ‘surface’. Note that ‘wireframe’ only shows a wireframe of the outer geometry.

show_max_min: bool, default: False

Whether to show the maximum and minimum response value annotations in the plot.

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

fig: plotly.graph_objects.Figure

You can use fig.show() to display, You can also use fig.write_html(“path/to/file.html”) to save as an HTML file, see Interactive HTML Export in Python