text: ###############################################################################
  # WaterTAP Copyright (c) 2021, The Regents of the University of California,
  # through Lawrence Berkeley National Laboratory, Oak Ridge National
  # Laboratory, National Renewable Energy Laboratory, and National Energy
  # Technology Laboratory (subject to receipt of any required approvals from
  # the U.S. Dept. of Energy). All rights reserved.
  #
  # Please see the files COPYRIGHT.md and LICENSE.md for full copyright and license
  # information, respectively. These files are also available online at the URL
  # "https://github.com/watertap-org/watertap/"
  #
  ###############################################################################
  """
  Tests for zero-order electrodialysis reversal model
  """
  import pytest
  from io import StringIO
  
  from pyomo.environ import (
      Block,
      check_optimal_termination,
      ConcreteModel,
      Constraint,
      value,
      Var,
  )
  from pyomo.util.check_units import assert_units_consistent
  
  from idaes.core import FlowsheetBlock
  from idaes.core.util import get_solver
  from idaes.core.util.model_statistics import degrees_of_freedom
  from idaes.core.util.testing import initialization_tester
  from idaes.generic_models.costing import UnitModelCostingBlock
  
  from watertap.unit_models.zero_order import ElectrodialysisReversalZO
  from watertap.core.wt_database import Database
  from watertap.core.zero_order_properties import WaterParameterBlock
  from watertap.core.zero_order_costing import ZeroOrderCosting
  
  solver = get_solver()
  
  
  class TestElectrodialysisReversalZO_w_default_removal:
      @pytest.fixture(scope="class")
      def model(self):
          m = ConcreteModel()
          m.db = Database()
  
          m.fs = FlowsheetBlock(default={"dynamic": False})
          m.fs.params = WaterParameterBlock(default={"solute_list": ["tds", "foo"]})
  
          m.fs.unit = ElectrodialysisReversalZO(
              default={"property_package": m.fs.params, "database": m.db}
          )
  
          m.fs.unit.inlet.flow_mass_comp[0, "H2O"].fix(10000)
          m.fs.unit.inlet.flow_mass_comp[0, "tds"].fix(250)
          m.fs.unit.inlet.flow_mass_comp[0, "foo"].fix(1)
  
          return m
  
      @pytest.mark.unit
      def test_build(self, model):
          assert model.fs.unit.config.database is model.db
  
          assert isinstance(model.fs.unit.electricity_constraint, Constraint)
          assert isinstance(model.fs.unit.electricity, Var)
          assert isinstance(model.fs.unit.elec_coeff_1, Var)
          assert isinstance(model.fs.unit.elec_coeff_2, Var)
  
      @pytest.mark.component
      def test_load_parameters(self, model):
          data = model.db.get_unit_operation_parameters("electrodialysis_reversal")
          model.fs.unit.load_parameters_from_database(use_default_removal=True)
  
          assert model.fs.unit.recovery_frac_mass_H2O[0].fixed
          assert (
              model.fs.unit.recovery_frac_mass_H2O[0].value
              == data["recovery_frac_mass_H2O"]["value"]
          )
  
          for (t, j), v in model.fs.unit.removal_frac_mass_solute.items():
              assert v.fixed
              if j == "foo":
                  assert v.value == data["default_removal_frac_mass_solute"]["value"]
              else:
                  assert v.value == data["removal_frac_mass_solute"][j]["value"]
  
          assert model.fs.unit.elec_coeff_1.fixed
          assert model.fs.unit.elec_coeff_1.value == data["elec_coeff_1"]["value"]
          assert model.fs.unit.elec_coeff_2.fixed
          assert model.fs.unit.elec_coeff_2.value == data["elec_coeff_2"]["value"]
  
      @pytest.mark.component
      def test_degrees_of_freedom(self, model):
          assert degrees_of_freedom(model.fs.unit) == 0
  
      @pytest.mark.component
      def test_unit_consistency(self, model):
          assert_units_consistent(model.fs.unit)
  
      @pytest.mark.component
      def test_initialize(self, model):
          initialization_tester(model)
  
      @pytest.mark.solver
      @pytest.mark.skipif(solver is None, reason="Solver not available")
      @pytest.mark.component
      def test_solve(self, model):
          results = solver.solve(model)
  
          # Check for optimal solution
          assert check_optimal_termination(results)
  
      @pytest.mark.solver
      @pytest.mark.skipif(solver is None, reason="Solver not available")
      @pytest.mark.component
      def test_solution(self, model):
          assert pytest.approx(9.2628, rel=1e-5) == value(
              model.fs.unit.properties_treated[0].flow_vol
          )
          assert pytest.approx(5.1632, rel=1e-5) == value(
              model.fs.unit.properties_treated[0].conc_mass_comp["tds"]
          )
          assert pytest.approx(0.1079584, rel=1e-5) == value(
              model.fs.unit.properties_treated[0].conc_mass_comp["foo"]
          )
          assert pytest.approx(204.5935, rel=1e-5) == value(
              model.fs.unit.properties_byproduct[0].conc_mass_comp["tds"]
          )
          assert pytest.approx(1.01197e-08, rel=1e-5) == value(
              model.fs.unit.properties_byproduct[0].conc_mass_comp["foo"]
          )
          assert pytest.approx(472761.372, rel=1e-5) == value(
              model.fs.unit.electricity[0]
          )
          assert pytest.approx(12.8107, rel=1e-5) == value(
              model.fs.unit.electricity_intensity[0]
          )
  
      @pytest.mark.solver
      @pytest.mark.skipif(solver is None, reason="Solver not available")
      @pytest.mark.component
      def test_conservation(self, model):
          for j in model.fs.params.component_list:
              assert 1e-6 >= abs(
                  value(
                      model.fs.unit.inlet.flow_mass_comp[0, j]
                      - model.fs.unit.treated.flow_mass_comp[0, j]
                      - model.fs.unit.byproduct.flow_mass_comp[0, j]
                  )
              )
  
      @pytest.mark.component
      def test_report(self, model):
          stream = StringIO()
  
          model.fs.unit.report(ostream=stream)
  
          output = """
  ====================================================================================
  Unit : fs.unit                                                             Time: 0.0
  ------------------------------------------------------------------------------------
      Unit Performance
  
      Variables: 
  
      Key                                                : Value      : Fixed : Bounds
      Electricity intensity per Inlet Flowrate  (kWh/m3) :     12.811 : False : (None, None)
                                  Power Consumption (kW) : 4.7276e+05 : False : (0, None)
                                    Solute Removal [foo] :     0.0000 :  True : (0, None)
                                    Solute Removal [tds] :    0.80870 :  True : (0, None)
                                          Water Recovery :    0.92140 :  True : (1e-08, 1.0000001)
  
  ------------------------------------------------------------------------------------
      Stream Table
                               Inlet   Treated  Byproduct
      Volumetric Flowrate      10.251  9.2628     0.98817
      Mass Concentration H2O   975.51  994.73      795.41
      Mass Concentration tds   24.388  5.1632      204.59
      Mass Concentration foo 0.097551 0.10796  1.0120e-08
  ====================================================================================
  """
          assert output in stream.getvalue()
  
  
  def test_costing():
      m = ConcreteModel()
      m.db = Database()
  
      m.fs = FlowsheetBlock(default={"dynamic": False})
  
      m.fs.params = WaterParameterBlock(default={"solute_list": ["tds", "toc", "tss"]})
  
      m.fs.costing = ZeroOrderCosting()
  
      m.fs.unit1 = ElectrodialysisReversalZO(
          default={"property_package": m.fs.params, "database": m.db}
      )
  
      m.fs.unit1.inlet.flow_mass_comp[0, "H2O"].fix(10000)
      m.fs.unit1.inlet.flow_mass_comp[0, "tds"].fix(1)
      m.fs.unit1.inlet.flow_mass_comp[0, "toc"].fix(2)
      m.fs.unit1.inlet.flow_mass_comp[0, "tss"].fix(3)
      m.fs.unit1.load_parameters_from_database(use_default_removal=True)
      assert degrees_of_freedom(m.fs.unit1) == 0
  
      m.fs.unit1.costing = UnitModelCostingBlock(
          default={"flowsheet_costing_block": m.fs.costing}
      )
  
      assert isinstance(m.fs.costing.electrodialysis_reversal, Block)
      assert isinstance(m.fs.costing.electrodialysis_reversal.capital_a_parameter, Var)
      assert isinstance(m.fs.costing.electrodialysis_reversal.capital_b_parameter, Var)
      assert isinstance(m.fs.costing.electrodialysis_reversal.reference_state, Var)
  
      assert isinstance(m.fs.unit1.costing.capital_cost, Var)
      assert isinstance(m.fs.unit1.costing.capital_cost_constraint, Constraint)
  
      assert_units_consistent(m.fs)
      assert degrees_of_freedom(m.fs.unit1) == 0
  
      assert m.fs.unit1.electricity[0] in m.fs.costing._registered_flows["electricity"]
  
  
  db = Database()
  params = db._get_technology("electrodialysis_reversal")
  
  
  @pytest.mark.unit
  def test_no_tds_in_solute_list_error():
      m = ConcreteModel()
      m.fs = FlowsheetBlock(default={"dynamic": False})
      m.fs.params = WaterParameterBlock(default={"solute_list": ["foo"]})
  
      with pytest.raises(
          KeyError,
          match="TDS must be included in the solute list for determining"
          " electricity intensity and power consumption of the electrodialysis "
          "reversal unit.",
      ):
          m.fs.unit = ElectrodialysisReversalZO(
              default={"property_package": m.fs.params, "database": db}
          )
  