Add private_attribute_id to output (#1420)

Co-authored-by: Ben <ben@flexcompute.com>

Author: savithru-flex

flow360/component/simulation/outputs/outputs.py

@@ -14,7 +14,7 @@
     Flow360BaseModel,
     RegistryLookup,
 )
-from flow360.component.simulation.framework.entity_base import EntityList
+from flow360.component.simulation.framework.entity_base import EntityList, generate_uuid
 from flow360.component.simulation.framework.expressions import StringExpression
 from flow360.component.simulation.framework.unique_list import UniqueItemList
 from flow360.component.simulation.models.surface_models import EntityListAllowingGhost
@@ -115,6 +115,7 @@ def _check_redefined_user_defined_fields(cls, value):
 
 class _OutputBase(Flow360BaseModel):
     output_fields: UniqueItemList[str] = pd.Field()
+    private_attribute_id: str = pd.Field(default_factory=generate_uuid, frozen=True)
 
     @pd.field_validator("output_fields", mode="after")
     @classmethod
@@ -1000,6 +1001,7 @@ class AeroAcousticOutput(Flow360BaseModel):
         + "in addition to results for all wall surfaces combined.",
     )
     output_type: Literal["AeroAcousticOutput"] = pd.Field("AeroAcousticOutput", frozen=True)
+    private_attribute_id: str = pd.Field(default_factory=generate_uuid, frozen=True)
 
     @pd.field_validator("observers", mode="after")
     @classmethod
@@ -1105,6 +1107,7 @@ class StreamlineOutput(_OutputBase):
         description="List of output variables. Vector-valued fields will be colored by their magnitude.",
     )
     output_type: Literal["StreamlineOutput"] = pd.Field("StreamlineOutput", frozen=True)
+    private_attribute_id: str = pd.Field(default_factory=generate_uuid, frozen=True)
 
 
 class TimeAverageStreamlineOutput(StreamlineOutput):

tests/simulation/ref/simulation_with_project_variables.json

@@ -202,6 +202,7 @@
                     }
                 ]
             },
+            "private_attribute_id": "000",
             "frequency": -1,
             "frequency_offset": 0,
             "output_format": "paraview",
@@ -217,6 +218,7 @@
                     }
                 ]
             },
+            "private_attribute_id": "222",
             "name": "Probe output",
             "entities": {
                 "stored_entities": [

tests/simulation/service/test_services_v2.py

@@ -706,6 +706,7 @@ def test_init():
     assert data["operating_condition"]["alpha"]["value"] == 0
     assert data["operating_condition"]["alpha"]["units"] == "degree"
     assert "velocity_magnitude" not in data["operating_condition"].keys()
+    data["outputs"][0].pop("private_attribute_id", None)
     # to convert tuples to lists:
     data = json.loads(json.dumps(data))
     compare_dict_to_ref(data, "../../ref/simulation/service_init_geometry.json")
@@ -715,6 +716,7 @@ def test_init():
         unit_system_name="SI", length_unit="m", root_item_type="VolumeMesh"
     )
     assert "meshing" not in data
+    data["outputs"][0].pop("private_attribute_id", None)
     # to convert tuples to lists:
     data = json.loads(json.dumps(data))
     compare_dict_to_ref(data, "../../ref/simulation/service_init_volume_mesh.json")
@@ -729,6 +731,7 @@ def test_init():
     assert data["private_attribute_asset_cache"]["project_length_unit"]["units"] == "cm"
 
     assert data["models"][0]["roughness_height"]["units"] == "cm"
+    data["outputs"][0].pop("private_attribute_id", None)
     # to convert tuples to lists:
     data = json.loads(json.dumps(data))
     compare_dict_to_ref(data, "../../ref/simulation/service_init_surface_mesh.json")

tests/simulation/test_expressions.py

@@ -861,13 +861,15 @@ def test_project_variables_serialization():
                 VolumeOutput(
                     output_fields=[
                         bbb,
-                    ]
+                    ],
+                    private_attribute_id="000",
                 ),
                 ProbeOutput(
                     probe_points=[
                         Point(name="pt1", location=(1, 2, 3), private_attribute_id="111")
                     ],
                     output_fields=[bbb],
+                    private_attribute_id="222",
                 ),
             ],
         )