io.dump_case

io.dump_case(
    network,
    *,
    solution=None,
    fields='all',
    node_data=False,
    forced=None,
    forced_freqs=None,
    forced_fields=('p', 'u'),
    forced_sweep=False,
    eigenmodes=None,
    eig_modes=None,
    eig_fields=('p', 'u'),
    eig_animation=False,
    eig_frames=36,
    nyquist=None,
    title=None,
    extra_datasets=None,
    include_in_save=True,
    mean_flow_name='Mean flow',
)

Serialize a network (and optional results) to a UI-readable YAML string.

Parameters

Name Type Description Default
network Network The flow network to write. required
solution Solution A converged mean-flow solution; when given, its result fields are embedded as a "Mean flow" dataset. None
fields (all, None) Which mean-flow edge fields to include (default "all"). Names are the keys of :data:_FIELD_META (mdot, p, T, M, …). Ignored when solution is None. "all"
node_data bool Also emit each non-phase edge field reduced onto nodes (mean over each node’s incident edges). Default False. False
forced ForcedResponse or list of ForcedResponse Forced-response result(s) to snapshot as per-frequency datasets. None
forced_freqs sequence of float Frequencies (Hz) to snapshot from forced; default is every frequency present. Each must match a solved frequency. None
forced_fields sequence of str Perturbation quantities per snapshot (default ("p", "u")); keys of :data:_FORCED_FIELDS, plus "reflection". Magnitude and phase are emitted for each. ('p', 'u')
forced_sweep bool Emit each forced response as a single animated dataset (one frame per frequency, frame variable Frequency in Hz) instead of one snapshot dataset per frequency. Default False. False
eigenmodes EigenmodeResult A stability (eigenmode) result to snapshot. Each mode is emitted as its own "Mode <i>: <f> Hz" dataset carrying the per-edge mode-shape magnitude and phase, with the modal frequency, growth rate, damping ratio, residual and unstable flag as dataset metadata. The mode-shape amplitude is relative (the eigenvector’s arbitrary normalization). None
eig_modes sequence of int Which mode indices to snapshot (default: every mode in eigenmodes). None
eig_fields sequence of str Perturbation quantities per mode (default ("p", "u")); keys of :data:_FORCED_FIELDS. Magnitude and phase are emitted for each. ('p', 'u')
eig_animation bool Additionally emit each selected mode as an animated dataset ("Mode <i>: <f> Hz animation"): the instantaneous shape Re{psi e^{i theta}} per edge, swept over one phase cycle (frame variable Phase in degrees). Default False. False
eig_frames int Phase frames per cycle for eig_animation (default 36; the cycle endpoint is excluded so looped playback is seamless). 36
nyquist NyquistResponse or list of NyquistResponse Nyquist stability result(s) to summarize as an items-free dataset (verdict, unstable-mode count, margin, onset frequencies as metadata). The locus itself is scalar per frequency – not an element-bound field – so no values are emitted. None
title str Case title (meta.title). Defaults to the loaded title or "Nefes case". None
extra_datasets list of DataSet Fully custom datasets appended as-is (e.g. genuinely nodal data the user supplies directly). None
include_in_save bool The includeInSave flag stamped on generated datasets (default True). True
mean_flow_name str Name for the mean-flow dataset built from solution (default "Mean flow"); the companion chemistry dataset, if any, is named "<mean_flow_name> chemistry". 'Mean flow'

Returns

Name Type Description
str The YAML document.
Back to top