Added basic data models for render output

Author: Andrzej Krupka

flow360/component/simulation/outputs/output_entities.py

@@ -1,15 +1,15 @@
 """Output for simulation."""
 
 from abc import ABCMeta
-from typing import Literal, Union
+from typing import Literal, Union, Optional
 
 import pydantic as pd
 
 from flow360.component.simulation.framework.base_model import Flow360BaseModel
 from flow360.component.simulation.framework.entity_base import EntityBase, generate_uuid
 from flow360.component.simulation.outputs.output_fields import IsoSurfaceFieldNames
-from flow360.component.simulation.unit_system import LengthType
-from flow360.component.types import Axis
+from flow360.component.simulation.unit_system import LengthType, AngleType
+from flow360.component.types import Axis, Vector, Color
 
 
 class _OutputItemBase(Flow360BaseModel):
@@ -178,3 +178,63 @@ class PointArray2D(_PointEntityBase):
     v_axis_vector: LengthType.Axis = pd.Field(description="The scaled v-axis of the parallelogram.")
     u_number_of_points: int = pd.Field(ge=2, description="The number of points along the u axis.")
     v_number_of_points: int = pd.Field(ge=2, description="The number of points along the v axis.")
+
+
+# Linear interpolation between keyframes
+class KeyframeCamera(Flow360BaseModel):
+    pass
+
+
+# Follow a cubic spline curve
+class SplineCamera(Flow360BaseModel):
+    pass
+
+
+# Orbit a point (start and end points specified in spherical coordinates)
+class OrbitCamera(Flow360BaseModel):
+    pass
+
+
+# Static camera setup in Cartesian coordinates
+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")
+    up: Optional[Vector] = pd.Field((0, 1, 0), description="Up vector, if not specified assume Y+")
+
+
+# Ortho projection, parallel lines stay parallel
+class OrthographicProjection(Flow360BaseModel):
+    width: LengthType = pd.Field()
+    near: LengthType = pd.Field()
+    far: LengthType = pd.Field()
+
+
+# Perspective projection
+class PerspectiveProjection(Flow360BaseModel):
+    fov: AngleType = pd.Field()
+    near: LengthType = pd.Field()
+    far: LengthType = pd.Field()
+
+
+# Only basic static camera with ortho projection supported currently
+class RenderCameraConfig(Flow360BaseModel):
+    view: StaticCamera = pd.Field()
+    projection: OrthographicProjection = pd.Field()
+
+
+# Ambient light, added by default to all pixels in the scene, simulates global illumination
+class AmbientLight(Flow360BaseModel):
+    intensity: float = pd.Field()
+    color: Color = pd.Field()
+
+
+# Ambient light, added by default to all pixels in the scene, simulates global illumination
+class DirectionalLight(Flow360BaseModel):
+    intensity: float = pd.Field()
+    color: Color = pd.Field()
+    direction: Vector = pd.Field()
+
+
+class RenderLightingConfig(Flow360BaseModel):
+    ambient: AmbientLight = pd.Field()
+    directional: DirectionalLight = pd.Field()

flow360/component/simulation/outputs/outputs.py

@@ -19,7 +19,7 @@
     Point,
     PointArray,
     PointArray2D,
-    Slice,
+    Slice, RenderCameraConfig, RenderLightingConfig,
 )
 from flow360.component.simulation.outputs.output_fields import (
     AllFieldNames,
@@ -463,6 +463,51 @@ def ensure_surface_existence(cls, value):
         return check_deleted_surface_in_entity_list(value)
 
 
+class RenderOutput(_AnimationSettings):
+    """
+
+    :class:`RenderOutput` class for backend rendered output settings.
+
+    Example
+    -------
+
+    Define the :class:`RenderOutput` of :code:`qcriterion` on two isosurfaces:
+
+    >>> fl.RenderOutput(
+    ...     isosurfaces=[
+    ...         fl.Isosurface(
+    ...             name="Isosurface_T_0.1",
+    ...             iso_value=0.1,
+    ...             field="T",
+    ...         ),
+    ...         fl.Isosurface(
+    ...             name="Isosurface_p_0.5",
+    ...             iso_value=0.5,
+    ...             field="p",
+    ...         ),
+    ...     ],
+    ...     output_field="qcriterion",
+    ... )
+
+    ====
+    """
+
+    name: Optional[str] = pd.Field(
+        "Render output", description="Name of the `IsosurfaceOutput`."
+    )
+    entities: UniqueItemList[Isosurface] = pd.Field(
+        alias="isosurfaces",
+        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`."
+    )
+    camera: RenderCameraConfig = pd.Field(description="Camera settings")
+    lighting: RenderLightingConfig = pd.Field(description="Lighting settings")
+    output_type: Literal["RenderOutput"] = pd.Field("RenderOutput", frozen=True)
+
+
 class ProbeOutput(_OutputBase):
     """
     :class:`ProbeOutput` class for setting output data probed at monitor points.
@@ -999,6 +1044,7 @@ class StreamlineOutput(Flow360BaseModel):
         TimeAverageSurfaceProbeOutput,
         AeroAcousticOutput,
         StreamlineOutput,
+        RenderOutput
     ],
     pd.Field(discriminator="output_type"),
 ]

flow360/component/simulation/translator/solver_translator.py

@@ -68,7 +68,7 @@
     TimeAverageSurfaceProbeOutput,
     TimeAverageVolumeOutput,
     UserDefinedField,
-    VolumeOutput,
+    VolumeOutput, RenderOutput,
 )
 from flow360.component.simulation.primitives import Box, SurfacePair
 from flow360.component.simulation.simulation_params import SimulationParams
@@ -82,7 +82,7 @@
     remove_units_in_dict,
     replace_dict_key,
     translate_setting_and_apply_to_all_entities,
-    update_dict_recursively,
+    update_dict_recursively, get_all_entries_of_type,
 )
 from flow360.component.simulation.unit_system import LengthType
 from flow360.component.simulation.utils import (
@@ -149,7 +149,7 @@ def init_average_output(
     return base
 
 
-def init_output_base(obj_list, class_type: Type, has_average_capability: bool, is_average: bool):
+def init_output_base(obj_list, class_type: Type, has_average_capability: bool, is_average: bool, no_format=False):
     """Initialize the common output attribute."""
 
     base = {"outputFields": []}
@@ -158,10 +158,11 @@ def init_output_base(obj_list, class_type: Type, has_average_capability: bool, i
         class_type,
         "output_format",
     )
-    assert output_format is not None
-    if output_format == "both":
-        output_format = "paraview,tecplot"
-    base["outputFormat"] = output_format
+    if not no_format:
+        assert output_format is not None
+        if output_format == "both":
+            output_format = "paraview,tecplot"
+        base["outputFormat"] = output_format
 
     if is_average:
         base = init_average_output(base, obj_list, class_type)
@@ -291,6 +292,14 @@ def inject_isosurface_info(entity: Isosurface):
     }
 
 
+def inject_render_info(entity: Isosurface):
+    """inject entity info"""
+    return {
+        "surfaceField": entity.field,
+        "surfaceFieldMagnitude": entity.iso_value,
+    }
+
+
 def inject_probe_info(entity: EntityList):
     """inject entity info"""
 
@@ -438,6 +447,35 @@ def translate_isosurface_output(
     return translated_output
 
 
+def translate_render_output(output_params: list, injection_function):
+    """Translate render output settings."""
+
+    renders = get_all_entries_of_type(output_params, RenderOutput)
+
+    translated_outputs = []
+
+    for render in renders:
+        camera = render.camera.model_dump(exclude_none=True, exclude_unset=True, by_alias=True)
+        lighting = render.lighting.model_dump(exclude_none=True, exclude_unset=True, by_alias=True)
+
+        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=injection_function,
+            ),
+            "camera": remove_units_in_dict(camera),
+            "lighting": remove_units_in_dict(lighting)
+        }
+        translated_outputs.append(translated_output)
+
+    return translated_outputs
+
+
 def translate_surface_slice_output(
     output_params: list,
     output_class: Union[SurfaceSliceOutput],
@@ -636,6 +674,12 @@ def translate_output(input_params: SimulationParams, translated: dict):
             outputs, inject_isosurface_info
         )
 
+    ##:: Step4: Get translated["renderOutput"]
+    if has_instance_in_list(outputs, RenderOutput):
+        translated["renderOutput"] = translate_render_output(
+            outputs, inject_isosurface_info
+        )
+
     ##:: Step5: Get translated["monitorOutput"]
     probe_output = {}
     probe_output_average = {}

flow360/component/simulation/translator/utils.py

@@ -4,6 +4,7 @@
 
 import functools
 import json
+import pydantic as pd
 from collections import OrderedDict
 from typing import Union
 
@@ -163,6 +164,17 @@ def getattr_by_path(obj, path: Union[str, list], *args):
     return obj
 
 
+def get_all_entries_of_type(obj_list: list, class_type: type[pd.BaseModel]):
+    entries = []
+
+    if obj_list is not None:
+        for obj in obj_list:
+            if is_exact_instance(obj, class_type):
+                entries.append(obj)
+
+    return entries
+
+
 def get_global_setting_from_first_instance(
     obj_list: list,
     class_type,

flow360/component/types.py

@@ -14,7 +14,7 @@
 List2D = List[List[float]]
 # we use tuple for fixed length lists, beacause List is a mutable, variable length structure
 Coordinate = Tuple[float, float, float]
-
+Color = Tuple[int, int, int]
 
 class Vector(Coordinate):
     """:class: Vector

tests/simulation/translator/test_solver_translator.py

@@ -40,12 +40,14 @@
     LiquidOperatingCondition,
     ThermalState,
 )
-from flow360.component.simulation.outputs.output_entities import Slice
+from flow360.component.simulation.outputs.output_entities import Slice, Isosurface, RenderCameraConfig, \
+    OrthographicProjection, StaticCamera, RenderLightingConfig, AmbientLight, DirectionalLight
 from flow360.component.simulation.outputs.outputs import (
     SliceOutput,
     SurfaceOutput,
     UserDefinedField,
     VolumeOutput,
+    RenderOutput,
 )
 from flow360.component.simulation.primitives import ReferenceGeometry, Surface
 from flow360.component.simulation.simulation_params import SimulationParams
@@ -119,6 +121,7 @@ def get_om6Wing_tutorial_param():
     my_wall = Surface(name="1")
     my_symmetry_plane = Surface(name="2")
     my_freestream = Surface(name="3")
+    my_isosurface = Isosurface(name="iso", field="Mach", iso_value=0.5)
     with SI_unit_system:
         param = SimulationParams(
             reference_geometry=ReferenceGeometry(
@@ -182,6 +185,32 @@ def get_om6Wing_tutorial_param():
                     output_format="paraview",
                     output_fields=["Cp"],
                 ),
+                RenderOutput(
+                    entities=[my_isosurface],
+                    output_fields=["qcriterion"],
+                    camera=RenderCameraConfig(
+                        view=StaticCamera(
+                            position=(20, 20, 20),
+                            target=(0, 0, 0)
+                        ),
+                        projection=OrthographicProjection(
+                            width=30,
+                            near=0.01,
+                            far=100
+                        )
+                    ),
+                    lighting=RenderLightingConfig(
+                        ambient=AmbientLight(
+                            intensity=0.4,
+                            color=(255, 255, 255)
+                        ),
+                        directional=DirectionalLight(
+                            intensity=1.5,
+                            color=(255, 255, 255),
+                            direction=(-1.0, -1.0, -1.0)
+                        )
+                    )
+                )
             ],
         )
     return param