prommis.ion_exchange.ion_exchange_multicomponent_base

Ion Exchange Multicomponent (IXMC) Base Model

The Ion Exchange Multicomponent (IXMC) base model addresses the following specific aspects of the ion exchange process:

• Provides the foundational structure for the IXMC model, ensuring consistency across all calculations and enabling users to define global key variables and parameters.

• Contains all global variables and parameters required for modeling the ion exchange column, including terms related to column geometry and resin properties. Most of these variables, parameters, and expressions are included under the Model Components Table in the WaterTAP IX documentation.

class prommis.ion_exchange.ion_exchange_multicomponent_base.IonExchangeBaseData(component)

Base for zero-order ion exchange model.

add_properties_resin()

Method to add resin-specific properties for the selected resin.

NOTE: When using this method, keep in mind the temperature for the data for each property given in the .json file

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None

Returns:

None

initialize_build(state_args=None, outlvl=0, solver=None, optarg=None)

General wrapper for initialization routines

Keyword Arguments:

• state_args – a dict of arguments to be passed to the property package(s) to provide an initial state for initialization (see documentation of the specific property package) (default = {}).

• outlvl – sets output level of initialization routine

• optarg – solver options dictionary object (default=None)

• solver – str indicating which solver to use during initialization (default = None)

Returns: None

class prommis.ion_exchange.ion_exchange_multicomponent_base.IonExchangeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class prommis.ion_exchange.ion_exchange_multicomponent_base.IsothermType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class prommis.ion_exchange.ion_exchange_multicomponent_base.RegenerantChem(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class prommis.ion_exchange.ion_exchange_multicomponent_base.Resin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)