Refactor material mapping interface

Author: andrzej-krupka

flow360/__init__.py

@@ -149,6 +149,7 @@
     MovingStatistic,
     Observer,
     ProbeOutput,
+    RenderOutputGroup,
     RenderOutput,
     SliceOutput,
     StreamlineOutput,

flow360/component/simulation/outputs/output_render_types.py

@@ -10,7 +10,6 @@
 from flow360.component.types import Color, Vector
 
 
-
 class StaticCamera(Flow360BaseModel):
     position: LengthType.Point = pd.Field(description="Position of the camera in the scene")
     target: LengthType.Point = pd.Field(description="Target point of the camera")
@@ -243,7 +242,7 @@ def rainbow(cls, field, min=0, max=1, alpha=1):
         )
 
 
-AllMaterialTypes = Union[PBRMaterial, FieldMaterial]
+AnyMaterial = Union[PBRMaterial, FieldMaterial]
 
 
 class Transform(Flow360BaseModel):

flow360/component/simulation/outputs/outputs.py

@@ -33,7 +33,7 @@
     get_field_values,
 )
 from flow360.component.simulation.outputs.output_render_types import (
-    AllMaterialTypes,
+    AnyMaterial,
     RenderCameraConfig,
     RenderEnvironmentConfig,
     RenderLightingConfig,
@@ -672,6 +672,19 @@ def allow_only_simulation_surfaces_or_imported_surfaces(cls, value):
         return value
 
 
+class RenderOutputGroup(Flow360BaseModel):
+    surfaces: Optional[EntityList[Surface]] = pd.Field(
+        None, description="List of of :class:`~flow360.Surface` entities."
+    )
+    slices: Optional[EntityList[Slice]] = pd.Field(
+        None, description="List of of :class:`~flow360.Slice` entities."
+    )
+    isosurfaces: Optional[UniqueItemList[Isosurface]] = pd.Field(
+        None, description="List of :class:`~flow360.Isosurface` entities."
+    )
+    material: AnyMaterial = pd.Field()
+
+
 class RenderOutput(_AnimationSettings):
     """
 
@@ -701,23 +714,14 @@ class RenderOutput(_AnimationSettings):
     ====
     """
 
-    name: Optional[str] = pd.Field("Render output", description="Name of the `IsosurfaceOutput`.")
-    surfaces: Optional[EntityList[Surface]] = pd.Field(
-        None, description="List of of :class:`~flow360.Surface` entities."
-    )
-    slices: Optional[EntityList[Slice]] = pd.Field(
-        None, description="List of of :class:`~flow360.Slice` entities."
-    )
-    isosurfaces: Optional[UniqueItemList[Isosurface]] = pd.Field(
-        None, description="List of :class:`~flow360.Isosurface` entities."
-    )
+    name: str = pd.Field("Render output", description="Name of the `RenderOutput`.")
+    groups: List[RenderOutputGroup] = pd.Field("Render groups")
     output_fields: UniqueItemList[Union[CommonFieldNames, str]] = pd.Field(
         [], description="List of output variables."
     )
     camera: RenderCameraConfig = pd.Field(description="Camera settings", default_factory=RenderCameraConfig.orthographic)
     lighting: RenderLightingConfig = pd.Field(description="Lighting settings", default_factory=RenderLightingConfig.default)
     environment: RenderEnvironmentConfig = pd.Field(description="Environment settings", default_factory=RenderEnvironmentConfig.simple)
-    materials: Dict[str, AllMaterialTypes] = pd.Field(description="Material settings per entity")
     transform: Optional[Transform] = pd.Field(None, description="Optional model transform to apply to all entities")
     output_type: Literal["RenderOutput"] = pd.Field("RenderOutput", frozen=True)
 

flow360/component/simulation/translator/solver_translator.py

@@ -82,7 +82,7 @@
     TimeAverageSurfaceProbeOutput,
     TimeAverageVolumeOutput,
     UserDefinedField,
-    VolumeOutput,
+    VolumeOutput, RenderOutputGroup,
 )
 from flow360.component.simulation.primitives import (
     BOUNDARY_FULL_NAME_WHEN_NOT_FOUND,
@@ -113,7 +113,6 @@
     replace_dict_key,
     translate_setting_and_apply_to_all_entities,
     translate_value_or_expression_object,
-    update_dict_recursively,
 )
 from flow360.component.simulation.unit_system import LengthType
 from flow360.component.simulation.user_code.core.types import (
@@ -596,56 +595,51 @@ def translate_render_output(
             exclude_none=True, exclude_unset=True, by_alias=True
         )
 
-        materials = {}
-
-        for name, material in render.materials.items():
-            material = material.model_dump(exclude_none=True, exclude_unset=True, by_alias=True) 
-            materials[name] = material
-
+        for render_group in render.groups:
+            material = render_group.material.model_dump(exclude_none=True, exclude_unset=True, by_alias=True) 
             if "outputField" in material and material["outputField"] not in render.output_fields:
-                print(f"Adding material field: {material['outputField']}")
-                render.output_fields.append(material["outputField"])            
-
-        print(f"Render output fields are: {render.output_fields}")
-
-        print(f"Materials are: {materials}")
+                render.output_fields.append(material["outputField"])
 
         translated_output = {
+            "name": render.name,
             "animationFrequency": render.frequency,
             "animationFrequencyOffset": render.frequency_offset,
-            "surfaces": translate_setting_and_apply_to_all_entities(
-                [render],
-                RenderOutput,
-                translation_func=translate_output_fields,
-                to_list=False,
-                entity_type_to_include=Surface,
-                entity_list_attribute_name="surfaces"
-            ),
-            "slices": translate_setting_and_apply_to_all_entities(
-                [render],
-                RenderOutput,
-                translation_func=translate_output_fields,
-                to_list=False,
-                entity_injection_func=slice_injection_function,
-                entity_type_to_include=Slice,
-                entity_list_attribute_name="slices"
-            ),
-            "isoSurfaces": translate_setting_and_apply_to_all_entities(
-                [render],
-                RenderOutput,
-                translation_func=translate_output_fields,
-                to_list=False,
-                entity_injection_func=isosurface_injection_function,
-                entity_type_to_include=Isosurface,
-                entity_list_attribute_name="isosurfaces",
-                entity_injection_input_params=input_params,
-            ),
+            "groups": [],
             "camera": remove_units_in_dict(camera),
             "lighting": remove_units_in_dict(lighting),
             "environment": remove_units_in_dict(environment),
-            "materials": remove_units_in_dict(materials),
+            "outputFields": translate_output_fields(render)["outputFields"]
         }
 
+        for render_group in render.groups:
+            material = render_group.material.model_dump(exclude_none=True, exclude_unset=True, by_alias=True)
+            translated_output["groups"].append({
+                "surfaces": translate_setting_and_apply_to_all_entities(
+                    [render_group],
+                    RenderOutputGroup,
+                    to_list=False,
+                    entity_type_to_include=Surface,
+                    entity_list_attribute_name="surfaces"
+                ),
+                "slices": translate_setting_and_apply_to_all_entities(
+                    [render_group],
+                    RenderOutputGroup,
+                    to_list=False,
+                    entity_injection_func=slice_injection_function,
+                    entity_type_to_include=Slice,
+                    entity_list_attribute_name="slices"
+                ),
+                "isoSurfaces": translate_setting_and_apply_to_all_entities(
+                    [render_group],
+                    RenderOutputGroup,
+                    to_list=False,
+                    entity_injection_func=isosurface_injection_function,
+                    entity_type_to_include=Isosurface,
+                    entity_list_attribute_name="isosurfaces",
+                    entity_injection_input_params=input_params,
+                ),
+                "material": remove_units_in_dict(material)
+            })
         if render.transform:
             transform = render.transform.model_dump(
                 exclude_none=True, exclude_unset=True, by_alias=True

flow360/component/simulation/translator/utils.py

@@ -278,7 +278,7 @@ def _get_key_name(entity: EntityBase):
 def translate_setting_and_apply_to_all_entities(
     obj_list: list,
     class_type,
-    translation_func,
+    translation_func=lambda x, **kwargs: {},
     to_list: bool = False,
     entity_injection_func=lambda x, **kwargs: {},
     pass_translated_setting_to_entity_injection=False,