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

Methods

classmethod check_expression_length(v)[source]#

Ensure the isofield is a scalar.

Parameters:: v (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 | ~flow360_schema.framework.expression.variable.UserVariable)
Return type:: 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 | ~flow360_schema.framework.expression.variable.UserVariable

classmethod check_runtime_expression(v)[source]#

Ensure the isofield is a runtime expression but not a constant value.

Parameters:: v (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 | ~flow360_schema.framework.expression.variable.UserVariable)
Return type:: 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 | ~flow360_schema.framework.expression.variable.UserVariable

classmethod check_single_iso_value(v)[source]#

Ensure the iso_value is a single value.

Parameters:: v (Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9ff370>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)])
Return type:: Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9fdd80>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)]

classmethod check_iso_value_dimensions(v, info)[source]#

Ensure the iso_value has the same dimensions as the field.

Parameters:

v (Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9fc0d0>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)])
info (ValidationInfo)

Return type:

Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9ffeb0>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)]

classmethod check_iso_value_for_string_field(v, info)[source]#

Ensure the iso_value is float when string field is used.

Parameters:

v (Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9fca60>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)])
info (ValidationInfo)

Return type:

Annotated[Annotated[Expression, AfterValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._internal_validator), Tag(tag=expression)] | Annotated[UnytQuantity | float, Tag(tag=number)], FieldInfo(annotation=NoneType, required=True, discriminator=Discriminator(discriminator=<function ValueOrExpression.__class_getitem__.<locals>._discriminator at 0x7a108c9ff880>, custom_error_type=None, custom_error_message=None, custom_error_context=None)), BeforeValidator(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._deserialize, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~flow360_schema.framework.expression.value_or_expression.ValueOrExpression.__class_getitem__.<locals>._serializer, return_type=PydanticUndefined, when_used=always)]

Isosurface

Contents

Isosurface#