XYPlot

class ansys.fluent.visualization.XYPlot(surfaces, y_axis_function, solver=None, local_surfaces_provider=None, **kwargs)

Bases: _GraphicsContainer

XY plot visualization object.

The XYPlot class creates a Fluent XY plot of a scalar field evaluated along one or more surfaces. XY plots are typically used to visualize variations of a quantity along a line, surface intersection, or custom geometric curve.

Parameters:

surfaceslist of str

List of Fluent surfaces on which the XY plot is evaluated. These may be boundary zones, interior surfaces, or user-defined surfaces such as line surfaces, intersections, or extracted curves.

y_axis_functionstr or VariableDescriptor

The scalar field whose values are plotted on the Y-axis of the plot. Examples include "temperature", "pressure", "velocity-magnitude", or any available field in the solver.

solverFluentSession, optional

Active Fluent session. If None, the parent container or base class determines the session.

**kwargsdict

Additional keyword arguments forwarded to Graphics(session).XYPlots.create() or handled by the base class.

Examples

>>> from ansys.fluent.visualization import XYPlot
>>> xy_plot = XYPlot(
>>>     solver=solver_session,
>>>     surfaces=["outlet"],
>>>     y_axis_function="temperature",
>>> )

__init__(surfaces, y_axis_function, solver=None, local_surfaces_provider=None, **kwargs)

__init__ method of XYPlot class.