plot_frame_responses_animation

opstool.vis.pyvista.plot_frame_responses_animation(odb_tag=1, ele_tags=None, resp_type='sectionForces', resp_dof='MZ', unit_symbol=None, unit_factor=None, scale=1.0, show_values='MaxMin', framerate=None, savefig='FrameForcesAnimation.gif', off_screen=True, style='surface', color=None, line_width=1.5, opacity=1.0, show_bc=True, bc_scale=1.0, show_mp_constraint=False, show_outline=False, cpos='iso', show_model=True)[source]

Animate the responses of frame elements.

Return type:

Plotter

Parameters

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

Tag of output databases (ODB) to be visualized.

ele_tags: Union[int, list], default: None

The tags of frame elements to be visualized. If None, all frame elements are selected.

resp_type: str, default: “sectionforces”

Response type, optional, one of [“localForces”, “basicForces”, “basicDeformations”, “plasticDeformation”, “sectionForces”, “sectionDeformations”].

resp_dof: str, default: “MZ”

Component type corrsponding to the resp_type.

  • For localForces: [“FX”, “FY”, “FZ”, “MX”, “MY”, “MZ”]

  • For basicForces: [“N”, “MZ”, “MY”, “T”]

  • For basicDeformations: [“N”, “MZ”, “MY”, “T”]

  • For plasticDeformation: [“N”, “MZ”, “MY”, “T”]

  • For sectionForces: [“N”, “MZ”, “VY”, “MY”, “VZ”, “T”]

  • For sectionDeformations: [“N”, “MZ”, “VY”, “MY”, “VZ”, “T”]

Note

For sectionForces and sectionDeformations, not all sections include the shear dof VY and VZ. For instance, in the most commonly used 3D fiber cross-sections, only the axial force N, bending moments MZ and MY, and torsion T are available.

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.

scale: float, default: 1.0

Scale the size of the response graph.

Note

You can adjust the scale to make the response graph more visible. A negative number will reverse the direction.

show_values: Union[bool, str], default: MaxMin

Whether to display the response value. If str, optional: [“MaxMin”, “eleMaxMin”, “eleMax”, “eleMin”, “all”].

  • “MaxMin”: show the max and min values of the response.

  • “eleMaxMin”: show the max and min values of the response for each element.

  • “eleMax”: show the max value of the response for each element.

  • “eleMin”: show the min value of the response for each element.

  • “all”: show all values of the response for each element.

framerate: int, default: None

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

savefig: str, default: FrameForcesAnimation.gif

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

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”.

off_screen: bool, default: True

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

style: str, default: “surface

Display style for responses plot, optional, one of [“surface”, “wireframe”]

color: str, default: None

Single color of the response graph. If None, the colormap will be used.

line_width: float, default: 1.5.

Line width of the response graph when style=”wireframe”.

opacity: float, default: 1.0

Face opacity when style=”surface”.

show_model: bool, default: True

Whether to plot the all model or not.

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_outline: bool, default: False

Whether to display the outline of the model.

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.