Refactor render interface after MC meeting

Author: andrzej-krupka

flow360/__init__.py

@@ -137,7 +137,6 @@
     RenderCameraConfig,
     RenderEnvironmentConfig,
     RenderLightingConfig,
-    RenderMaterialConfig,
     SkyboxBackground,
     SkyboxTexture,
     SolidBackground,

flow360/component/simulation/outputs/output_render_types.py

@@ -244,12 +244,7 @@ def rainbow(cls, field, min=0, max=1, alpha=1):
 
 
 AllMaterialTypes = Union[PBRMaterial, FieldMaterial]
-
-
-class RenderMaterialConfig(Flow360BaseModel):
-    materials: List[AllMaterialTypes] = pd.Field([])
-    mappings: Dict[str, int] = pd.Field({})
-
+    
 
 class Transform(Flow360BaseModel):
     translation: LengthType.Point = pd.Field(default=[0, 0, 0])

flow360/component/simulation/outputs/outputs.py

@@ -6,7 +6,7 @@
 """
 
 # pylint: disable=too-many-lines
-from typing import Annotated, List, Literal, Optional, Union, get_args
+from typing import Annotated, Dict, List, Literal, Optional, Union, get_args
 
 import pydantic as pd
 
@@ -33,10 +33,10 @@
     get_field_values,
 )
 from flow360.component.simulation.outputs.output_render_types import (
+    AllMaterialTypes,
     RenderCameraConfig,
     RenderEnvironmentConfig,
     RenderLightingConfig,
-    RenderMaterialConfig,
     Transform,
 )
 from flow360.component.simulation.primitives import (
@@ -702,20 +702,22 @@ class RenderOutput(_AnimationSettings):
     """
 
     name: Optional[str] = pd.Field("Render output", description="Name of the `IsosurfaceOutput`.")
-    entities: Optional[EntityList[Surface, Slice]] = pd.Field(
-        None, description="List of of :class:`~flow360.Surface` or `~flow360.Slice` entities."
+    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."
     )
     output_fields: UniqueItemList[Union[CommonFieldNames, str]] = pd.Field(
-        description="List of output variables. Including "
-        ":ref:`universal output variables<UniversalVariablesV2>` and :class:`UserDefinedField`."
+        [], 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: RenderMaterialConfig = pd.Field(description="Material settings")
+    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

@@ -97,6 +97,7 @@
 )
 from flow360.component.simulation.simulation_params import SimulationParams
 from flow360.component.simulation.time_stepping.time_stepping import Steady, Unsteady
+from flow360.component.simulation.outputs.output_render_types import FieldMaterial
 from flow360.component.simulation.translator.user_expression_utils import (
     udf_prepending_code,
 )
@@ -594,29 +595,31 @@ def translate_render_output(
         environment = render.environment.model_dump(
             exclude_none=True, exclude_unset=True, by_alias=True
         )
-        materials = render.materials.model_dump(
-            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
+
+            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}")
 
         translated_output = {
             "animationFrequency": render.frequency,
             "animationFrequencyOffset": render.frequency_offset,
-            "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,
-            ),
             "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],
@@ -625,6 +628,17 @@ def translate_render_output(
                 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,
             ),
             "camera": remove_units_in_dict(camera),
             "lighting": remove_units_in_dict(lighting),

tests/simulation/translator/test_solver_translator.py

@@ -72,7 +72,6 @@
     RenderCameraConfig,
     RenderEnvironmentConfig,
     RenderLightingConfig,
-    RenderMaterialConfig,
     SkyboxBackground,
     SkyboxTexture,
     StaticCamera,
@@ -276,17 +275,14 @@ def get_om6Wing_tutorial_param():
                     environment=RenderEnvironmentConfig(
                         background=SkyboxBackground(texture=SkyboxTexture.SKY)
                     ),
-                    materials=RenderMaterialConfig(
-                        materials=[
-                            PBRMaterial(
-                                color=(245, 245, 246),
-                                alpha=1.0,
-                                roughness=0.3,
-                                f0=(0.56, 0.56, 0.56),
-                            )
-                        ],
-                        mappings={"iso": 0},
-                    ),
+                    materials={
+                        "iso": PBRMaterial(
+                            color=(245, 245, 246),
+                            alpha=1.0,
+                            roughness=0.3,
+                            f0=(0.56, 0.56, 0.56),
+                        )
+                    }
                 ),
             ],
         )