Isosurface

class Isosurface

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: LengthType.Positive, optional

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

Default:

None

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')