Example Monitor Conversion

This example demonstrates the conversion of legacy monitor point definitions, previously specified in a JSON format (v0), into the corresponding ProbeOutput objects compatible with the SimulationParams class used in the current Flow360 Python API. The script employs the helper function ProbeOutput.read_all_v0_monitors for this conversion process.

import os

import unyt as u

from flow360.component.simulation.migration import ProbeOutput

# Get the absolute path to the script file
script_dir = os.path.dirname(os.path.abspath(__file__))
# Change the current working directory to the script directory
os.chdir(script_dir)

my_monitor = ProbeOutput.read_all_v0_monitors(
    file_path="./ProbeOutput_tutorial_Flow360.json", mesh_unit=u.m
)

print(my_monitor)

"""
with SI_unit_system:
    params = fl.SimulationParams(
        ...
        outputs=[
            ...
            *my_monitor,
            ...
        ]
        ...
    )
"""

Notes

• The script utilizes ProbeOutput.read_all_v0_monitors from the flow360.component.simulation.migration module to facilitate the transition of monitor point definitions from the legacy JSON format.

• The resulting list of converted monitor objects can be directly incorporated into the outputs list within a SimulationParams instance.