Skip to content

Model Option

fullflow.ModelOption

Deferred component option used by Model.

ModelOption stores enough information to build either one component or a group of components later. Unlike a normal Component, a ModelOption does not register itself with a Network when it is created.

Model options are useful when a solver should be able to try alternate component implementations without constructing all of them at once.

Parameters

Name Type Description
namestr

Model option name *model_options : ModelOption Grouped model options

component_classtype, optional

Component class to construct

kwargsdict, optional

Keyword arguments passed to the component constructor

componentslist[ModelOption], optional

Grouped model options