Isosurface

Isosurface#

class Isosurface[source]#

Bases: _OutputItemBase

Isosurface class for defining an isosurface for IsosurfaceOutput.

Example

Define a Isosurface of temperature equal to 1.5 non-dimensional temperature.

>>> fl.Isosurface(
...     name="Isosurface_T_1.5",
...     iso_value=1.5,
...     field="T",
...     wallDistanceClipThreshold=0.005 * fl.u.m, (optional)
... )

Attributes

name: str#
field: Literal['Mach', 'qcriterion', 's', 'T', 'Cp', 'Cpt', 'mut', 'nuHat', 'vorticityMagnitude', 'vorticity_x', 'vorticity_y', 'vorticity_z', 'velocity_magnitude', 'velocity_x', 'velocity_y', 'velocity_z'] | str | UserVariable#

Isosurface field variable. One of p, rho, Mach, qcriterion, s, T, Cp, mut, nuHat or one of scalar field defined in UserDefinedField.

iso_value: Expression | UnytQuantity | float#

Expect non-dimensional value.

wall_distance_clip_threshold: Any, optional#

Optional parameter to remove the isosurface within a specified distance from walls.

Default:

None

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