Simulation

When you create a Simulation with the API, you can use it to retrieve global residuals, solutions, and surface outputs. This is useful for analyzing the results and creating residual plots.

Creating and Running Simulations

Simulations are created and run with a Project. See Project for more info.

Downloading Global Residuals

Global residuals are available for both steady state and transient simulations in CSV format. The CSV contains the values for every available residual type. You can then use the data to generate residual plots and view the convergence history.

For a transient simulation, you can download residuals for the latest iteration of each time step.

See download_global_residuals for syntax and parameters.

For example code, see the Global Residuals section of Run Your First Simulation.

Downloading Surface Outputs

Surface outputs are returned for both steady state and transient simulations in CSV format. For a transient simulation, you can download surface outputs for the latest iteration of each time step.

See download_surface_output for syntax and parameters.

For example code, see the Output Quantities section of Run Your First Simulation.

Getting Available Solutions

Solution data isn’t usually outputted at every iteration. You can retrieve the full list of available solutions by calling list_solutions. More solutions may become available as the simulation runs to completion.

See Solution for more info.