flow360.SurfaceSliceOutput

class SurfaceSliceOutput

Bases: _AnimationAndFileFormatSettings, _OutputBase

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, MirroredSurface, WindTunnelGhostSurface] [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: pd.PositiveInt | Literal[-1] = -1

Frequency (in number of physical time steps) at which output is saved. -1 is at end of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case. Example: if the parent case finished at time_step=174, the child case will start from time_step=175. If frequency=100 (child case), the output will be saved at time steps 200 (25 time steps of the child simulation), 300 (125 time steps of the child simulation), etc. This setting is NOT applicable for steady cases.

frequency_offset: int = 0

Offset (in number of physical time steps) at which output is started to be saved. 0 is at beginning of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example). Example: if an output has a frequency of 100 and a frequency_offset of 10, the output will be saved at global time step 10, 110, 210, etc. This setting is NOT applicable for steady cases.

Constraints:

• ge = 0