Skip to content

fix(): use params entity registry for update_persistent_entities #1898

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
Mar 16, 2026
Merged

fix(): use params entity registry for update_persistent_entities #1898

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
836b060
fix(): use params entity registry for update_persistent_entities in l…
benflexcompute Mar 14, 2026
9b3cbf1
Addressed comment
benflexcompute Mar 16, 2026
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
33 changes: 30 additions & 3 deletions flow360/component/project_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
)
from flow360.component.simulation.framework.base_model import Flow360BaseModel
from flow360.component.simulation.framework.entity_base import EntityList
from flow360.component.simulation.framework.entity_registry import EntityRegistry
from flow360.component.simulation.framework.param_utils import AssetCache
from flow360.component.simulation.outputs.outputs import (
SurfaceIntegralOutput,
Expand Down Expand Up @@ -498,6 +499,31 @@ def _set_up_default_reference_geometry(params: SimulationParams, length_unit: Le
return params


def _build_deduplicated_entity_registry_from_params(params: SimulationParams) -> EntityRegistry:
"""
Build a deduplicated entity registry from params' stored entities.

params.used_entity_registry may contain duplicates (same entity used in multiple
models/outputs). This function deduplicates by (entity_type, identifier), where
identifier is private_attribute_id when available, falling back to entity name
to avoid collapsing distinct entities that share a None id.
"""
registry = EntityRegistry()
seen_keys = set()
for entity_type, entities in params.used_entity_registry.internal_registry.items():
for entity in entities:
identifier = (
entity.private_attribute_id
if entity.private_attribute_id is not None
else entity.name
)
key = (entity_type, identifier)
if key not in seen_keys:
registry.register(entity)
seen_keys.add(key)
return registry


def set_up_params_for_uploading( # pylint: disable=too-many-arguments
root_asset,
length_unit: LengthType,
Expand Down Expand Up @@ -557,12 +583,13 @@ def set_up_params_for_uploading( # pylint: disable=too-many-arguments
# Legacy workflow (without DraftContext): use root_asset.entity_info
# User may have made modifications to the entities which is recorded in asset's entity registry
# We need to reflect these changes.
root_asset.entity_info.update_persistent_entities(
asset_entity_registry=root_asset.internal_registry
entity_info = root_asset.entity_info
entity_info.update_persistent_entities(
asset_entity_registry=_build_deduplicated_entity_registry_from_params(params)
)

# Check if there are any new draft entities that have been added in the params by the user
entity_info = _set_up_params_non_persistent_entity_info(root_asset.entity_info, params)
entity_info = _set_up_params_non_persistent_entity_info(entity_info, params)

# If the customer just load the param without re-specify the same set of entity grouping tags,
# we need to update the entity grouping tags to the ones in the SimulationParams.
Expand Down
2 changes: 1 addition & 1 deletion tests/data/mock_webapi/project_from_vm_volume_mesh_simulation_json_resp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"data": {
"simulationJson": "{\"version\": \"25.2.1\", \"unit_system\": {\"name\": \"SI\"}, \"reference_geometry\": {\"moment_center\": {\"value\": [0.0, 0.0, 0.0], \"units\": \"m\"}, \"moment_length\": {\"value\": [1.0, 1.0, 1.0], \"units\": \"m\"}, \"area\": {\"value\": 1.0, \"units\": \"m**2\"}}, \"operating_condition\": {\"type_name\": \"AerospaceCondition\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {\"alpha\": {\"value\": 0.0, \"units\": \"degree\"}, \"beta\": {\"value\": 0.0, \"units\": \"degree\"}, \"thermal_state\": {\"type_name\": \"ThermalState\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {}, \"temperature\": {\"value\": 288.15, \"units\": \"K\"}, \"density\": {\"value\": 1.225, \"units\": \"kg/m**3\"}, \"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}}}, \"alpha\": {\"value\": 0.0, \"units\": \"degree\"}, \"beta\": {\"value\": 0.0, \"units\": \"degree\"}, \"thermal_state\": {\"type_name\": \"ThermalState\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {}, \"temperature\": {\"value\": 288.15, \"units\": \"K\"}, \"density\": {\"value\": 1.225, \"units\": \"kg/m**3\"}, \"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}}}, \"models\": [{\"type\": \"Wall\", \"entities\": {\"stored_entities\": []}, \"name\": \"Wall\", \"use_wall_function\": false, \"heat_spec\": {\"value\": {\"value\": 0.0, \"units\": \"W/m**2\"}, \"type_name\": \"HeatFlux\"}, \"roughness_height\": {\"value\": 0.0, \"units\": \"m\"}}, {\"type\": \"Freestream\", \"entities\": {\"stored_entities\": []}, \"name\": \"Freestream\"}, {\"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}, \"initial_condition\": {\"type_name\": \"NavierStokesInitialCondition\", \"rho\": \"rho\", \"u\": \"u\", \"v\": \"v\", \"w\": \"w\", \"p\": \"p\"}, \"type\": \"Fluid\", \"navier_stokes_solver\": {\"absolute_tolerance\": 1e-10, \"relative_tolerance\": 0.0, \"order_of_accuracy\": 2, \"equation_evaluation_frequency\": 1, \"linear_solver\": {\"max_iterations\": 30}, \"CFL_multiplier\": 1.0, \"kappa_MUSCL\": -1.0, \"numerical_dissipation_factor\": 1.0, \"limit_velocity\": false, \"limit_pressure_density\": false, \"type_name\": \"Compressible\", \"low_mach_preconditioner\": false, \"update_jacobian_frequency\": 4, \"max_force_jac_update_physical_steps\": 0}, \"turbulence_model_solver\": {\"absolute_tolerance\": 1e-08, \"relative_tolerance\": 0.0, \"order_of_accuracy\": 2, \"equation_evaluation_frequency\": 4, \"linear_solver\": {\"max_iterations\": 20}, \"CFL_multiplier\": 2.0, \"type_name\": \"SpalartAllmaras\", \"reconstruction_gradient_limiter\": 0.5, \"quadratic_constitutive_relation\": false, \"modeling_constants\": {\"type_name\": \"SpalartAllmarasConsts\", \"C_DES\": 0.72, \"C_d\": 8.0, \"C_cb1\": 0.1355, \"C_cb2\": 0.622, \"C_sigma\": 0.6666666666666666, \"C_v1\": 7.1, \"C_vonKarman\": 0.41, \"C_w2\": 0.3, \"C_t3\": 1.2, \"C_t4\": 0.5, \"C_min_rd\": 10.0}, \"update_jacobian_frequency\": 4, \"max_force_jac_update_physical_steps\": 0, \"rotation_correction\": false}, \"transition_model_solver\": {\"type_name\": \"None\"}}], \"time_stepping\": {\"type_name\": \"Steady\", \"max_steps\": 2000, \"CFL\": {\"type\": \"adaptive\", \"min\": 0.1, \"max\": 10000.0, \"max_relative_change\": 1.0, \"convergence_limiting_factor\": 0.25}}, \"user_defined_fields\": [], \"outputs\": [{\"frequency\": -1, \"frequency_offset\": 0, \"output_format\": \"paraview\", \"name\": \"Surface output\", \"entities\": {\"stored_entities\": [{\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"name\": \"*\", \"private_attribute_sub_components\": []}]}, \"write_single_file\": false, \"output_fields\": {\"items\": [\"Cp\", \"yPlus\", \"Cf\", \"CfVec\"]}, \"output_type\": \"SurfaceOutput\"}], \"private_attribute_asset_cache\": {\"project_length_unit\": {\"value\": 1.0, \"units\": \"m\"}, \"project_entity_info\": {\"type_name\": \"VolumeMeshEntityInfo\", \"zones\": [{\"private_attribute_registry_bucket_name\": \"VolumetricEntityType\", \"private_attribute_entity_type_name\": \"GenericVolume\", \"private_attribute_id\": null, \"name\": \"fluid\", \"private_attribute_zone_boundary_names\": {\"items\": [\"fluid/Interface_solid\", \"fluid/centerbody\", \"fluid/farfield\"]}, \"private_attribute_full_name\": \"fluid\", \"axes\": null, \"axis\": null, \"center\": null}, {\"private_attribute_registry_bucket_name\": \"VolumetricEntityType\", \"private_attribute_entity_type_name\": \"GenericVolume\", \"private_attribute_id\": null, \"name\": \"solid\", \"private_attribute_zone_boundary_names\": {\"items\": [\"solid/Interface_fluid\", \"solid/adiabatic\"]}, \"private_attribute_full_name\": \"solid\", \"axes\": null, \"axis\": null, \"center\": null}], \"boundaries\": [{\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/farfield\", \"private_attribute_full_name\": \"fluid/farfield\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"solid/Interface_fluid\", \"private_attribute_full_name\": \"solid/Interface_fluid\", \"private_attribute_is_interface\": true, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/centerbody\", \"private_attribute_full_name\": \"fluid/centerbody\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"solid/adiabatic\", \"private_attribute_full_name\": \"solid/adiabatic\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/Interface_solid\", \"private_attribute_full_name\": \"fluid/Interface_solid\", \"private_attribute_is_interface\": true, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}]}}}"
"simulationJson": "{\"version\": \"25.2.1\", \"unit_system\": {\"name\": \"SI\"}, \"reference_geometry\": {\"moment_center\": {\"value\": [0.0, 0.0, 0.0], \"units\": \"m\"}, \"moment_length\": {\"value\": [1.0, 1.0, 1.0], \"units\": \"m\"}, \"area\": {\"value\": 1.0, \"units\": \"m**2\"}}, \"operating_condition\": {\"type_name\": \"AerospaceCondition\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {\"alpha\": {\"value\": 0.0, \"units\": \"degree\"}, \"beta\": {\"value\": 0.0, \"units\": \"degree\"}, \"thermal_state\": {\"type_name\": \"ThermalState\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {}, \"temperature\": {\"value\": 288.15, \"units\": \"K\"}, \"density\": {\"value\": 1.225, \"units\": \"kg/m**3\"}, \"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}}}, \"alpha\": {\"value\": 0.0, \"units\": \"degree\"}, \"beta\": {\"value\": 0.0, \"units\": \"degree\"}, \"thermal_state\": {\"type_name\": \"ThermalState\", \"private_attribute_constructor\": \"default\", \"private_attribute_input_cache\": {}, \"temperature\": {\"value\": 288.15, \"units\": \"K\"}, \"density\": {\"value\": 1.225, \"units\": \"kg/m**3\"}, \"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}}}, \"models\": [{\"type\": \"Wall\", \"entities\": {\"stored_entities\": []}, \"name\": \"Wall\", \"use_wall_function\": false, \"heat_spec\": {\"value\": {\"value\": 0.0, \"units\": \"W/m**2\"}, \"type_name\": \"HeatFlux\"}, \"roughness_height\": {\"value\": 0.0, \"units\": \"m\"}}, {\"type\": \"Freestream\", \"entities\": {\"stored_entities\": []}, \"name\": \"Freestream\"}, {\"material\": {\"type\": \"air\", \"name\": \"air\", \"dynamic_viscosity\": {\"reference_viscosity\": {\"value\": 1.716e-05, \"units\": \"Pa*s\"}, \"reference_temperature\": {\"value\": 273.15, \"units\": \"K\"}, \"effective_temperature\": {\"value\": 110.4, \"units\": \"K\"}}}, \"initial_condition\": {\"type_name\": \"NavierStokesInitialCondition\", \"rho\": \"rho\", \"u\": \"u\", \"v\": \"v\", \"w\": \"w\", \"p\": \"p\"}, \"type\": \"Fluid\", \"navier_stokes_solver\": {\"absolute_tolerance\": 1e-10, \"relative_tolerance\": 0.0, \"order_of_accuracy\": 2, \"equation_evaluation_frequency\": 1, \"linear_solver\": {\"max_iterations\": 30}, \"CFL_multiplier\": 1.0, \"kappa_MUSCL\": -1.0, \"numerical_dissipation_factor\": 1.0, \"limit_velocity\": false, \"limit_pressure_density\": false, \"type_name\": \"Compressible\", \"low_mach_preconditioner\": false, \"update_jacobian_frequency\": 4, \"max_force_jac_update_physical_steps\": 0}, \"turbulence_model_solver\": {\"absolute_tolerance\": 1e-08, \"relative_tolerance\": 0.0, \"order_of_accuracy\": 2, \"equation_evaluation_frequency\": 4, \"linear_solver\": {\"max_iterations\": 20}, \"CFL_multiplier\": 2.0, \"type_name\": \"SpalartAllmaras\", \"reconstruction_gradient_limiter\": 0.5, \"quadratic_constitutive_relation\": false, \"modeling_constants\": {\"type_name\": \"SpalartAllmarasConsts\", \"C_DES\": 0.72, \"C_d\": 8.0, \"C_cb1\": 0.1355, \"C_cb2\": 0.622, \"C_sigma\": 0.6666666666666666, \"C_v1\": 7.1, \"C_vonKarman\": 0.41, \"C_w2\": 0.3, \"C_t3\": 1.2, \"C_t4\": 0.5, \"C_min_rd\": 10.0}, \"update_jacobian_frequency\": 4, \"max_force_jac_update_physical_steps\": 0, \"rotation_correction\": false}, \"transition_model_solver\": {\"type_name\": \"None\"}}], \"time_stepping\": {\"type_name\": \"Steady\", \"max_steps\": 2000, \"CFL\": {\"type\": \"adaptive\", \"min\": 0.1, \"max\": 10000.0, \"max_relative_change\": 1.0, \"convergence_limiting_factor\": 0.25}}, \"user_defined_fields\": [], \"outputs\": [{\"frequency\": -1, \"frequency_offset\": 0, \"output_format\": \"paraview\", \"name\": \"Surface output\", \"entities\": {\"stored_entities\": [{\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"name\": \"*\", \"private_attribute_sub_components\": []}]}, \"write_single_file\": false, \"output_fields\": {\"items\": [\"Cp\", \"yPlus\", \"Cf\", \"CfVec\"]}, \"output_type\": \"SurfaceOutput\"}], \"private_attribute_asset_cache\": {\"project_length_unit\": {\"value\": 1.0, \"units\": \"m\"}, \"project_entity_info\": {\"type_name\": \"VolumeMeshEntityInfo\", \"zones\": [{\"private_attribute_registry_bucket_name\": \"VolumetricEntityType\", \"private_attribute_entity_type_name\": \"GenericVolume\", \"private_attribute_id\": \"fluid\", \"name\": \"fluid\", \"private_attribute_zone_boundary_names\": {\"items\": [\"fluid/Interface_solid\", \"fluid/centerbody\", \"fluid/farfield\"]}, \"private_attribute_full_name\": \"fluid\", \"axes\": null, \"axis\": null, \"center\": null}, {\"private_attribute_registry_bucket_name\": \"VolumetricEntityType\", \"private_attribute_entity_type_name\": \"GenericVolume\", \"private_attribute_id\": \"solid\", \"name\": \"solid\", \"private_attribute_zone_boundary_names\": {\"items\": [\"solid/Interface_fluid\", \"solid/adiabatic\"]}, \"private_attribute_full_name\": \"solid\", \"axes\": null, \"axis\": null, \"center\": null}], \"boundaries\": [{\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/farfield\", \"private_attribute_full_name\": \"fluid/farfield\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"solid/Interface_fluid\", \"private_attribute_full_name\": \"solid/Interface_fluid\", \"private_attribute_is_interface\": true, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/centerbody\", \"private_attribute_full_name\": \"fluid/centerbody\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"solid/adiabatic\", \"private_attribute_full_name\": \"solid/adiabatic\", \"private_attribute_is_interface\": false, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}, {\"private_attribute_registry_bucket_name\": \"SurfaceEntityType\", \"private_attribute_entity_type_name\": \"Surface\", \"private_attribute_id\": null, \"name\": \"fluid/Interface_solid\", \"private_attribute_full_name\": \"fluid/Interface_solid\", \"private_attribute_is_interface\": true, \"private_attribute_tag_key\": null, \"private_attribute_sub_components\": []}]}}}"
}
}
33 changes: 33 additions & 0 deletions tests/simulation/test_project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,39 @@ def test_root_asset_entity_change_reflection(mock_id, mock_response):
== "red"
)

# VolumeMesh: verify zone center/axis modifications flow through set_up_params_for_uploading
# Simulate the customer scenario where self.volume is a DIFFERENT Python object than project._root_asset
project_vm = fl.Project.from_cloud(project_id="prj-99cc6f96-15d3-4170-973c-a0cced6bf36b")
separate_vm = VolumeMeshV2.from_cloud(id="vm-bff35714-41b1-4251-ac74-46a40b95a330")
assert separate_vm is not project_vm._root_asset

zone = separate_vm["fluid"]
zone.center = (1.2, 2.3, 3.4) * u.m
zone.axis = (0, 1, 0)

with fl.SI_unit_system:
vm_params = fl.SimulationParams(
models=[
fl.Rotation(
name="testRotation",
volumes=[zone],
spec=fl.AngularVelocity(100 * fl.u.rpm),
),
],
)
vm_params = set_up_params_for_uploading(
params=vm_params,
root_asset=project_vm._root_asset,
length_unit=project_vm.length_unit,
use_beta_mesher=False,
use_geometry_AI=False,
)

entity_info = vm_params.private_attribute_asset_cache.project_entity_info
fluid_zone = next(z for z in entity_info.zones if z.name == "fluid")
assert all(fluid_zone.center == [1.2, 2.3, 3.4] * u.m)
assert fluid_zone.axis == (0, 1, 0)


def test_get_asset_with_id(mock_id, mock_response):
project = fl.Project.from_cloud(project_id="prj-41d2333b-85fd-4bed-ae13-15dcb6da519e")
Expand Down
Loading