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, or from points evenly distributed across a parallelogram.

Example

Define a TimeAverageStreamlineOutput with streaptraces originating from points, lines (PointArray), and parallelograms (PointArray2D).

• 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.

>>> 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
...         )
...     ]
... )

---

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]

List of monitored Point/PointArray/PointArray2D 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.

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

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')