Skip to content

Commit

Permalink
Update version and comments
Browse files Browse the repository at this point in the history
  • Loading branch information
corykinney committed Sep 19, 2024
1 parent c96e16f commit 282ff60
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "sco2es"
version = "0.0.1"
version = "0.1.0"
description = "A supercritical CO2 packed bed thermal energy storage simulation tool."
authors = ["Cory Kinney <[email protected]>"]
readme = "README.md"
Expand Down
13 changes: 10 additions & 3 deletions sco2es/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
"""Copyright © 2024 UCFRF, Inc. All Rights Reserved."""

__version__ = "0.0.1"
__version__ = "0.1.0"

from .errors import StopCriterionError, ModelAssumptionError
from .properties import SolidProperties, Alumina
Expand Down Expand Up @@ -31,6 +29,15 @@ class PackedBed:
- Constant diameter
- Constant temperature exterior wall boundary condition
!!! Warning
The model was intended for use with sCO~2~ as the heat transfer fluid. The [`fluid`][sco2es.PackedBed.fluid] attribute can be
set to any `CoolProp.AbstractState` object, but the code has not been tested with any other fluid.
By default, `sco2es.PackedBed` uses [CoolProp](https://github.com/coolprop/coolprop) to calculate the properties of
CO~2~ and assumes that the solid particles are made of [`Alumina`][sco2es.properties.Alumina], for which empirical correlations are used to calculate
relevant properties. To use a material other than alumina, create a class matching the protocol
[`SolidProperties`][sco2es.properties.SolidProperties] and set the [`solid`][sco2es.PackedBed.solid] attribute.
!!! Info
Arrays are annotated with dimensions as follows:
Expand Down
1 change: 1 addition & 0 deletions sco2es/properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class Alumina(SolidProperties):
"""An implementation of experimental correlations for alumina's relevant properties."""

density = 3950
"""Density of alumina [kg/m^3^]."""

@staticmethod
def internal_energy(T):
Expand Down

0 comments on commit 282ff60

Please sign in to comment.