flow360.SliceOutput

class SliceOutput

Bases: _AnimationAndFileFormatSettings

SliceOutput class for slice output settings.

Example

>>> fl.SliceOutput(
...     slices=[
...         fl.Slice(
...             name="Slice_1",
...             normal=(0, 1, 0),
...             origin=(0, 0.56, 0)*fl.u.m
...         ),
...     ],
...     output_format="paraview",
...     output_fields=["vorticity", "T"],
... )

---

name: str | None = 'Slice output'

Name of the SliceOutput.

entities: EntityList[Slice] [Required] (alias 'slices')

List of output Slice entities.

output_fields: UniqueItemList[Union] [Required]

List of output variables. Including universal output variables, variables specific to SliceOutput and UserDefinedField.

output_type: Literal['SliceOutput'] = 'SliceOutput'

output_format: Literal['paraview', 'tecplot', 'both'] = 'paraview'

paraview, tecplot or both.

frequency: int = -1

Frequency (in number of physical time steps) at which output is saved. -1 is at end of simulation.

Constraints:

• ge = -1

frequency_offset: int = 0

Offset (in number of physical time steps) at which output animation is started. 0 is at beginning of simulation.

Constraints:

• ge = 0