flow360.PointArray

class PointArray

Bases: _PointEntityBase

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

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

---

start: Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]

The starting point of the line.

Constraints:

• func = <function _dimensioned_type_serializer at 0x79c44aad7130>

• return_type = PydanticUndefined

• when_used = always

end: Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]

The end point of the line.

Constraints:

• func = <function _dimensioned_type_serializer at 0x79c44aad7130>

• return_type = PydanticUndefined

• when_used = always

number_of_points: int [Required]

Number of points along the line.

Constraints:

• gt = 2

property id: str

Returns private_attribute_id of the entity.

name: str [Required]