flow360.PointArray2D#

class PointArray2D[source]#

Bases: _PointEntityBase

PointArray2D class for defining multiple equally spaced points along the u and v axes of a parallelogram.

Example

Define PointArray2D with points equally distributed on a parallelogram with origin (1.0, 0.0, 0.0) * fl.u.m. There are 7 equally spaced points along the parallelogramโ€™s u-axis of (0.5, 1.0, 0.2) * fl.u.m and 10 equally spaced points along the its v-axis of (0.1, 0, 1) * fl.u.m.

Both the starting and end points are included in the PointArray.

>>> fl.PointArray2D(
...     name="Parallelogram_1",
...     origin=(1.0, 0.0, 0.0) * fl.u.m,
...     u_axis_vector=(0.5, 1.0, 0.2) * fl.u.m,
...     v_axis_vector=(0.1, 0, 1) * fl.u.m,
...     u_number_of_points=7,
...     v_number_of_points=10
... )

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

The corner of the parallelogram.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x7392a2765d80>

  • return_type = PydanticUndefined

  • when_used = always

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

The scaled u-axis of the parallelogram.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x7392a2765d80>

  • return_type = PydanticUndefined

  • when_used = always

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

The scaled v-axis of the parallelogram.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x7392a2765d80>

  • return_type = PydanticUndefined

  • when_used = always

u_number_of_points: int [Required]#

The number of points along the u axis.

Constraints:
  • ge = 2

v_number_of_points: int [Required]#

The number of points along the v axis.

Constraints:
  • ge = 2

property id: str#

Returns private_attribute_id of the entity.

name: str [Required]#