flow360.SurfaceSliceOutput

class SurfaceSliceOutput

Bases: _AnimationAndFileFormatSettings

Surface slice settings.

name: str = 'Surface slice output'

Name of the SurfaceSliceOutput.

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

List of Slice entities.

target_surfaces: EntityList[Surface] [Required]

List of Surface entities on which the slice will cut through.

output_format: Literal['paraview'] = 'paraview'

output_fields: UniqueItemList[Union] [Required]

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

output_type: Literal['SurfaceSliceOutput'] = 'SurfaceSliceOutput'

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