prommis.solvent_extraction.solvent_extraction_reaction_package#
Reaction package for solvent extraction of rare earth elements using DEHPA as extractant with TBP as a phase modifier. —————————————————————————————-
Author: Arkoprabho Dasgupta
This is an example of how to write a reaction package for rare earth elements involved in solvent extraction.
- class prommis.solvent_extraction.solvent_extraction_reaction_package.SolventExtractionReactionScaler(**kwargs)[source]#
Scaler for the solvent extraction reaction package.
- zero_tolerance
Value at which a variable will be considered equal to zero for scaling.
- max_variable_scaling_factor
Maximum value for variable scaling factors.
- min_variable_scaling_factor
Minimum value for variable scaling factors.
- max_constraint_scaling_factor
Maximum value for constraint scaling factors.
- min_constraint_scaling_factor
Minimum value for constraint scaling factors.
- max_expression_scaling_hint
Maximum value for expression scaling hints.
- min_expression_scaling_hint
Minimum value for constraint scaling hints.
- overwrite
Whether to overwrite existing scaling factors.
- constraint_scaling_routine(model, overwrite: bool = False, submodel_scalers: dict = None)[source]#
Routine to apply scaling factors to constraints in model.
Derived classes must overload this method.
- Parameters:
model – model to be scaled
overwrite – whether to overwrite existing scaling factors
submodel_scalers – ComponentMap of Scalers to use for sub-models
- Returns:
None
- variable_scaling_routine(model, overwrite: bool = False, submodel_scalers: dict = None)[source]#
Routine to apply scaling factors to variables in model.
Derived classes must overload this method.
- Parameters:
model – model to be scaled
overwrite – whether to overwrite existing scaling factors
submodel_scalers – ComponentMap of Scalers to use for sub-models
- Returns:
None
- class prommis.solvent_extraction.solvent_extraction_reaction_package.SolventExtractionReactions(*args, **kwds)#
- Parameters:
rule (function) – A rule function or None. Default rule calls build().
concrete (bool) – If True, make this a toplevel model. Default - False.
ctype (class) –
Pyomo ctype of the block. Default - pyomo.environ.Block
Config args
initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.
idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.
- Returns:
(SolventExtractionReactions) New instance
- class prommis.solvent_extraction.solvent_extraction_reaction_package.SolventExtractionReactionsBlock(*args, **kwds)#
- Parameters:
rule (function) – A rule function or None. Default rule calls build().
concrete (bool) – If True, make this a toplevel model. Default - False.
ctype (class) –
Pyomo ctype of the block. Default - pyomo.environ.Block
Config args
- parameters
A reference to an instance of the Heterogeneous Reaction Parameter Block associated with this property package.
initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.
idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.
- Returns:
(SolventExtractionReactionsBlock) New instance