Energy Splitter

DWSIM Plus

Available with a DWSIM Plus (Patreon) subscription.

Energy splitter: divides one inlet energy stream into up to three outlet energy streams, either by split ratios or by specified energy flows for the first one or two outlets with the remainder going to the last connected outlet.

DWSIM.UnitOperations.ExtensionPack.EnergySplitter
Assembly DWSIM.UnitOperations.ExtensionPack.dll · Object ← BaseClass ← UnitOpBaseClass ← EnergySplitter

At a glance

Port	Index	Connected in the example
Inlet, energy	0	Heat supply
Outlet, energy	0	User-1
Outlet, energy	1	User-2
Outlet, energy	2	User-3

Example

This code runs on every build of this site, and the output below is what it printed.

Python

fs = (Flowsheet.Create("EnergySplitterExample")
      .WithCompound("Water")
      .WithPropertyPackage(PropertyPackages.SteamTables))

supply = fs.AddEnergyStream("Heat supply").WithEnergyFlow(Q.Kilowatts(1500.0))
users = [fs.AddEnergyStream(f"User-{i + 1}") for i in range(3)]

splitter = (fs.AddEnergySplitter("ES-1")
            .WithOperationMode(EnergySplitter.OpMode.SplitRatios)
            .ConnectEnergyFeed(supply, 0))
# Outlet port i goes to user i.
for i, user in enumerate(users):
    splitter.ConnectEnergyProduct(user, i)

# Fractions for outlets 1 and 2; outlet 3 takes the rest.
splitter.Object.Ratios[0] = 0.5
splitter.Object.Ratios[1] = 0.3

fs.AutoLayout()
fs.Solve()

for user in users:
    print(f"{user.Object.GraphicObject.Tag} = {user.EnergyFlowKW:.1f} kW")
print(f"Sum    = {sum(u.EnergyFlowKW for u in users):.1f} kW")

Output

User-1 = 750.0 kW
User-2 = 450.0 kW
User-3 = 300.0 kW
Sum    = 1500.0 kW

DWSIM 10.2.11.0, generated 2026-10-08.

Properties

IDs accepted by GetPropertyValue, SetPropertyValue, the sensitivity analysis, the optimizer, the Adjust block and dynamic events. Units are SI; pass another unit system to GetPropertyValue to get them converted.

ID	Name	Unit (SI)	Input
Stream 1 Flow Spec		kW	yes
Stream 2 Flow Spec		kW	yes
SR1	Split Ratio Stream 1		yes
SR2	Split Ratio Stream 2		yes
SR3	Split Ratio Stream 3		result

Learn more

• User guide

  ---

  • Energy Splitter

• FluentAPI

  ---

  • Plus.EnergySplitterBuilder

API members

Public members declared by this class. Inherited members are documented on the base classes.

Constructors

EnergySplitter(): Initializes a new default instance of the EnergySplitter class.

Initializes a new default instance of the EnergySplitter class. The split ratios start as 1, 0, 0.

C#VB.NET

public EnergySplitter()

Public Sub New()

EnergySplitter(string, string): Initializes a new instance of the EnergySplitter class with a name and description.

Initializes a new instance of the EnergySplitter class with a name and description. The split ratios start as 1, 0, 0.

Parameter	Type	Description
Name	String	The name of this unit operation.
Description	String	A brief description of this unit operation.

C#VB.NET

public EnergySplitter(string Name, string Description)

Public Sub New(Name As String, Description As String)

Properties

ComponentDescription: Gets or sets the CAPE-OPEN component description for this unit operation.

Gets or sets the CAPE-OPEN component description for this unit operation.

C#VB.NET

public override string ComponentDescription { get; set; }

Public Overrides Property ComponentDescription As String

ComponentName: Gets or sets the CAPE-OPEN component name for this unit operation.

Gets or sets the CAPE-OPEN component name for this unit operation.

C#VB.NET

public override string ComponentName { get; set; }

Public Overrides Property ComponentName As String

