Biflow

BPTK API Documentation for the Biflow class
Keywords

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

Biflow

Biflow Constructor

Biflow(model, name, function_string=None)

Biflow in a SD DSL model

A biflow is a flow that may run in either direction: positive values increase the stock it feeds, negative values decrease it. Use one where a single quantity can go both ways — net migration, net cash flow, a temperature difference — instead of modelling an inflow and an outflow that are never both active.

Create one through the model: model.biflow("net_migration").

Note: a model containing a biflow cannot run on the Rust engine and falls back to Python. See Execution Backends.

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.