Source code for idaes.models.separator

##############################################################################
# Institute for the Design of Advanced Energy Systems Process Systems
# Engineering Framework (IDAES PSE Framework) Copyright (c) 2018, by the
# software owners: The Regents of the University of California, through
# Lawrence Berkeley National Laboratory,  National Technology & Engineering
# Solutions of Sandia, LLC, Carnegie Mellon University, West Virginia
# University Research Corporation, et al. All rights reserved.
# 
# Please see the files COPYRIGHT.txt and LICENSE.txt for full copyright and
# license information, respectively. Both files are also available online
# at the URL "https://github.com/IDAES/idaes".
##############################################################################
"""
Standard IDAES Separator model.
"""
from __future__ import division

# Import Python libraries
import logging

# Import Pyomo libraries
from pyomo.common.config import ConfigValue, In

# Import IDAES cores
from idaes.core import UnitBlockData, declare_process_block_class, \
                       Holdup0D, HoldupStatic, CONFIG_Base
from idaes.core.util.config import list_of_strings
from idaes.core.util.misc import add_object_ref

__author__ = "Andrew Lee"


# Set up logger
logger = logging.getLogger('idaes.unit_model')


[docs]@declare_process_block_class("Separator") class SeparatorData(UnitBlockData): """ Standard Splitter Unit Class """ CONFIG = CONFIG_Base() # Set default values of inherited attributes CONFIG.get('dynamic')._default = False CONFIG.get('include_holdup')._default = False CONFIG.get("material_balance_type")._default = 'component_phase' CONFIG.get("energy_balance_type")._default = 'total' CONFIG.get("momentum_balance_type")._default = 'total' CONFIG.get("has_rate_reactions")._default = False CONFIG.get("has_equilibrium_reactions")._default = False CONFIG.get("has_phase_equilibrium")._default = False CONFIG.get("has_mass_transfer")._default = False CONFIG.get("has_heat_transfer")._default = False CONFIG.get("has_work_transfer")._default = False CONFIG.get("has_pressure_change")._default = False # Add unit model attributes CONFIG.declare("property_package", ConfigValue( default=None, description="Property package to use for holdup", doc="""Property parameter object used to define property calculations (default = 'use_parent_value') - 'use_parent_value' - get package from parent (default = None) - a ParameterBlock object""")) CONFIG.declare("property_package_args", ConfigValue( default={}, description="Arguments to use for constructing property packages", doc="""A dict of arguments to be passed to the PropertyBlockData and used when constructing these (default = 'use_parent_value') - 'use_parent_value' - get package from parent (default = None) - a dict (see property package for documentation)""")) CONFIG.declare("inlet_list", ConfigValue( domain=list_of_strings, description="List of inlet names", doc="""A list containing names of inlets (default = None) - None - default single inlet - list - a list of names for inlets""")) CONFIG.declare("num_inlets", ConfigValue( domain=int, description="Number of inlets to unit", doc="""Argument indication number (int) of inlets to construct (default = None). Not used if inlet_list arg is provided. - None - use inlet_list arg instead - int - Inlets will be named with sequential numbers from 1 to num_inlets""")) CONFIG.declare("outlet_list", ConfigValue( domain=list_of_strings, description="List of outlet names", doc="""A list containing names of outlets (default = None) - None - default single outlet - list - a list of names for outlets""")) CONFIG.declare("num_outlets", ConfigValue( domain=int, description="Number of outlets to unit", doc="""Argument indication number (int) of outlets to construct (default = None). Not used if outlet_list arg is provided. - None - use outlet_list arg instead - int - Outlets will be named with sequential numbers from 1 to num_outlets""")) CONFIG.declare("separation_type", ConfigValue( default="phase", domain=In(["phase", "component", "total"]), description="Method to use when separating outlet streams", doc="""Flag indicated which method to use for separating outlets (default = "phase") - "phase" - separate by phase fractions - "component" - separate by components - "total" - separate by phase and component"""))
[docs] def build(self): """ Begin building model (pre-DAE transformation). Args: None Returns: None """ # Call UnitModel.build to setup dynamics super(SeparatorData, self).build() # If no arguments provided for outlets, default to num_outlets = 2 if self.config.outlet_list is None and self.config.num_outlets is None: self.config.num_outlets = 2 # Build Holdup Block if (self.config.include_holdup is True or self.config.has_equilibrium_reactions is True or self.config.has_phase_equilibrium is True): self.holdup = Holdup0D() else: self.holdup = HoldupStatic()
[docs] def post_transform_build(self): """ Continue model construction after DAE transformation. Args: None Returns: None """ # Build Inlets # Construct Inlets self.build_inlets(inlets=self.config.inlet_list, num_inlets=self.config.num_inlets) # Build Outlets self.build_outlets(outlets=self.config.outlet_list, num_outlets=self.config.num_outlets, split_type=self.config.separation_type) # Make references to split fractions self._make_refs()
def _make_refs(self): """ Make references to splif fraction variables at unit level. Args: None Returns: None """ add_object_ref(self, "split_fraction", self.holdup.outlet_splitter.split_fraction)