Flow

BPTK API Documentation for the Element class
Keywords

system dynamics, bptk, bptk-py, python, business prototyping

Flow

Flow in a SD DSL model.

Flow Constructor

Flow(model, name, function_string=None)

Create the flow.

Flow.equation

property equation()

Returns the equation as originally set.

  • Returns

    The equation, either a SD DSL Element or Operator.

A flow is the rate at which a stock changes in a timestep. It flows into a stock, increasing it, or out of one, decreasing it — the direction comes from the sign it is given in the stock’s equation.

Create one through the model: model.flow("births").

Flow.equation

property equation

The rate for one timestep. It may be a constant, or an expression over other elements.

births = model.flow("births")
births.equation = birth_rate * population

Inherited from Element

Everything else — equation, function_string, plot() and the arrayed-element API — comes from Element, where it is documented once for all element types.