shell.StudyResult

shell.StudyResult(
    addresses,
    shape,
    grid,
    converged,
    probes=dict(),
    solutions=None,
)

The outcome of a :func:parameter_study: the grid, convergence and probed outputs.

Attributes

Name	Type	Description
addresses	tuple of str	The swept parameter addresses, in the order given.
shape	tuple of int	The grid shape (one axis per address for mode="grid"; a single axis for mode="zip").
grid	dict of str -> ndarray	Each address’s value at every point, shaped shape.
converged	ndarray of bool	Whether the mean flow converged at each point, shaped shape.
probes	dict of str -> ndarray	The probed scalar outputs, shaped shape (NaN at non-converged points); empty when no probe was given.
solutions	list of Solution or None	Every point’s solution in iteration order (row-major over shape); None when keep_solutions=False.

Examples

>>> res = parameter_study(base, {"inlet.mdot": np.linspace(0.3, 0.7, 20)},
...                       probe=lambda sol: {"M_max": sol.field("M").max()})
>>> res.probes["M_max"].shape
(20,)