PointArray

PointArray#

class PointArray[source]#

Bases: EntityBase

PointArray class for defining multiple equally spaced monitor points along a line.

Example

Define PointArray with 6 equally spaced points along a line starting from (0,0,0) * fl.u.m to (1,2,3) * fl.u.m. Both the starting and end points are included in the PointArray.

>>> fl.PointArray(
...     name="Line_1",
...     start=(0.0, 0.0, 0.0) * fl.u.m,
...     end=(1.0, 2.0, 3.0) * fl.u.m,
...     number_of_points=6,
... )

Attributes

start: Any#

The starting point of the line.

end: Any#

The end point of the line.

number_of_points: int#

Number of points along the line.

Properties

id: str#

Returns private_attribute_id of the entity.

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None