IsPremium: Gets a value indicating whether this unit operation is a premium (DWSIM Patreon) unit operation.

Gets a value indicating whether this unit operation is a premium (DWSIM Patreon) unit operation. Always True; the object palette lists it under the Premium category.

C#VB.NET

public bool IsPremium { get; }

Public ReadOnly Property IsPremium As Boolean

MobileCompatible: Gets a value indicating whether this unit operation is compatible with mobile interfaces.

Gets a value indicating whether this unit operation is compatible with mobile interfaces. Always False.

C#VB.NET

public override bool MobileCompatible { get; }

Public Overrides ReadOnly Property MobileCompatible As Boolean

ObjectClass: Gets or sets the simulation object class category (MixersSplitters).

Gets or sets the simulation object class category (MixersSplitters).

C#VB.NET

public override SimulationObjectClass ObjectClass { get; set; }

Public Overrides Property ObjectClass As SimulationObjectClass

OperationMode: Gets or sets the specification mode: SplitRatios (0, default) divides the inlet energy flow by Ratios...

Gets or sets the specification mode: SplitRatios (0, default) divides the inlet energy flow by Ratios; StreamEnergyFlowSpec (1) uses StreamFlowSpec and Stream2FlowSpec, with the last connected outlet taking the remainder.

C#VB.NET

public EnergySplitter.OpMode OperationMode { get; set; }

Public Property OperationMode As EnergySplitter.OpMode

Ratios: Gets the split ratios (fractions of the inlet energy flow) for outlets 1 to 3.

Gets the split ratios (fractions of the inlet energy flow) for outlets 1 to 3. The ratio of the last connected outlet is recalculated to close the balance.

C#VB.NET

public ArrayList Ratios { get; }

Public ReadOnly Property Ratios As ArrayList

Stream2FlowSpec: Gets or sets the energy flow sent to outlet 2, in kW, when OperationMode is StreamEnergyFlowSpec...

Gets or sets the energy flow sent to outlet 2, in kW, when OperationMode is StreamEnergyFlowSpec and three outlets are connected. Default 0.

C#VB.NET

public double Stream2FlowSpec { get; set; }

Public Property Stream2FlowSpec As Double

StreamFlowSpec: Gets or sets the energy flow sent to outlet 1, in kW, when OperationMode is StreamEnergyFlowSpec.

Gets or sets the energy flow sent to outlet 1, in kW, when OperationMode is StreamEnergyFlowSpec. Default 0.

C#VB.NET

public double StreamFlowSpec { get; set; }

Public Property StreamFlowSpec As Double

Methods

Calculate(object): Calculates the object.

Calculates the object.

Parameter	Type	Description
args	Object

C#VB.NET

public override void Calculate(object args = null)

Public Overrides Sub Calculate(args As Object = Nothing)

CloneXML(): Creates a deep copy of this object by round-tripping through XML serialization.

Creates a deep copy of this object by round-tripping through XML serialization.

C#VB.NET

public override object CloneXML()

Public Overrides Function CloneXML() As Object

CloseEditForm(): Closes the editor of this object, if it is open.

Closes the editor of this object, if it is open.

C#VB.NET

public override void CloseEditForm()

Public Overrides Sub CloseEditForm()

DeCalculate(): Decalculates the object.

Decalculates the object.

C#VB.NET

public override void DeCalculate()

Public Overrides Sub DeCalculate()

DisplayEditForm(): Opens the editor of this object.

Opens the editor of this object. A host that has no editor for it does nothing.

C#VB.NET

public override void DisplayEditForm()

Public Overrides Sub DisplayEditForm()

GetDisplayDescription(): Returns the description string for this unit operation type.

Returns the description string for this unit operation type.

C#VB.NET

public override string GetDisplayDescription()

Public Overrides Function GetDisplayDescription() As String

GetDisplayName(): Returns the display name for this unit operation type.

Returns the display name for this unit operation type.

C#VB.NET

public override string GetDisplayName()

