get_nodal_responses_dataset

opstool.vis.pyvista.get_nodal_responses_dataset(odb_tag=1, step='absMax', resp_type='disp', resp_dof=('UX', 'UY', 'UZ'), defo_scale=1.0, lazy_load=False)

Get nodal responses dataset. Scalars are stored in the resp_type field of the dataset.

Added in version 1.0.18+.

Data Model in PyVista can be found at PyVista Data Model.

Return type:

UnstructuredGrid

Parameters

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

Tag of output databases (ODB) to be visualized.

step: Union[int, str], default: “absMax”

If slides = False, this parameter will be used as the step to plot. If str, Optional: [absMax, absMin, Max, Min]. If int, this step will be demonstrated (counting from 0).

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.

Note

If the nodes include fluid pressure dof, such as those used for …UP elements, the pore pressure should be extracted using resp_type="vel", and resp_dof="RZ".

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.

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

unstru_grid: pyvista.UnstructuredGrid.

Unstructured grid with unstructured cells and response scalars.