flow360.SurfaceOutput

class SurfaceOutput

Bases: _AnimationAndFileFormatSettings

SurfaceOutput class for surface output settings.

Example

• Define SurfaceOutput on all surfaces of the geometry using naming pattern "*".

  >>> fl.SurfaceOutput(
  ...     entities=[geometry['*']],,
  ...     output_format="paraview",
  ...     output_fields=["vorticity", "T"],
  ... )
  

• Define SurfaceOutput on the selected surfaces of the volume_mesh using name pattern "fluid/inflow*".

  >>> fl.SurfaceOutput(
  ...     entities=[volume_mesh["fluid/inflow*"]],,
  ...     output_format="paraview",
  ...     output_fields=["vorticity", "T"],
  ... )
  

---

name: str | None = 'Surface output'

Name of the SurfaceOutput.

entities: EntityListAllowingGhost[Surface, GhostSurface, GhostCircularPlane, GhostSphere] [Required] (alias 'surfaces')

List of boundaries where output is generated.

write_single_file: bool = False

Enable writing all surface outputs into a single file instead of one file per surface.This option currently only supports Tecplot output format.Will choose the value of the last instance of this option of the same output type (SurfaceOutput or TimeAverageSurfaceOutput) in the output list.

output_fields: UniqueItemList[Union] [Required]

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

output_type: Literal['SurfaceOutput'] = 'SurfaceOutput'

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