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 (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.

Default:

-1

frequency_offset: int#

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.

Default:

0

output_format: Union[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

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None