Parameter

class Parameter(name, setter, element, system, distribution, units, baseline, bounds, coupled, hook, description)

Create a Parameter object that, when called, runs the setter and the simulate functions.

Parameters:

• name (str) – Name of parameter.

• setter (function) – Should set the parameter.

• element (object) – Element associated to parameter.

• system (System) – System associated to parameter.

• distribution (chaospy.Dist) – Parameter distribution.

• units (str) – Units of parameter.

• baseline (float) – Baseline value of parameter.

• bounds (tuple[float, float]) – Lower and upper bounds of parameter.

• coupled (str) – Whether parameter is coupled to the system’s mass and energy balances. This allows a ConvergenceModel to predict it’s impact on recycle loops. Defaults to False.

• hook (Callable) – Should return the new parameter value given the sample.

property unit

Unit operation directly associated to parameter.

property subsystem

Subsystem directly associated to parameter.

simulate(**dyn_sim_kwargs)

Simulate parameter.