FPROPS is a free open-source C-based library for high-accuracy evaluation of thermodynamic properties for a number of pure substances. It makes use of published data for the Helmholtz fundamental equation for those substances. It has been developed by John Pye and others, and will happily function as standalone code, but is also provided with external library code for ASCEND so that it can be used to access these accurate property correlations from within a MODEL.
Currently FPROPS supports calculation of the properties of the pure substances shown on the right. The properties that can be calculated are internal energy , entropy , pressure , enthalpy and Helmholtz energy , as well as various partial derivatives of these with respect to temperature and density.
FPROPS reproduces a limited subset of the functionality of commercial programs such as REFPROP, PROPATH, EES, FLUIDCAL, SteamTab and others, but is free open-source software, licensed under the GPL. Similar open-source libraries include freesteam and CoolProp. Contributions are most welcome!
Enhancement to FPROPS feature set and list of supported fluids has been going on as part of ASCEND's involvement in GSOC.
FPROPS is included in current versions of ASCEND, but you can also browse the source code at models/johnpye/fprops/ (current trunk) . Currently (Mar 2014), viscosity and thermal conductivity correlations are being implemented in FPROPS.
- 1 Implementation
- 2 Testing the code
- 3 Adding new fluids
- 4 Using within ASCEND
- 5 Using from C
- 6 Using from Python
- 7 Further work
- 8 References
- 9 Contributors
- 10 See Also
The calculation routines implement calculation of reduced Helmholtz energy as a function of reduced density and inverse reduced temperature , by dividing it into ideal and 'real' or 'residual' parts, as described in IAPWS-95.
Calculation of the ideal part of the reduced Helmholtz energy is derived from the expression for the zero-pressure limit of reduced specific heat capacity at constant pressure, , where is the specific gas constant.
An expression for can then be used to calculate ideal enthalpy, ideal entropy and ideal helmholtz energy as follows :
Combining these, an expression for calculating the nondimensionalised ideal component of Helmholtz energy from can be found, which incorporates additional correlation constants relating to the reference state : 
where the reduced temperature is and the reduced density is .
In the reverse direction, using the relations for the Helmholtz fundamental equation, an important result is
so coefficients of can be calculated from coefficients of (providing, we assume, that the fundamental equation has smooth first and second (and possibly third) derivatives). One can go the other way, and determine from , with the exception of the integration constants, which are, in that case, determined using specified values of enthalpy and entropy at a reference state
In FPROPS, then, we permit expressions of this form:
This corresponds, after the above transformation, to:
The conversion from terms to terms is as follows ():
|type||term in||term in||conversion|
|power terms|| |
|Planck-Einstein terms||where|| |
|'lead' terms||none required|
Note the factor '1' in the lead terms is not usually specified separately in publications; our code compensates for that when reading in data; you don't need to subtract 1 from the provided constant term.
If a publication provides , then the above allows calculation of .
If on the other hand a publication provides then we need to use the reference state properties , to define and , as follows:
where and .
However, if we are using this ideal correlation together with a 'real' part, then these constants and will instead take values determined from reference state properties , meaning that these expressions will be offset as a result of and variations.
For the residual part of the reduced Helmholtz energy, FPROPS currently supports three different kinds of terms:
These different terms are used in various combinations across a number of high-accuracy publications of thermodynamic property data. Overall, the residual series permits calculation of 'real' reduced Helmholtz energy and hence the specific Helmholtz energy .
From the expression for , we can then derive expressions for , , , and their partial derivatives with respect to density and temperature. These expressions are summarised in IAPWS-95 as well as by Tillner Roth et al.
Saturated mixture properties
The Helmholtz function , given above, applies for all regions outside the saturation region. The saturation region, on the other hand, is not calculated directly from the raw Helmholtz correlation. Instead within the saturation region, the stable equilibrium of phases must be calculated such that the liquid phase vapour phases have equal Gibbs free energy . This requirement is equivalent to the Maxwell equal area rule. The condition can be expressed as a set of three simultaneous equations in the variables :
This can be further reduced to :
Calculation of the phase equilibrium conditions requires iterative solution of these three equations; one suitable approach is that of Akasaka, which first eliminates from the above equations, then iterates only on and . The approach seems to be robust, with tests currently performed with a sample of five fluids including water, carbon-dioxide and nitrogen. Our code is in models/johnpye/fprops/sat.c.
The Akasaka approach is markedly simpler to implement that the complicated algorithm used in REFPROP (which is explained by Akasaka, and also by Soave). A limitation of the Soave approach is that it does not converge for temperatures , and hence requires yet another, even more complicated, algorithm to be implemented for that region (including need for the very tedious-to-calculate third partial derivatives !).
At present, we have implemented fprops_sat_p in models/johnpye/fprops/sat.c which provides a solution via simple Newton iteration that makes repeated calls to fprops_sat_T. The iteration makes use of the Clapeyron equation to calculate the gradients,
There is probably a more efficient approach, but this is adequate for the moment.
Thermodynamic property derivatives
The IAPWS has made a release with information about how partial derivatives of thermodynamic properties with respect to other properties can be calculated in general.
FPROPS includes an initial implementation of these derivative calculations in models/johnpye/fprops/derivs.c, but they have not yet been thoroughly tested.
Properties in terms of (p,h)
It seems to be very helpful to have property correlations calculable in terms of the independent variables (p,h). This seems to aid stability of calculation in larger systems, compared to the (v,T) property pair. This would appear to be in part due to the very small, steep subcooled region when using (v,T) coordinates.
An initial implementation of an iterative solver for properties in terms of (p,h) has been implemented for FPROPS in models/johnpye/fprops/solve_ph.c. Currently, it solves for all regions except for pressures below the triple-point pressure. We hope to overcome this problem soon.
Properties in terms of (T,x)
For convenience some simple functions for calculating properties in terms of have been written. The implementation is in models/johnpye/fprops/solve_Tx.c. Any input with outside or outside will return an error code. Otherwise, the corresponding rho () value will be returned such that is equivalent to the desired state.
A python demonstration of this code is in models/johnpye/fprops/python/solve_Tx.py, which gives the following output:
john@thunder:~/ascend/models/johnpye/fprops/python$ python solve_Tx.py solved state T = 300.000000, x = 0.500000 --> rho = 0.309802, h = 395476.135716, s = 381991.898474, u = 1491.770280 checking reverse solve: --> x = 0.500000
Initial implementations of dynamic viscosity and thermal conductivity have been created for carbon dioxide. Providing the fluid data supports this, you should be able to access these properties from Python, C and ASCEND. In Python,
from fprops import * D = fluid("carbondioxide") S = D.set_Trho(220,2.5) print "mu =",S.mu print "lam =",S.lam
Both properties are returned in base SI units (Pa*s for viscosity, and W/m·K for thermal conductvity).
Testing the code
FPROPS includes a suite of self tests for each fluid that has been implemented. Some of the test data comes from the publications from which the correlations have been taken; other test data comes from using the commercial package REFPROP to calculate some sample data points, and comparing the FPROPS output with that data.
To run the FPROPS tests for a given fluid, cd to the FPROPS directory (eg cd ~/ascend/models/johnpye/fprops</tdd>) then run the test script <tt>./test.py fluidname, for example:
./test.py hydrogen ./test.py nitrogen
Requires GNU scientific library(libgsl0-dev) to be installed in the system.
The output will tell you if all calculated values have conformed to expected error margins.
Test code for each fluid is (should be) embedded at the end of the corresponding fluid file, for example models/johnpye/fprops/fluids/hydrogen.c.
During development, some additional testing routines are in the python subdirectory. These include
- satcvgc.py to test converge of saturation region routines fprops_sat_T and fprops_sat_p are working.
- solve_ph_array to test convergence of the fprops_solve_ph routine, including plotting of regions where the routine is failing.
Adding new fluids
Currently, new fluids must be added by declaring constant data structures in C code.
An example of a fluid declaration is shown in models/johnpye/fprops/fluids/hydrogen.c.
After adding the data structures in "component".c file, a corresponding "component".h is required.
An example of which is shown in models/johnpye/fprops/fluids/hydrogen.h
The new component has to be declared in SConstruct and asc_helmholtz.c.
Note: when adding new fluids it is important to observe that different papers give different 'zero points' for enthalpy and entropy for the substances in question, and the zero points vary from paper to paper. These Helmholtz equations of state can be adjusted for different 'zero points' by adjusting the constant and linear parameters ('c' and 'm') in the IdealData object that is provided in your data structures. The equation to fix these values is
where we assume
In other words, to correct an offset in and , these formulae tell you the offset to apply to the constant and linear terms in .
Using within ASCEND
Note that the interface for accessing FPROPS is being changed significantly in 2012, in the 'fprops' branch code and work by Sean Muratet.
To use FPROPS from ASCEND, see the example code in models/johnpye/fprops/fprops_test.a4c. Essentially you must declare a DATA instance into which you must place the name of the substance for which you wish to calculate properties. Then you can use the functions
- helmholtz_p, to calculate p(T,rho)
- helmholtz_u, to calculate u(T,rho)
- helmholtz_h, to calculate h(T,rho)
- helmholtz_s, to calculate s(T,rho)
- helmholtz_a, to calculate a(T,rho)
- helmholtz_cp, to calculate cp(T,rho)
- helmholtz_cv, to calculate cv(T,rho)
- helmholtz_w, to calculate speed of sound for given (T,rho)
- helmholtz_phsx_vT is also available which returns p, h, s and x in for specified (v,T).
- helmholtz_Tvsx_ph returns T, v, s and x for specified (p,h). Recommended for energy system models.
Note. When solving properties in 'reverse' mode (eg solving for ρ,T when p,h are know), you will get significantly better results by switching the QRSlv solver parameter for 'convergence test' (convopt) to 'RELNOM_SCALE'. This significantly improves ASCEND's ability to solve these problems. Also, use OPTION iterationlimit 200 for larger models.
A first system model using FPROPS is available in models/johnpye/fprops/rankine_fprops.a4c. The key part is
cd IS_A fluid; cd.component :== 'water'; (* ...definitions of p, h, T, v, s, x omitted here... *) calc_ph: helmholtz_Tvsx_ph( p, h : INPUT; T, v, s, x : OUTPUT; cd : DATA );
Some details on the implementation of the 'wrapper' code for connecting FPROPS with ASCEND is given in writing ASCEND external relations in C.
Using from C
Using the FPROPS code from C should also be very straightforward once the relevant header files have been examined. Warning! We are still working on the API and it is subject to change, especially in the light of current GSOC2011 work.
A very simple test of selecting a fluid, then solving for (p,h) values and then returning results, is given in models/johnpye/fprops/test_ph.c (Note: this file is currently missing and needs to be restored.). An extract of that file is shown below:
double p = 1e5; double h = 3500e3;const char *fluid = "water"; double T = 0,rho = 0; const HelmholtzData *D = fprops_fluid(fluid); int res = fprops_solve_ph(p,h,&T, &rho, 0, D); if(res)printf("ERROR %d!)\n",res); printf("Result: T = %f K, rho = %f kg/m3\n",T,rho); double p1, h1; p1 = helmholtz_p(T,rho, D); h1 = helmholtz_h(T,rho, D); printf("Double check: h = %f kJ/kg\n",h1/1e3);
Other test code written in C is shown in models/johnpye/fprops/test.c, which may be helpful for seeing some other features in use.
At this stage no external documentation for the use of the C code has been written, other that what is on this page.
Using from Python
FPROPS can also be used from the Python language. There are a number of sample programs in models/johnpye/fprops/python. The API is still evolving as we seek the cleanest ways to report errors back to the user, and catch floating-point errors, etc.
At the conclusion of GSOC2012 with Sean Muratet, we completed implementation of a cubic EOS (Peng Robinson) as well as heavily-rewritten internal fluids database and data structures. Work continues in Sean's branch as well as the fprops2:models/johnpye/fprops branch.
At the end of GSOC2011 with Richard Towers, we concluded the following steps are required using his richard: branch as the basis. Further work is now (Aug 2011) goin on in the fprops2:models/johnpye/fprops branch.
checking/evaluatingthe proposed data structure (is the design there right?) and modifying if required
- fixing up broken ASCEND bindings
adding more fluid data, eg from critical point/omega data from RPP
- adding test code for PR EOS-based evaluations
- fixing up the PR EOS evaluation code until the test code works
- merging to trunk
extending python bindings to raise exceptions instead of returning error flags (nicer API design)
- performance testing, profiling, etc.
FPROPS is still under development! We aim to implement a few more features including
- Adding incompressible fluids EOS
- Adding additional cubic EOS
- Adding option for interpolation of saturation curve (as seen in CoolProp)
- Extend test suite with more comparison of RPP data and cubic EOS code
- Revisit derivatives calculation for new EOSes.
- Expose derivatives code to ASCEND and Python; extend ASCEND to support optimisation with external relations.
add support for calculation of the saturation curve using Maxwell phase-equilibrium condition
add iterative solver for properties in terms of (p,h)
support for Water using IAPWS-95 correlation (partially complete, but needs support for another type of residual function term).
refactor the 'HelmholtzExpTerm' which is actually a double of 'HelmholtzGausTerm' with epsilon = 1.
add support for calculation of partial derivatives dp/dT, dp/drho, dh/dT, dh/drho, du/dT, du/drho,ds/dT, ds/drho, da/dT, da/drho to improve convergence of ASCEND models that calculate p, h, u,s, a etc.
- investigate apparent disagreement between cp0 for ammonia in FPROPS and values from REFPROP (is it consistent with Tillner-Roth?)
- investigate apparent very small discrepancy between REFPROP and IAPWS95 in value of speed of sound near critical point.
move specification of the zero point out of IdealData and into HelmholtzData. Third law of thermodynamics? How to avoid correlations with negative h or s values?
implement a pre-calculation routine where for example coefficients of can be prepared?
- implement support for thermophysical properties conductivity, viscosity, surface tension, and possibly others.
implement support for calculation of the speed of sound.
resolve the confusion between T* and T_crit in the data structures. Probably all correlations will be using T_crit -- but is that sure?
remove p_c from HelmholtzData structure, because that value can be calculated using p(T_c,rho_c).
- add support for solving in terms of (p,h) where p < p_t, the triple point pressure.
- possibly some additional coefficients needs in order to support correlations such as for Methanol
add properties of R-134a (see doi:10.1063/1.555958)
Further down the track we would like to support:
- reading property correlations from a database (SQLite?) or text file.
- some simpler equations of state such as MBWR or Peng-Robinson.(Assigned to Ankit, see PengRobinson EOS in FPROPS)
- lots more fluids
- mixing models for multi-phase, multi-component systems (or else incorporate FPROPS into exist code that supports this).
- natural gas properties?
- air properties doi:10.1063/1.1285884
We'd be very pleased to be able to collaborate on this work with others; the code has been made deliberately able to stand alone; it has no dependency on any other code from ASCEND, and is suitable for incorporation into other open source programs, subject to the restrictions of the GPL license.
- E W Lemmon and R Span, 2006. Short Fundamental Equations of State for 20 Industrial Fluids, J. Chem. Eng. Data 51, doi:10.1021/je050186n
- Span & Wagner (1996), "A new equation of state for carbon dioxide covering from the triple point temperature to 1100 K at pressures up to 800 MPa" J. Phys. Chem. Ref. Data, 25 p 1509 ff, http://link.aip.org/link/?jpr/25/1509%26agg=NIST, doi:10.1063/1.555991
- Tillner-Roth, Harms-Watzenberg and Baehr (1993), "Eine neue Fundamentalgleichung für Ammoniak", DKV-Tagungsbericht, 20, 167-181
- Eubank & Hall (2004), "Equal area rule and algorithm for determining phase compositions", AIChE Journal, 41, doi:10.1002/aic.690410419
- Akasaka (2008) "A Reliable and Useful Method to Determine the Saturation State from Helmholtz Energy Equations of State", Journal of Thermal Science and Technology, 3, 442-451, doi:10.1299/jtst.3.442
- Soave (1986), "Direct calculation of pure-compound vapour pressures through cubic equations of state ", Fluid Phase Equilibria, 31, 203-207, doi:10.1016/0378-3812(86)90013-0
- Long X. Nghiem and Yau-Kun Li, 1985, Application of the tangent plane criterion to saturation pressure and temperature computations, Fluid Phase Equilibria, doi:10.1016/0378-3812(85)90059-7
- M Michelson, 1984, Saturation point calculations, Fluid Phase Equilibria, doi:10.1016/0378-3812(85)90005-6
- IAPWS, 2008, Revised Advisory Note No. 3 Thermodynamic Derivatives from IAPWS Formulation, http://www.iapws.org
- K de Reuck, 1993, Methanol, International Thermodynamic Tables of the Fluid State Vol. 12 (1993), Blackwell/IUPAC, http://www.iupac.org/objID/Source/sou65427568843800267934799
The people who have contributed code and/or implementable advice for FPROPS: