flow360.RenderOutput

class RenderOutput

Bases: _AnimationSettings

RenderOutput class for backend rendered output settings.

Example

Define the RenderOutput that outputs a basic image - boundaries and a Y-slice:

>>> fl.RenderOutput(
...     name="Example render",
...     groups=[
...         fl.RenderOutputGroup(
...             surfaces=geometry["*"],
...             material=fl.render.PBRMaterial.metal(shine=0.8)
...         ),
...         fl.RenderOutputGroup(
...             slices=[
...                 fl.Slice(name="Example slice", normal=(0, 1, 0), origin=(0, 0, 0))
...             ],
...             material=fl.render.FieldMaterial.rainbow(field="T", min_value=0, max_value=1, alpha=0.4)
...         )
...     ],
...     camera=fl.render.Camera.orthographic(scale=5, view=fl.Viewpoint.TOP + fl.Viewpoint.LEFT)
... )
====

name: str = 'Render output'

Name of the RenderOutput.

groups: List[RenderOutputGroup] = []

camera: Camera [Optional]

Camera settings

lighting: Lighting [Optional]

Lighting settings

environment: Environment [Optional]

Environment settings

transform: SceneTransform | None = None

Optional model transform to apply to all entities

output_type: Literal['RenderOutput'] = 'RenderOutput'

frequency: pd.PositiveInt | Literal[-1] = -1

Frequency (in number of physical time steps) at which output is saved. -1 is at end of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case. Example: if the parent case finished at time_step=174, the child case will start from time_step=175. If frequency=100 (child case), the output will be saved at time steps 200 (25 time steps of the child simulation), 300 (125 time steps of the child simulation), etc. This setting is NOT applicable for steady cases.

frequency_offset: int = 0

Offset (in number of physical time steps) at which output is started to be saved. 0 is at beginning of simulation. Important for child cases - this parameter refers to the global time step, which gets transferred from the parent case (see frequency parameter for an example). Example: if an output has a frequency of 100 and a frequency_offset of 10, the output will be saved at global time step 10, 110, 210, etc. This setting is NOT applicable for steady cases.

Constraints:

• ge = 0