States

Documentation TODO

This page is a work in progress.

fullflow.State

Scalar value container used throughout FullFlow.

State objects store variables that are shared between components, balances, and solvers. A State may hold a directly assigned value or represent a derived value computed from other states.

States support arithmetic operations, allowing derived states to be constructed naturally:

density_average = 0.5 * (density1 + density2)

Placeholder states may be created with:

pressure = State()

and assigned later by a component or solver.

Parameters

Name	Type	Description
value	float, optional	Initial state value.
bounds	tuple[float or None, float or None], optional	Lower and upper bounds used by bounded solvers.
keep_feasible	bool, optional	Indicates that bounded solvers should attempt to keep the state within its bounds during iterations.