ParametricRunner

class ParametricRunner

Provides methods to run parametric study simulations.

Overview

Static methods

simulate

Run the simulations in the parametric study with Status equal to Pending.

Import detail

from ansys.additive.core.parametric_study.parametric_runner import ParametricRunner

Method detail

static ParametricRunner.simulate(df: pandas.DataFrame, additive: ansys.additive.core.Additive, type: list[ansys.additive.core.SimulationType] = None, priority: int = None) → list[ansys.additive.core.SingleBeadSummary, ansys.additive.core.PorositySummary, ansys.additive.core.MicrostructureSummary]

Run the simulations in the parametric study with Status equal to Pending.

Execution order is determined by the Priority value assigned to the simulations. Lower values are interpreted as having higher priority and are run first.

Parameters:

dfpd.DataFrame

Parametric study data frame.

additiveAdditive

Additive service connection to use for running simulations.

typelist, default: None

List of the simulation types to run. The default is None, in which case all simulation types are run.

priorityint, default: None

Priority of simulations to run. The default is None, in which case all priorities are run.

Returns:

list[SingleBeadSummary, PorositySummary, MicrostructureSummary]

List of simulation summaries.