Slice

Slice#

class Slice[source]#

Bases: EntityBase

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

Attributes

normal: Axis#

Normal direction of the slice.

origin: Any#

A single point on the slice.

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