Public Overrides Function GetDisplayName() As String

GetIconBitmapBytes(): Returns the raw bytes of the icon image for this unit operation.

Returns the raw bytes of the icon image for this unit operation.

C#VB.NET

public override byte[] GetIconBitmapBytes()

Public Overrides Function GetIconBitmapBytes() As Byte()

GetProperties(PropertyType): Get a list of all properties of the object.

Get a list of all properties of the object.

Parameter	Type	Description
proptype	PropertyType	Type of the property.

C#VB.NET

public override string[] GetProperties(PropertyType proptype)

Public Overrides Function GetProperties(proptype As PropertyType) As String()

GetPropertyDescription(string): Returns the description of the specified property, as shown in the editor.

Returns the description of the specified property, as shown in the editor.

Parameter	Type	Description
p	String	The property name.

C#VB.NET

public override string GetPropertyDescription(string p)

Public Overrides Function GetPropertyDescription(p As String) As String

GetPropertyUnit(string, IUnitsOfMeasure): Gets the units of a property.

Gets the units of a property.

Parameter	Type	Description
prop	String	Property identifier.
su	IUnitsOfMeasure	Units system to use. Null to use the default (SI) system.

C#VB.NET

public override string GetPropertyUnit(string prop, IUnitsOfMeasure su = null)

Public Overrides Function GetPropertyUnit(prop As String, su As IUnitsOfMeasure = Nothing) As String

GetPropertyValue(string, IUnitsOfMeasure): Returns the value of a named property, converting from SI to the current unit system.

Returns the value of a named property, converting from SI to the current unit system. Falls back to extra properties if the property is not found in the base implementation.

Parameter	Type	Description
prop	String	The property identifier string.
su	IUnitsOfMeasure	Optional units-of-measure system used for conversion; uses the shared SI system when Nothing.

C#VB.NET

public override object GetPropertyValue(string prop, IUnitsOfMeasure su = null)

Public Overrides Function GetPropertyValue(prop As String, su As IUnitsOfMeasure = Nothing) As Object

LoadData(List<XElement>): Restores the unit operation state from a list of XML elements previously produced by SaveData.

Restores the unit operation state from a list of XML elements previously produced by SaveData.

Parameter	Type	Description
data	List<XElement>	The list of XElement objects containing serialized state.

C#VB.NET

public override bool LoadData(List<XElement> data)

Public Overrides Function LoadData(data As List(Of XElement)) As Boolean

SaveData(): Serializes the unit operation state to a list of XML elements for persistence.

Serializes the unit operation state to a list of XML elements for persistence.

C#VB.NET

public override List<XElement> SaveData()

Public Overrides Function SaveData() As List(Of XElement)

SetPropertyValue(string, object, IUnitsOfMeasure): Sets the value of a property.

Sets the value of a property.

Parameter	Type	Description
prop	String	Property identifier.
propval	Object	Property value to set at the specified units.
su	IUnitsOfMeasure	Units system to use. Null to use the default (SI) system.

C#VB.NET

public override bool SetPropertyValue(string prop, object propval, IUnitsOfMeasure su = null)

Public Overrides Function SetPropertyValue(prop As String, propval As Object, su As IUnitsOfMeasure = Nothing) As Boolean

UpdateEditForm(): Redraws the editor of this object with the current values, if it is open.

Redraws the editor of this object with the current values, if it is open.

C#VB.NET

public override void UpdateEditForm()

Public Overrides Sub UpdateEditForm()

Fields

f: The classic (WinForms) editor window open for this unit operation, if any.

The classic (WinForms) editor window open for this unit operation, if any. Not saved with the flowsheet.

C#VB.NET

public EditingForm_Splitter f

Public f As EditingForm_Splitter

OutCount: The number of connected outlet streams (0 to 3), recounted on calculation and on load.

The number of connected outlet streams (0 to 3), recounted on calculation and on load.

C#VB.NET

public int OutCount

Public OutCount As Integer