arfc · katyhuff · Feb 25, 2021 · Jan 14, 2021 · Jan 14, 2021 · Jan 14, 2021
diff --git a/saltproc/__init__.py b/saltproc/__init__.py
@@ -10,3 +10,5 @@
 from .simulation import *
 from .process import *
 from .reactor import *
+from .sparger import *
+from .separator import *
diff --git a/saltproc/app.py b/saltproc/app.py
@@ -3,6 +3,8 @@
 from saltproc import Materialflow
 from saltproc import Process
 from saltproc import Reactor
+from saltproc import Sparger
+from saltproc import Separator
 # from depcode import Depcode
 # from simulation import Simulation
 # from materialflow import Materialflow
@@ -162,8 +164,15 @@ def read_processes_from_input():
         for mat, value in j.items():
             processes[mat] = OrderedDict()
             for obj_name, obj_data in j[mat]['extraction_processes'].items():
-                print("Processs object data", obj_data)
-                processes[mat][obj_name] = Process(**obj_data)
+                print("Processs object data: ", obj_data)
+                st = obj_data['efficiency']
+                if obj_name == 'sparger' and st == "self":
+                    processes[mat][obj_name] = Sparger(**obj_data)
+                elif obj_name == 'entrainment_separator' and st == "self":
+                    processes[mat][obj_name] = Separator(**obj_data)
+                else:
+                    processes[mat][obj_name] = Process(**obj_data)
+
         gc.collect()
         return processes
 

