Programmatic creation and editing of nflow block-diagram models.
NFlow is currently released as 1.0.0-beta.1: it is functional and tested, but details of its interfaces and file format may still evolve based on feedback.
-
NFlow.exportfmu
Export an nflow model as an FMI 3.0 Co-Simulation source FMU.
-
NFlow.plotScopes
Open one figure per scope of an nflow simulation result.
-
add_block
Add a block to an nflow model from a library source.
-
add_line
Connect two block ports in an nflow model.
-
bdIsDirty
Return true when an nflow model has unsaved changes.
-
bdIsLoaded
Return true when an nflow model is loaded.
-
bdclose
Unload one or all nflow models, discarding unsaved changes.
-
bdroot
Return the top-level model of a block path.
-
close_system
Unload an nflow model; a dirty model requires an explicit save flag.
-
delete_block
Delete a block and all of its connections from an nflow model.
-
delete_line
Delete a connection between two block ports.
-
find_system
List the blocks of a model, optionally filtered by type.
-
gcbh
Return the handle of the current block.
-
getNFlowBlockHandle
Return the handle of a block by path, or -1 if not found.
-
get_param
Query a model or block parameter.
-
getfullname
Return the full path of a block or model from its handle.
-
linmod
Numerical linearization of an nflow model.
-
load_system
Load an nflow model from a .nflow file without opening the editor.
-
new_system
Create and load an empty nflow model.
-
nflow_codegenerate
Generate standalone C or Rust code from an nflow model.
-
save_system
Save an nflow model to a .nflow file.
-
set_param
Set model or block parameters atomically.
-
sim
Run an nflow simulation of a model and return its results.
-
NFlow.sspInfo
Inspect, import and export SSP (System Structure and Parameterization) archives.
-
trim
Find a steady-state operating point of an nflow model.
