Plot Over Time
- class PlotOverTime(case, probe_point, fields=[], height=135)[source]
Bases:
IViewObjectInitialize a PlotOverTime view for sampling scalar fields at a single point and rendering an XY chart representation over a time sequence.
The PlotOverTime view element can be used to display how scalar fields evolve over time at a specific point probe location inside your case. You can embed this chart into a layout cell, and you can also export the underlying sampled values as a CSV file.
This class enables: - Sampling multiple scalar fields at a specific point in 3D space. - Rendering the sampled temporal data in a ParaView XY chart. - Exporting the underlying sampled values as CSV.
- Parameters:
- Returns:
None
- delete_view()
Delete the underlying render view.
This method removes the associated ParaView render view from the visualization pipeline and logs that the view should no longer be used.
- Returns:
None
- get_case()
Return the loaded case this view is based on.
- Returns:
The loaded case of the view object.
- Return type:
- get_height()
Return the height of the view in pixels.
If the internally stored height is less than or equal to zero, a warning is logged and the height is set to a failsafe value of
10to prevent division-by-zero issues during rendering.- Returns:
The height of the view in pixels.
- Return type:
- get_render_view()
Return the underlying ParaView render view.
This method provides access to the internal
_render_viewattribute, which represents the ParaViewRenderViewused by the view for visualization.- Returns:
The associated ParaView render view.
- get_width()
Return the width of the view in pixels.
If the internally stored width is less than or equal to zero, a warning is logged and the width is set to a failsafe value of
10to prevent division-by-zero issues during rendering.- Returns:
The width of the view in pixels.
- Return type:
- render(layout, row=0, col=0)
Render the view into the given layout and apply modifiers.
This method performs the following steps in order: 1. Validates that
layoutis aLayoutinstance. 2. Renders the view’s own content via_render_insideat the specified grid position (row,col). 3. Toggles the orientation axes visibility on the underlying render view, if available. 4. Applies all attached render modifiers via_render_modifiers. 5. If both a display and block selectors are present, applies the block selection to the display.
- set_blocks(blocks)
Set the list of blocks to be displayed in the view.
This method assigns the provided list of block identifiers to the internal
_blocksattribute, determining which blocks are shown in the rendered output.- Parameters:
blocks (List[str]) – A list of block names or identifiers.
- Returns:
None