Ion Exchange

DWSIM Plus

Available with a DWSIM Plus (Patreon) subscription.

Ion Exchange Unit Operation — removes target ions from a feed stream via resin selectivity equilibrium (single-stage or staged counter-current). Ports ───── Inlet 0 : Feed Inlet 1 : Regenerant (optional — only used if connected) Outlet 0 : Treated Effluent Outlet 1 : Spent Regenerant / Eluate (optional — only set if connected)

DWSIM.UnitOperations.ElectrolyteOps.IonExchangeUnitOperation
Assembly DWSIM.UnitOperations.ElectrolyteOps.dll · Object ← BaseClass ← UnitOpBaseClass ← IonExchangeUnitOperation

At a glance

Port	Index	Connected in the example
Inlet, material	0	Hard-water
Inlet, material	1	Regenerant
Outlet, material	0	Soft-water
Outlet, material	1	Spent-brine

Example

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

Python

fs = (Flowsheet.Create("IonExchangeExample")
      .WithCompounds("Water", "Calcium (ion)", "Magnesium (ion)", "Sodium (ion)", "Chloride (ion)")
      .WithPropertyPackage(PropertyPackages.Plus.ElectrolyteNRTL))

# Hard water, 10 kg/s: 3 mmol/L Ca2+ and 1 mmol/L Mg2+ as chlorides (400 mg/L as CaCO3)
hard = (fs.AddMaterialStream("Hard-water").At(Q.Celsius(20.0), Q.Bar(3.0))
        .SetCompoundMolarFlow("Water", 10.0 / 0.018015)
        .SetCompoundMolarFlow("Calcium (ion)", 0.030)
        .SetCompoundMolarFlow("Magnesium (ion)", 0.010)
        .SetCompoundMolarFlow("Chloride (ion)", 0.080))
# NaCl regenerant brine, 1 kg/s at about 10 wt%
brine = (fs.AddMaterialStream("Regenerant").At(Q.Celsius(20.0), Q.Bar(3.0))
         .SetCompoundMolarFlow("Water", 0.9 / 0.018015)
         .SetCompoundMolarFlow("Sodium (ion)", 1.7)
         .SetCompoundMolarFlow("Chloride (ion)", 1.7))
soft = fs.AddMaterialStream("Soft-water")
spent = fs.AddMaterialStream("Spent-brine")

ix = (fs.AddIonExchange("IX-1")
      .WithResinType(IXResinType.StrongAcidCation)
      .WithRegenerantIon(IXRegenerantIon.Na)
      .WithResinCapacityEqPerL(1.8)
      .WithBedVolume(Q.CubicMeters(2.0))
      .WithOperationMode(IXOperationMode.StagedCountercurrent)
      .WithStages(4)
      .ConnectFeed(hard, 0).ConnectFeed(brine, 1)
      .ConnectProduct(soft, 0).ConnectProduct(spent, 1))

fs.AutoLayout()
fs.Solve()

r = ix.Object.Results
for ion in r.IonResults:
    if ion.Charge > 0 and ion.FeedConcentration > 0.0:
        print(f"{ion.IonName:16s} {ion.FeedConcentration:5.2f} -> {ion.EffluentConcentration:.4f} meq/L "
              f"({ion.RemovalEfficiency:.1f} % removed)")
print(f"Hardness        {r.FeedTotalHardness:.0f} -> {r.EffluentTotalHardness:.2f} mg/L as CaCO3")
print(f"Na+ released    {soft.Object.Phases[0].Compounds['Sodium (ion)'].MolarFlow * 1000.0:.1f} mmol/s")

Output

Calcium (ion)     5.98 -> 0.0000 meq/L (100.0 % removed)
Magnesium (ion)   1.99 -> 0.0000 meq/L (100.0 % removed)
Hardness        399 -> 0.00 mg/L as CaCO3
Na+ released    80.0 mmol/s

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
Resin Type			yes
Resin Capacity		eq/L	yes
Bed Volume		m3	yes
Operation Mode			yes
Number of Stages			yes
Regenerant Ion			yes
Design Flow Rate		m3/s	yes
Effluent Molar Flow		mol/s	result
Feed Total Hardness		mg/L CaCO3	result
Effluent Total Hardness		mg/L CaCO3	result
Resin Saturation Fraction			result
Bed Volumes to Breakthrough			result

Learn more

• FluentAPI

  ---

  • Electrolyte.IonExchangeBuilder
  • 13 - Reverse Osmosis + Ion Exchange (Plus)

API members

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

Constructors

IonExchangeUnitOperation()

C#VB.NET

public IonExchangeUnitOperation()

