Skip to content

Added legacy tagging for previous UDFs #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benflexcompute merged 2 commits into from
Jul 22, 2025
Merged

Added legacy tagging for previous UDFs #1281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
005ada5
Added legacy tagging for previous UDFs
benflexcompute Jul 22, 2025
a34a7f2
Merge remote-tracking branch 'origin/main' into BenY/UDFLegacyTag
angranl-flex Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions flow360/component/simulation/translator/solver_translator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,7 @@ def process_output_fields_for_udf(input_params: SimulationParams):
continue
udf_from_user_variable = user_variable_to_udf(isosurface.field, input_params)
user_variable_udfs[udf_from_user_variable.name] = udf_from_user_variable
return generated_udfs + list(user_variable_udfs.values())
return generated_udfs, list(user_variable_udfs.values())


def translate_streamline_output(output_params: list):
Expand Down Expand Up @@ -1632,14 +1632,19 @@ def get_solver_json(

##:: Step 5: Get user defined fields and auto-generated fields for dimensioned output
translated["userDefinedFields"] = []
# Add auto-generated UDFs for dimensioned fields
generated_udfs = process_output_fields_for_udf(input_params)
# Add auto-generated UDFs for dimensioned fields + user variable UDFs
generated_udfs, user_variable_udfs = process_output_fields_for_udf(input_params)

# Add user-specified UDFs and auto-generated UDFs for dimensioned fields
for udf in [*input_params.user_defined_fields, *generated_udfs]:
legacy_udf_count = len(input_params.user_defined_fields) + len(generated_udfs)
for udf_count, udf in enumerate(
[*input_params.user_defined_fields, *generated_udfs, *user_variable_udfs]
):
udf_dict = {}
udf_dict["name"] = udf.name
udf_dict["expression"] = udf.expression
if udf_count < legacy_udf_count:
udf_dict["from_user_variables"] = False
translated["userDefinedFields"].append(udf_dict)

translated["userDefinedFields"].sort(key=lambda udf: udf["name"])
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/ref/value_or_expression/angular_velocity_with_expression.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@
"userDefinedFields": [
{
"name": "velocity_magnitude",
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;"
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/ref/value_or_expression/liquid_op_vel_mag.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@
"userDefinedFields": [
{
"name": "velocity_magnitude",
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;"
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/ref/value_or_expression/ref_area_with_expression.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@
"userDefinedFields": [
{
"name": "velocity_magnitude",
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;"
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/ref/value_or_expression/time_stepping_with_expression.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@
"userDefinedFields": [
{
"name": "velocity_magnitude",
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;"
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/translator/ref/Flow360_liquid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@
"userDefinedFields": [
{
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"name": "velocity_magnitude"
"name": "velocity_magnitude",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/translator/ref/Flow360_liquid_rotation_dd.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@
"userDefinedFields": [
{
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"name": "velocity_magnitude"
"name": "velocity_magnitude",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": true,
Expand Down
3 changes: 2 additions & 1 deletion tests/simulation/translator/ref/Flow360_udf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@
"userDefinedFields": [
{
"name": "CpT",
"expression": "C-p*T"
"expression": "C-p*T",
"from_user_variables": false
}
],
"usingLiquidAsMaterial": false,
Expand Down
1 change: 1 addition & 0 deletions tests/simulation/translator/ref/Flow360_user_variable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,7 @@
},
{
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": false,
"name": "velocity_magnitude"
},
{
Expand Down
17 changes: 15 additions & 2 deletions tests/simulation/translator/test_output_translation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1343,18 +1343,21 @@ def test_dimensioned_output_fields_translation(vel_in_km_per_hr):

ref = {
"userDefinedFields": [
{"name": "my_field", "expression": "1+1"},
{"name": "my_field", "expression": "1+1", "from_user_variables": False},
{
"name": "pressure",
"expression": "double gamma = 1.4;pressure = (usingLiquidAsMaterial) ? (primitiveVars[4] - 1.0 / gamma) * (velocityScale * velocityScale) : primitiveVars[4];",
"from_user_variables": False,
},
{
"name": "pressure_pa",
"expression": "double pressure;double gamma = 1.4;pressure = (usingLiquidAsMaterial) ? (primitiveVars[4] - 1.0 / gamma) * (velocityScale * velocityScale) : primitiveVars[4];pressure_pa = pressure * 2500000.0;",
"from_user_variables": False,
},
{
"name": "velocity",
"expression": "velocity[0] = primitiveVars[1] * velocityScale;velocity[1] = primitiveVars[2] * velocityScale;velocity[2] = primitiveVars[3] * velocityScale;",
"from_user_variables": False,
},
{
"name": "velocity_in_km_per_hr",
Expand All @@ -1363,44 +1366,54 @@ def test_dimensioned_output_fields_translation(vel_in_km_per_hr):
{
"name": "velocity_m_per_s",
"expression": "double velocity[3];velocity[0] = primitiveVars[1] * velocityScale;velocity[1] = primitiveVars[2] * velocityScale;velocity[2] = primitiveVars[3] * velocityScale;velocity_m_per_s[0] = velocity[0] * 50.0;velocity_m_per_s[1] = velocity[1] * 50.0;velocity_m_per_s[2] = velocity[2] * 50.0;",
"from_user_variables": False,
},
{
"name": "velocity_magnitude",
"expression": "double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;",
"from_user_variables": False,
},
{
"name": "velocity_magnitude_m_per_s",
"expression": "double velocity_magnitude;double velocity[3];velocity[0] = primitiveVars[1];velocity[1] = primitiveVars[2];velocity[2] = primitiveVars[3];velocity_magnitude = magnitude(velocity) * velocityScale;velocity_magnitude_m_per_s = velocity_magnitude * 50.0;",
"from_user_variables": False,
},
{
"name": "velocity_x_m_per_s",
"expression": "double velocity_x;velocity_x = primitiveVars[1] * velocityScale;velocity_x_m_per_s = velocity_x * 50.0;",
"from_user_variables": False,
},
{
"name": "velocity_y_m_per_s",
"expression": "double velocity_y;velocity_y = primitiveVars[2] * velocityScale;velocity_y_m_per_s = velocity_y * 50.0;",
"from_user_variables": False,
},
{
"name": "velocity_z_m_per_s",
"expression": "double velocity_z;velocity_z = primitiveVars[3] * velocityScale;velocity_z_m_per_s = velocity_z * 50.0;",
"from_user_variables": False,
},
{
"name": "vorticity_y",
"expression": "vorticity_y = (gradPrimitive[1][2] - gradPrimitive[3][0]) * velocityScale;",
"from_user_variables": False,
},
{
"name": "wall_shear_stress_magnitude",
"expression": "wall_shear_stress_magnitude = magnitude(wallShearStress) * (velocityScale * velocityScale);",
"from_user_variables": False,
},
{
"name": "wall_shear_stress_magnitude_pa",
"expression": "double wall_shear_stress_magnitude;wall_shear_stress_magnitude = magnitude(wallShearStress) * (velocityScale * velocityScale);wall_shear_stress_magnitude_pa = wall_shear_stress_magnitude * 2500000.0;",
"from_user_variables": False,
},
]
}

print(json.dumps(solver_json["userDefinedFields"], indent=2))
translated_udfs = sorted(solver_json["userDefinedFields"], key=lambda x: x["name"])
ref_udfs = sorted(ref["userDefinedFields"], key=lambda x: x["name"])
print(">>>", translated_udfs)
assert compare_values(translated_udfs, ref_udfs)


Expand Down
Loading