diff --git a/saltproc/separator.py b/saltproc/separator.py
@@ -0,0 +1,122 @@
+from saltproc import Process
+
+
+class Separator(Process):
+    """Class evaluates gas removal efficiency in separator (bubble separator).
+
+    Attributes
+    ----------
+    qe : float
+        liquid flow rate (m^3/s)
+        default: same as the value in q_salt defined in sparger class
+    qg : float
+        gas flow rate (m^3/s)
+        default: same as the value in q_he defined in sparger class
+    pgamma : float
+        the pressure at the densitometer station
+    x : float
+        the gas injection rate
+        default: 5% of total flow
+
+    Methods
+    -------
+    eff()
+        Evaluates gas removal efficiency using Eq. 6 from Gabbard's report. [1]
+    description()
+        Contains a dictionary of plot properties.
+    calc_rem_efficiency(el_name)
+        Overrides exiting method in Parent class.
+
+    References
+    ----------
+    [1] Gabbard, C. H. Development of an axial-flow centrifugal gas bubble
+    separator for use in MSR xenon removal system. United States: N. p.,
+    1974. Web. doi:10.2172/4324438.
+    """
+
+    def __init__(self, qe=0.1, qg=0.005, pgamma=10, x=0.05,
+                 *initial_data, **kwargs):
+        """ Initializes the Separator object.
+
+        Parameters
+        ----------
+        qe : float
+            liquid flow rate (m^3/s)
+            default: same as the value in q_salt defined in sparger class
+        qg : float
+            gas flow rate (m^3/s)
+            default: same as the value in q_he defined in sparger class
+        pgamma : float
+            the pressure at the densitometer station
+            default: from Gabbard's report [1]
+        x : float
+            the gas injection rate
+            default: 5% of total flow
+        """
+        super().__init__(*initial_data, **kwargs)
+        self.qe = qe
+        self.qg = qg
+        self.pgamma = pgamma
+        self.x = x
+        self.efficiency = self.eff()
+
+    def calc_rem_efficiency(self, el_name):
+        """Overrides the existing method in Process class to provide
+        efficiency values of target isotopes calculated in eff() function.
+
+        Parameters
+        ----------
+        el_name : str
+            Name of target element to be removed.
+
+        Returns
+        -------
+        efficiency : float
+            Extraction efficiency for el_name element.
+
+        """
+        efficiency = self.eff()[el_name]
+
+        return efficiency
+
+    def description(self):
+        """Class attributes' descriptions for plotting purpose in
+        sensitivity analysis
+
+        Returns
+        ------
+        pltdict: dict
+            contains instances' information
+        """
+        plt_dict = {'qe': {'xaxis': 'liquid flow rate ${(m^3/s)}$',
+                           'fname': 'liquid_flow_rate'},
+                    'qg': {'xaxis': 'gas flow rate ${(m^3/s)}$',
+                           'fname': 'gas_flow_rate'},
+                    'pgamma': {'xaxis': 'densitometer pressure ${(Pa)}$',
+                               'fname': 'densitometer_pressure'},
+                    'x': {'xaxis': 'the gas injection rate ${(m)}$',
+                          'fname': 'the gas_injection_rate'},
+                    }
+
+        return plt_dict
+
+    def eff(self):
+        """ Evaluates gas removal efficiency using Equation 6
+         from Gabbard's report. [1]
+
+        Returns
+        -------
+        rem_eff : dict
+            Dictionary that contains removal efficiency of each target
+            element.
+
+            ``key``
+                Name of target isotope.
+            ``value``
+                removal efficiency.
+        """
+        sep_eff = (2116.8 * self.qg) /\
+                  (self.x * self.qe * self.pgamma + 2116.8 * self.qg)
+        rem_eff = {'Xe': sep_eff, 'Kr': sep_eff, 'H': sep_eff}
+
+        return rem_eff
diff --git a/saltproc/sparger.py b/saltproc/sparger.py
@@ -0,0 +1,224 @@
+import numpy as np
+from saltproc import Process
+
+
+class Sparger(Process):
+    """Class evaluates gas removal efficiency in sparger (bubble generator).
+
+    Attributes
+    ----------
+    h_const : dict
+        ``key``
+            Name of target isotope.
+        ``value``
+            Henry's law constant.
+    gas_const : real
+        universal gas constant (Pa.m^3/mol-K)
+    diffusivity : real
+        liquid phase diffusivity (cm^2/s)
+    temp_room: real
+        room temperature (Kelvin)
+    exp_const: dict
+        ``key``
+            Name of target isotope.
+        ``value``
+            exponential constant from following reference
+    q_salt : float
+        volumetric salt flow rate (m^3/s)
+    q_he : float
+        volumetric helium flow rate (m^3/s)
+    length : float
+        sparger/contractor length (m)
+    ds : float
+        sparger/contractor (pipe) diameter (m)
+    db : float
+        bubble diameter (m) for bubble generator/separator
+    temp_salt: float
+        salt temperature (K)
+    area : float
+        contactor cross-section (m^2)
+
+    Methods
+    -------
+    eps(h_const, kl_const)
+        Defines gas removal efficiency for sparger (bubble generator)
+        using Eq. 4 from Peebles report (ORNL-TM-2245). [2]
+    eff()
+        Evaluates gas removal efficiencies for target isotopes.
+    sherwood()
+        Contains Sherwood number correlations from different sources.
+    description()
+        Contains a dictionary of plot properties.
+    calc_rem_efficiency(el_name)
+        Overrides exiting method in Parent class.
+
+    References
+    ----------
+    [1] Henry's law constants (Pa.m3/mol) for Xe, Kr, H from
+    Sander, R.: Compilation of Henry's law constants (version 4.0)
+    for water as solvent, Atmos. Chem. Phys., 15, 4399–4981,
+    https://doi.org/10.5194/acp-15-4399-2015, 2015.
+    [2] Peebles, F. , 1968, “ Removal of Xenon-135 From Circulating
+    Fuel Salt of the MSBR by Mass Transfer to Helium Bubbles,” Oak Ridge
+    National Laboratory, Oak Ridge, TN, Report No. ORNL-TM-2245.
+    [3] Jiaqi Chen and Caleb S. Brooks. Milestone 1.2 Report: CFD
+    Sensitivity Analysis. In preparation
+    """
+
+    diffusivity = 2.5E-9
+    gas_const = 8.314
+    h_const = {'Xe': 4.3e-5, 'Kr': 2.5e-5, 'H': 2.6e-6}
+    temp_room = 298.15
+    exp_const = {'Xe': 2300, 'Kr': 1900, 'H': 0}
+
+    def __init__(self, q_salt=0.1, q_he=0.005, length=10,
+                 ds=0.1, db=0.001, temp_salt=900, corr='Jiaqi',
+                 *initial_data, **kwargs):
+        """ Initializes the Sparger object.
+
+        Parameters
+        ----------
+        q_salt : float
+            volumetric salt flow rate (m^3/s)
+        q_he : float
+            volumetric helium flow rate (m^3/s)
+        length : float
+            sparger/contractor length (m)
+        ds : float
+            sparger/contractor (pipe) diameter (m)
+        db : float
+            bubble diameter (m) for bubble generator/separator
+        temp_salt: float
+            salt temperature (K)
+        area : float
+            contactor cross-section (m^2)
+        corr: string
+             Sherwood correlations: ORNL-TM-2245 or Jaiqi's
+             (1) milestone report from Jiaqi [3]
+             (2) ORNL-TM-2245 Eq.36 [2]
+             default: Sherwood correlation from ORNL-TM-2245 Eq.36
+
+        Notes
+        -----
+        Default values comes from Jiaqi's simulation
+        """
+        super().__init__(*initial_data, **kwargs)
+        self.q_salt = q_salt
+        self.q_he = q_he
+        self.length = length
+        self.ds = ds
+        self.db = db
+        self.temp_salt = temp_salt
+        self.area = np.pi * (self.ds / 2) ** 2
+        self.corr = corr
+        self.efficiency = self.eff()
+
+    def calc_rem_efficiency(self, el_name):
+        """Overrides the existing method in Process class to provide
+        efficiency values of target isotopes calculated in eff() function.
+
+        Parameters
+        ----------
+        el_name : str
+            Name of target element to be removed.
+
+        Returns
+        -------
+        efficiency : float
+            Extraction efficiency for el_name element.
+
+        """
+        efficiency = self.eff()[el_name]
+
+        return efficiency
+
+    def description(self):
+        """Class attributes' descriptions for plotting purpose in sensitivity
+        analysis
+        Return
+        ------
+        pltdict: dict
+            contains instances' information
+        """
+        plt_dict = {'q_salt': {'xaxis': 'salt flow rate ${(m^3/s)}$',
+                               'fname': 'salt_flow_rate'},
+                    'q_he': {'xaxis': 'helium flow rate ${(m^3/s)}$',
+                             'fname': 'helium_flow_rate'},
+                    'length': {'xaxis': 'sparger pipe length ${(m)}$',
+                               'fname': 'sparger_pipe_length'},
+                    'ds': {'xaxis': 'sparger pipe diameter ${(m)}$',
+                           'fname': 'sparger_pipe_diameter'},
+                    'db': {'xaxis': 'bubble diameter ${(m)}$',
+                           'fname': 'bubble_diameter'},
+                    'temp_salt': {'xaxis': 'average salt temperature ${(K)}$',
+                                  'fname': 'average_salt_temperature'}
+                    }
+
+        return plt_dict
+
+    def eps(self, h_const, kl_const):
+        """Evaluates gas removal efficiency using Eq. 4
+        from Peebles report (ORNL-TM-2245).
+
+        Returns
+        -------
+        efficiency : float
+            removal efficiency of a specific chemical element.
+
+        """
+        a = (6/self.db) * (self.q_he / (self.q_he + self.q_salt))
+        alpha = (self.gas_const * self.temp_salt / h_const) *\
+                (self.q_salt / self.q_he)
+        beta = (kl_const * a * self.area *
+                self.length * (1 + alpha)) / self.q_salt
+
+        return (1-np.exp(-beta))/(1+alpha)
+
+    def sherwood(self):
+        """ Contains Sherwood number correlations.
+             Sherwood correlations: ORNL-TM-2245 or Jaiqi
+             (1) Jaiqi Ph.D. dissertation
+             (2) ORNL-TM-2245 Eq.36
+             default: Sherwood correlation from ORNL-TM-2245 Eq.36
+         """
+        sh_corr = {
+            'ORNL-TM-2245': '0.0096 * (number_re**0.913) * (number_sc**0.346)',
+            'Jiaqi': '2.06972 * (number_re ** 0.555) * (number_sc ** 0.5)'}
+
+        return sh_corr
+
+    def eff(self):
+        """Evaluates gas removal efficiencies for target isotopes.
+        In this function, vl, mu, rho, number_sh, number_sc, number_re and kl
+        are average liquid velocity (m/s), kinematic viscosity (Pa.s),
+        density (kg/m^3), sherwood number from slide 8 developed by Jiaqi,
+        schmidt number, reynold number and liquid phase mass transfer
+        coefficient (m/s), respectively.
+
+        Returns
+        -------
+        rem_eff : dict
+            Dictionary containing removal efficiency of each target isotope.
+            ``key``
+                Name of target isotope.
+            ``value``
+                removal efficiency.
+        """
+        hh = {}
+        for key in self.h_const:
+            hh[key] = 1 / (self.h_const[key] *
+                           np.exp(self.exp_const[key] * (1/self.temp_salt -
+                                                         1/self.temp_room)))
+
+        mu = 1.076111581e-2 * (self.temp_salt / 1000)**(-4.833549134)
+        rho = (6.105 - 0.001272 * self.temp_salt) * 1000
+        nu = mu / rho
+        vl = self.q_salt / self.area
+        number_re = self.ds * vl / nu
+        number_sc = nu / self.diffusivity
+        number_sh = eval(self.sherwood()[self.corr],
+                         {'number_sc': number_sc, 'number_re': number_re})
+        kl = number_sh * self.diffusivity / self.ds
+        rem_eff = {key: self.eps(hh[key], kl) for key in self.h_const}
+
+        return rem_eff