IsosurfaceOutput

IsosurfaceOutput#

class IsosurfaceOutput[source]#

Bases: _AnimationAndFileFormatSettings, _OutputBase

IsosurfaceOutput class for isosurface output settings.

Example

Define the IsosurfaceOutput of qcriterion on two isosurfaces:

  • Isosurface_T_0.1 is the Isosurface with its temperature equals to 1.5 non-dimensional temperature;

  • Isosurface_p_0.5 is the Isosurface with its pressure equals to 0.5 non-dimensional pressure.

>>> fl.IsosurfaceOutput(
...     isosurfaces=[
...         fl.Isosurface(
...             name="Isosurface_T_0.1",
...             iso_value=0.1,
...             field="T",
...         ),
...         fl.Isosurface(
...             name="Isosurface_p_0.5",
...             iso_value=0.5,
...             field="p",
...         ),
...     ],
...     output_fields=["qcriterion"],
... )

Attributes

output_fields: UniqueItemList[Union]#

List of output variables. Including universal output variables and UserDefinedField.

frequency: int | Literal[-1]#

Frequency at which output is saved, counted in physical time steps in unsteady simulations. Volume, surface, slice, isosurface and render outputs can also be saved during a steady simulation, where the frequency is counted in pseudo steps instead; the remaining outputs accept a frequency in unsteady simulations only. -1 is at end of simulation. Important for unsteady 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. For steady child cases the pseudo-step count restarts at 0, so the frequency is counted from the start of the child run. Time-averaged outputs are only supported in unsteady simulations.

Default:

-1

frequency_offset: int#

Offset at which output starts to be saved, counted in physical time steps in unsteady simulations. Volume, surface, slice, isosurface and render outputs can also be saved during a steady simulation, where the offset is counted in pseudo steps instead; the remaining outputs accept an offset in unsteady simulations only. 0 is at beginning of simulation. Important for unsteady 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. For steady child cases the pseudo-step count restarts at 0, so the offset is counted from the start of the child run. Time-averaged outputs are only supported in unsteady simulations.

Default:

0

output_format: list[Literal['paraview', 'tecplot', 'vtkhdf', 'ensight']] | Literal['paraview', 'tecplot', 'both']#

List of output formats, Supported formats: paraview, tecplot, vtkhdf, ensight. A single string is accepted for backward compatibility but deprecated.

Default:

['paraview']

name: str, optional#

Name of the IsosurfaceOutput.

Default:

'Isosurface output'

entities: UniqueItemList[Isosurface]#

List of Isosurface entities.

Additional Constructors

preprocess(*, params=None, exclude=None, required_by=None, flow360_unit_system=None)[source]#

Convert all dimensioned fields to flow360 base unit system, recursively.

Copy-on-write: returns self when no value in the subtree required conversion, skipping the pydantic re-validation rebuild for unchanged nodes.

Parameters:
Return type:

Flow360BaseModel