flow360.Slice

flow360.Slice#

class Slice[source]#

Bases: _SliceEntityBase

Slice class for defining a slice for SliceOutput.

Example

Define a Slice along (0,1,0) direction with the origin of (0,2,0) fl.u.m.

>>> fl.Slice(
...     name="Slice",
...     normal=(0, 1, 0),
...     origin=(0, 2, 0)*fl.u.m
... )
normal: Axis [Required]#

Normal direction of the slice.

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

A single point on the slice.

Constraints:

  • func = <function _dimensioned_type_serializer at 0x79c44aad7130>

  • return_type = PydanticUndefined

  • when_used = always

property id: str#

Returns private_attribute_id of the entity.

name: str [Required]#