Public Sub New()

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

Config: Gets or sets the input configuration: resin type, capacity and bed volume, operation mode and number of stages...

Gets or sets the input configuration: resin type, capacity and bed volume, operation mode and number of stages, regenerant ion, counter-ion compound, selectivity coefficients and design flow rate.

C#VB.NET

public IonExchangeConfig Config { get; set; }

Public Property Config As IonExchangeConfig

IsPremium: Gets a value indicating that this unit operation is listed in the Premium group of the object palette (always true).

Gets a value indicating that this unit operation is listed in the Premium group of the object palette (always true).

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 (always false).

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 the simulation object class category (separators).

Gets the simulation object class category (separators).

C#VB.NET

public override SimulationObjectClass ObjectClass { get; }

Public Overrides Property ObjectClass As SimulationObjectClass

Prefix: Gets the default name prefix for this unit operation ('IX-').

Gets the default name prefix for this unit operation ("IX-").

C#VB.NET

public string Prefix { get; }

Public ReadOnly Property Prefix As String

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()

CreateConnectors(): Creates the graphic connector definitions on the flowsheet: feed inlet (left) and regenerant inlet (bottom), treated...

Creates the graphic connector definitions on the flowsheet: feed inlet (left) and regenerant inlet (bottom), treated effluent and spent regenerant outlets (right). The unit exchanges no energy, so it has no energy connector.

C#VB.NET

public void CreateConnectors()

Public Sub CreateConnectors()

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()

Draw(object): Draws the unit operation on the given SkiaSharp canvas: the embedded photo in photorealistic mode (draw mode 2)...

Draws the unit operation on the given SkiaSharp canvas: the embedded photo in photorealistic mode (draw mode 2), otherwise the vector icon.

Parameter	Type	Description
g	Object	The SkiaSharp canvas.

C#VB.NET

public void Draw(object g)

Public Sub Draw(g As Object)

GetChartModel(string): Builds an OxyPlot model of the effluent-to-feed ratio of every ion against the bed volumes treated, by running the...

Builds an OxyPlot model of the effluent-to-feed ratio of every ion against the bed volumes treated, by running the exchange model (Kremser or single-stage equilibrium) over a range of liquid volumes; the 10 % breakthrough estimate is marked.

Parameter	Type	Description
name	String

C#VB.NET

public override object GetChartModel(string name)

Public Overrides Function GetChartModel(name As String) As Object

GetChartModelNames(): Chart names the PFD chart object can embed.

Chart names the PFD chart object can embed.

C#VB.NET

public override List<string> GetChartModelNames()

Public Overrides Function GetChartModelNames() As List(Of String)

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()

GetPreferredGraphicObjectHeight(): Returns the preferred height of the flowsheet graphic object, in pixels.

Returns the preferred height of the flowsheet graphic object, in pixels.

C#VB.NET

public override double GetPreferredGraphicObjectHeight()

Public Overrides Function GetPreferredGraphicObjectHeight() As Double

GetPreferredGraphicObjectWidth(): Returns the preferred width of the flowsheet graphic object, in pixels.

Returns the preferred width of the flowsheet graphic object, in pixels.

C#VB.NET

public override double GetPreferredGraphicObjectWidth()

Public Overrides Function GetPreferredGraphicObjectWidth() As Double

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()

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)

Public Overrides Function GetPropertyUnit(prop As String, su As IUnitsOfMeasure) 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)

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

LoadData(List<XElement>): Restores the unit operation.

Restores the unit operation. The Config element, when present, is loaded into the existing Config; files saved without it keep the default configuration.

Parameter	Type	Description
data	List<XElement>	The XML elements written by SaveData.

C#VB.NET

public override bool LoadData(List<XElement> data)

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

PopulateEditorPanel(object): Populates the cross-platform (Avalonia) editor panel with controls.

Populates the cross-platform (Avalonia) editor panel with controls.

Parameter	Type	Description
ctner	Object	The editor panel (layout container) to populate.

C#VB.NET

public void PopulateEditorPanel(object ctner)

Public Sub PopulateEditorPanel(ctner As Object)

ReturnInstance(string): Creates and returns a new instance for deserialization.

Creates and returns a new instance for deserialization.

Parameter	Type	Description
typename	String	The type name to instantiate.

C#VB.NET

public object ReturnInstance(string typename)

Public Function ReturnInstance(typename As String) As Object

SaveData(): Serializes the unit operation, with its Config written as a Config element.

Serializes the unit operation, with its Config written as a Config element.

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)

Public Overrides Function SetPropertyValue(prop As String, propval As Object, su As IUnitsOfMeasure) 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()