MeshSliceOutput

MeshSliceOutput#

class MeshSliceOutput[source]#

Bases: Flow360BaseModel

MeshSliceOutput class for mesh slice output settings.

Example

>>> fl.MeshSliceOutput(
...     slices=[
...         fl.Slice(
...             name="Slice_1",
...             normal=(0, 1, 0),
...             origin=(0, 0.56, 0)*fl.u.m
...         ),
...     ],
... )

Attributes

name: str#

Name of the MeshSliceOutput.

Default:

'Mesh slice output'

entities: EntityList[Slice]#

List of output Slice entities.

include_crinkled_slices: bool#

Generate crinkled slices in addition to flat slices.

Default:

False

cutoff_radius: Any, optional#

Cutoff radius of the slice output. If not specified, the slice extends to the boundaries of the volume mesh.

Default:

None

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