- class Flowsheet(ID)#
Create a Flowsheet object which stores references to all stream, unit, and system objects. For a tutorial on flowsheets, visit Managing flowsheets.
FlowsheetRegistry= <FlowsheetRegistry: default>#
Return a TemporaryFlowsheet object that, through context management, will temporarily register all objects in this flowsheet instead of the main flowsheet.
>>> import biosteam as bst >>> bst.settings.set_thermo(['Water'], cache=True) >>> f = bst.Flowsheet('f') >>> with f.temporary(): ... M1 = bst.Mixer('M1') >>> M1 in bst.main_flowsheet.unit False >>> M1 in f.unit True
- classmethod from_flowsheets(ID, flowsheets)#
Return a new flowsheet with all registered objects from the given flowsheets.
- diagram(kind=None, file=None, format=None, display=True, number=None, profile=None, label=None, title=None, **graph_attrs)#
Display a Graphviz diagram of all unit operations.
0 or ‘cluster’: Display all units clustered by system.
1 or ‘thorough’: Display every unit within the path.
2 or ‘surface’: Display only elements listed in the path.
3 or ‘minimal’: Display a single box representing all units.
str, optional) – File name to save diagram.
str, optional) – File format (e.g. “png”, “svg”). Defaults to ‘png’
bool, optional) – Whether to display diagram in console or to return the graphviz object.
bool, optional) – Whether to number unit operations according to their order in the system path.
bool, optional) – Whether to clock the simulation time of unit operations.
bool, optional) – Whether to label the ID of streams with sources and sinks.
- create_system(ID='', ends=None, facility_recycle=None, operating_hours=None, lang_factor=None)#
Create a System object from all units and streams defined in the flowsheet.
str, optional) – Name of system.
Stream], optional) – End streams of the system which are not products. Specify this argument if only a section of the complete system is wanted, or if recycle streams should be ignored.
Stream, optional) – Recycle stream between facilities and system path. This argument defaults to the outlet of a BlowdownMixer facility (if any).
float, optional) – Number of operating hours in a year. This parameter is used to compute annualized properties such as utility cost and material cost on a per year basis.
float, optional) – Lang factor for getting fixed capital investment from total purchase cost. If no lang factor, installed equipment costs are estimated using bare module factors.