Solutions and outputs¶

A completed gradientdynamics.Solution contains summary metadata, convergence histories, requested engineering quantities and downloadable field assets.

Asset¶

class gradientdynamics.outputs.Asset¶

Downloadable result asset.

name: str¶

format: str¶: Examples include cgns, vtu, vtp, pvd, json and csv.

size_bytes: int | None¶

download(path: str | Path, *, overwrite: bool = False) → Path¶: Download the asset and return the local path.

Field collection¶

class gradientdynamics.outputs.FieldCollection¶

Field and surface assets attached to a solution.

list(*, format: str | None = None) → tuple[Asset, ...]¶: List available field assets, optionally filtered by format.

download(path: str | Path, *, format: str = 'cgns', overwrite: bool = False) → Path¶: Download the preferred volume-field asset.

History¶

class gradientdynamics.outputs.History¶

Named residual or engineering-monitor series.

name: str¶

x: Sequence[float]¶: Iteration, physical time or sample coordinate.

values: Sequence[float]¶

to_dataframe() → pandas.DataFrame¶: Convert the series to a two-column data frame.

Force result¶

class gradientdynamics.outputs.ForceResult¶

Integrated force and moment result produced by a named gradientdynamics.fluxcore.ForceOutput.

force: tuple[float, float, float]¶

moment: tuple[float, float, float] | None¶

coefficient: float | None¶: Primary requested coefficient, such as drag coefficient.

pressure_contribution: tuple[float, float, float] | None¶

viscous_contribution: tuple[float, float, float] | None¶

Reading a solution¶

solution = simulation.run().wait().result()

drag = solution.outputs["vehicle_loads"]
print(f"CD = {drag.coefficient:.4f}")

residuals = solution.histories["continuity"].to_dataframe()
solution.fields.download("solution.cgns")

Field availability depends on simulation type and requested output definition:

CGNS preserves interoperable mesh and solution data.
VTU provides unstructured volume fields for VTK-compatible tools.
VTP provides selected boundary surfaces and fields.
PVD and snapshots describe optional time-resolved series.

Time-series manifests preserve snapshot order, physical time, shared topology and available fields. Copy required assets into governed organisational storage before a preview retention period expires, and preserve the solution summary and manifest so units, revisions and reference values remain interpretable.