cavcalc.output.SingleOutput#

Overview

class cavcalc.output.SingleOutput(target: TargetParameter, phys_args: tuple[cavcalc.parameters.parameter.ArgParameter])#

Bases: BaseOutput

Storage and manipulation of a single target parameter computed via calculate().

Properties

SingleOutput.name

A short-hand for out.result.name.

SingleOutput.result

The result itself as a TargetParameter instance.

Methods

SingleOutput.__init__(target, phys_args)

SingleOutput.convert(units)

Attempts to convert the result quantity, in-place, to the specified units.

SingleOutput.plot([xlim, ylim, zlim, ...])

Plots the result against the given array-like argument dependencies (if any).