TimeAverageStreamlineOutput

class TimeAverageStreamlineOutput

Bases: StreamlineOutput

StreamlineOutput class for calculating time-averaged streamlines. Stramtraces are computed upwind and downwind, and may originate from a single point, from a line, from points evenly distributed across a parallelogram, or from an explicit list of points.

Example

Define a TimeAverageStreamlineOutput with streaptraces originating from points, lines (PointArray), parallelograms (PointArray2D), and an explicit list of points (PointGroup).

• Point_1 and Point_2 are two specific points we want to track the streamlines.

• Line_streamline is from (1,0,0) * fl.u.m to (1,0,-10) * fl.u.m and has 11 points, including both starting and end points.

• Parallelogram_streamline is a parallelogram in 3D space with an origin at (1.0, 0.0, 0.0), a u-axis orientation of (0, 2.0, 2.0) with 11 points in the u direction, and a v-axis orientation of (0, 1.0, 0) with 20 points along the v direction.

• Seed_points holds two explicitly listed seed points under one name.

>>> fl.TimeAverageStreamlineOutput(
...     entities=[
...         fl.Point(
...             name="Point_1",
...             location=(0.0, 1.5, 0.0) * fl.u.m,
...         ),
...         fl.Point(
...             name="Point_2",
...             location=(0.0, -1.5, 0.0) * fl.u.m,
...         ),
...         fl.PointArray(
...             name="Line_streamline",
...             start=(1.0, 0.0, 0.0) * fl.u.m,
...             end=(1.0, 0.0, -10.0) * fl.u.m,
...             number_of_points=11,
...         ),
...         fl.PointArray2D(
...             name="Parallelogram_streamline",
...             origin=(1.0, 0.0, 0.0) * fl.u.m,
...             u_axis_vector=(0, 2.0, 2.0) * fl.u.m,
...             v_axis_vector=(0, 1.0, 0) * fl.u.m,
...             u_number_of_points=11,
...             v_number_of_points=20
...         ),
...         fl.PointGroup(
...             name="Seed_points",
...             locations=[[2.0, 0.0, 0.0], [2.0, 0.5, 0.0]] * fl.u.m,
...         ),
...     ]
... )

Attributes

output_fields: UniqueItemList[UserVariable], optional

List of output variables. Vector-valued fields will be colored by their magnitude.

Default:

[]

name: str, optional

Name of the TimeAverageStreamlineOutput.

Default:

'Time-average Streamline output'

entities: EntityList[Point, PointArray, PointArray2D, PointGroup]

List of monitored Point/PointArray/PointArray2D/PointGroup entities belonging to this streamline group. PointArray is used to define streamline originating along a line. PointArray2D is used to define streamline originating from a parallelogram. PointGroup is used to define streamline originating from many explicitly listed points under one name.

start_step: int | Literal[-1]

Physical time step to start calculating averaging. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example).

Default:

-1