Add heat exchanger performance and cost components

[bayc]

Add HX performance and cost components

This PR adds a simple heat exchanger model, along with a cost model. This model is meant to be used with other models that are being developed, such as the electric thermal energy storage model #810 and a yet to be opened electric/natural gas boiler model PR. As such, an explicit example using this technology has not yet been added, but will be as part of an integrated example of these components.

This model is meant to accept two fluids, a source fluid (that brings the heat) and a working fluid (that removes the heat). I would appreciate specific review on the implementation of these inputs/outputs and whether they should be changed in some way to reflect commodity streams, or some other form.

Also, review of the organization of the code would be helpful. I originally had the specific heat exchanger functions located in a sub-folder converters/heat/heat_exchanger_model, but the current version has those functions integrated directly into the model class. So feedback on which method will determine what remains and what gets removed.

Docs will be updated once reviewed to be informed by any required changes.

Section 1: Type of Contribution

• Feature Enhancement
  • Framework
  • New Model
  • Updated Model
  • Tools/Utilities
  • Other (please describe):
• Bug Fix
• Documentation Update
• CI Changes
• Other (please describe):

Section 2: Draft PR Checklist

• Open draft PR
• Describe the feature that will be added
• Fill out TODO list steps
• Describe requested feedback from reviewers on draft PR
• Complete Section 7: New Model Checklist (if applicable)

TODO:

• Have TLDRD team review implementation of model.
• Determine whether an example is needed now or later (once other heat components get added).
• Ask for reviews from H2I team once above are complete.

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

• Feedback on the addition of a heat folder to the converters directory.

Implementation feedback:

• The specifications of the incoming and outgoing heat exchanging fluids as OpenMDAO inputs and outputs

Other feedback:

Section 3: General PR Checklist

• PR description thoroughly describes the new feature, bug fix, etc.
• Added tests for new functionality or bug fixes
• Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
• Documentation
  • Docstrings are up-to-date
  • Related docs/ files are up-to-date, or added when necessary
  • Documentation has been rebuilt successfully
  • Examples have been updated (if applicable)
• CHANGELOG.md has been updated to describe the changes made in this PR

Section 3: Related Issues

Section 4: Impacted Areas of the Software

Section 4.1: New Files

• converters/heat/shell_tube_hx.py
  • Contains the heat exchanger model.
• converters/heat/shell_tube_hx_cost_model.py
  • Contains the heat exchanger cost model.
• converters/heat/test/test_shell_tube_hx.py
  • Simple test for heat exchanger.
• converters/heat/test/test_shell_tube_hx_cost_model.py
  • Simple test for heat exchanger cost model.

Section 4.2: Modified Files

Section 5: Additional Supporting Information

Section 6: Test Results, if applicable

Section 7 (Optional): New Model Checklist

• Model Structure:
  • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
  • Used attrs class to define the Config to load in attributes for the model
    • If applicable: inherit from BaseConfig or CostModelBaseConfig
  • Added: initialize() method, setup() method, compute() method
    • If applicable: inherit from CostModelBaseClass
• Integration: Model has been properly integrated into H2Integrate
  • Added to supported_models.py
  • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
• Tests: Unit tests have been added for the new model
  • Pytest-style unit tests
  • Unit tests are in a "test" folder within the folder a new model was added to
  • If applicable add integration tests
• Example: If applicable, a working example demonstrating the new model has been created
  • Input file comments
  • Run file comments
  • Example has been tested and runs successfully in test_all_examples.py
• Documentation:
  • Write docstrings using the Google style
  • Model added to the main models list in docs/user_guide/model_overview.md
    • Model documentation page added to the appropriate docs/ section
    • <model_name>.md is added to the _toc.yml

[alidor85]

I don't know the source for this function, I would rather use something from a chemical plant design handbook.
From Sinott and Towler (2021):
U-tube shell and tube HX:
Total installed costs = [(a+b*S^n) * f_year * f_install * f_material]
a = 28000
b = 54
n = 1.2
S - heat transfer area in m^2
limits: 10 m^2 <= S <= 1000 m^2

This is in CEPCI index = 532.9 so need to be converted (it's for Jan. 2010)
To get it to 2022 USD f_year = 816/532.9

f_install = 1.61 (default, maybe let the user add their own?)

It also assums simple carbon steel, so we need to account for materials once temperatures are higher
f_material = 1 for carbon steel (should be a default value), if user specifies another more expensive material they should include f_material

For the OpEx I am not sure we want to include it in a cost function, this should be in the general economic calculation (like ProFAST)

[alidor85]

Do we want to add installation factor in here, or are those things usually accounted for elsewhere in H2I analysis?
I think in ther steel paper at least the cost functions are for totat installed costs

[elenya-grant]

Howdy Chris! I'm not sure whether this is ready for a full in-depth review yet but I left a few small comments and did a quick review (I will do another deeper-review once this is not longer a draft). Overall it seems like some very useful and cool functionality! Thanks for the work on this!

Some higher-level notes are:

• heat_exchanger_model/hx_shell_tube_steady.py: more inline comments and docstrings would be helpful in the functions defined in here
• Could you update the performance model to use the recently introduced PerformanceModelBaseClass? I'd be happy to help here if needed!
• Don't forget to add the performance and cost model(s) to supported_models.py

[kbrunik]

I really like the changes regarding the multivariable streams, it looks really great! I've left some additional comments throughout the PR, I am curious if there are situations that you would expect the heat exchanger to fail in and making sure we add in some safeguards to help protect the users. I think you're at the stage where you could add a doc page too! Thanks Chris for working on this :)

[kbrunik]

Yes, I think fewer files make it easier to follow and that having it in the class would be the preferred method

[kbrunik]

Nice! looks like it still should be added to the docstring but glad to see the extra args!

[kbrunik]

I'd recommend adding performance to the python file name to distinguish that this is just the performance model

[kbrunik]

Looks like this is still using the h2i validators, this was recently changed in PR #835 to just use the built in validators in attrs. I'll comment below the updated ways to use the validators

[kbrunik]

Here's the updated validator:

float = field(validator=validators.gt(0))

[kbrunik]

I think this is fine to keep as the CEPCI translation since it's technically more correct than a general inflation.

[kbrunik]

but can you update the validator to validator=validators.in_([2022])?

[kbrunik]

Updated install_factor, material_factor, opex_percentage validators to validator=gt(0)

[kbrunik]

Can you update the tests to use pytest subtests? It makes it faster to diagnose when/what is failing in the tests

[kbrunik]

can you add a test to make sure the "swap" functionality works?