Pathline

class ansys.fluent.visualization.Pathline(field, surfaces, solver=None, **kwargs)

Bases: _GraphicsContainer

Pathline visualization object.

The Pathline class generates pathlines, which represent the trajectories of massless particles as they travel through the flow field based on the underlying velocity data. Pathlines are commonly used to visualize flow patterns, mixing, recirculation, and streamline-like behavior in transient or steady-state solutions.

Parameters:

fieldstr or VariableDescriptor

The field used to determine particle motion, typically a velocity-based variable (e.g., "velocity-magnitude", "x-velocity", etc.).

surfaceslist of str

List of seed surfaces where pathlines originate. These may include boundary zones, inlets, interior surfaces, or user-defined surfaces.

solverFluentSession, optional

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

**kwargsdict

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

Examples

>>> from ansys.fluent.visualization import Pathline
>>> # `solver_session` is a live Fluent session with a case
>>> # and data which contains the following surfaces
>>> pathlines = Pathline(
>>>     solver=solver_session,
>>>     field="velocity-magnitude",
>>>     surfaces = ["inlet", "inlet1", "inlet2"],
>>> )

__init__(field, surfaces, solver=None, **kwargs)

__init__ method of Pathline class.