Ian Bell 267d64533a Superancillaries for pure fluids (#2511)
* Expansions are fully wrapped, looking good. Next step is the set of expansions that is the 1D approximation

* Get 1D approx working via cython

* Count solutions

* SuperAncillary class is working

>1000x speedup for water
Time for C++!

* Superancillaries are working!

In C++, speedup is more than 2000x. In Python, more like 150x because of Python <-> C++ overhead

* Add pmax check for PQ superancillary calls

* Update tests

* Allow T limits to be obtained

* Implement get_fluid_parameter_double for getting superanc value

* Add tests for getting parameters from superanc

* Script for testing superancillaries for sphinx

* Microoptimizations; don't help speed

The limiting factor remains the clear function, which takes about 30 ns

* Add R125 superancillary

* Use the release from fastchebpure for the files

* Drop a .gitignore in the unzipped folder

* Update superancillary injection script

* Turn on superancillaries by default

* Missing header

* Many int conversions in superancillary

* Another int cast

* More annoying solution for boost iter max

* Fix warnings

* One more warning

* Clear up the calculation of rho

* Update docs_docker-build.yml

Use arm64 since the containers were built on mac

* Superfluous ;

* Update backend.py

* Get the critical points working for superancillaries

* Fix wrapping changes of xmin&xmax methods

* squelch warnings

* Version 0 of jupyter notebook for docs

* Try to add the notebook to the docs

* Add jupyter notebook for superancillary

* Lots of updates to superancillary notebook

* More updates to docs

* Skip pseudo-pure for superancillary docs

* Fix output of superancillary figures

* Add superancillary plots to docs for the page for each fluid

* Make a placeholder figure for fluids without superancillary

* Add superancillary plots to task list

* Bump to release fixing m-xylene

* Relax the location of the REFPROP stuff

* Change default name for R-1336mzz(E)

* No need for figures to be so large

* Don't need REFPROP setting

* Bump to fastchebpure release with methanol

* Benchmark caching options

* Benchmark more granularly

* Add the fast methods to public API for HEOS class

* Back to memset - can memset with 0 but no other value

* Fix how caching is managed in Helmholtz class

* Close to final implementation

Perhaps a tiny bit more optimization possible?

* Update function name

* Make message more accurate

* Fix init order

* Expose update_QT_pure_superanc to Python

* Fix when _reducing is set for pures

* Fix the post_update

* Indent

* Notebook

* Notebook

* Make ln(p) construction lazy

Only really matters for debug builds

* Also make reference non-const

* Inject superancillary for methanol

* Make the superancillary loading entirely lazy in debug

* Fix PH bug for Nitrogen

 Closes #2470

* Force the clear to be called on SatL and SatV

To invalidate them at start

* Default is non-lazy superancillary loading

* Add CMake option to have lazy-loading superancillaries [skip ci]

Not a good idea unless doing very narrow testing
2025-05-17 20:27:19 -04:00
2018-03-06 07:51:58 -07:00
2023-06-19 13:42:09 -04:00
2018-04-17 09:46:37 +02:00
2025-05-07 20:32:38 -04:00
2018-08-14 23:06:49 -06:00

Welcome to CoolProp 
===================

CoolProp is a thermophysical property database and wrappers for a selection of programming environments. 
It offers similar functionality to REFPROP, but CoolProp is open-source and free. 
It was originally developed by Ian Bell, at the time a post-doc at the University of Liege, in Liege, Belgium.

* CoolProp has flexible licensing terms: Commercial - ok! Academic? - ok! |ghlicense|

* For Python, get the latest release via ``pip install coolprop`` |pypidownloads| |pypiversion| 

* ... other binaries are available from `SourceForge <http://sourceforge.net/projects/coolprop/files>`_  |sfdownloads| |ghversion|

* There is also a bleeding edge nightly build of the `development version <http://sourceforge.net/projects/coolprop/files/CoolProp/nightly>`_ .

* The documentation is available for the `latest release <http://www.coolprop.org>`_ and the `development version <http://www.coolprop.org/dev>`_  

* For any kind of question regarding CoolProp and its usage, you can ask the `CoolProp Discussions <https://github.com/CoolProp/CoolProp/discussions>`_

* ... you might also find answers in our `FAQ <https://github.com/CoolProp/CoolProp/blob/master/FAQ.md>`_ 

* If you found a bug or have an issue that requires the developers to become active, please file an issue in our `issue tracker <https://github.com/CoolProp/CoolProp/issues>`_ 

* `Contributions <https://github.com/CoolProp/CoolProp/blob/master/.github/CONTRIBUTING.md>`_ to this project are welcomed and encouraged!  If you wish to `contribute <https://github.com/CoolProp/CoolProp/blob/master/.github/CONTRIBUTING.md>`_ bug fixes, patches, or new features, wrappers, or material properties, please submit a Pull Request with your code.

* If you are new to Git and Github, please see the `CoolProp Wiki <https://github.com/CoolProp/CoolProp/wiki>`_ for guidance on becoming a contributor to the project.

* Accelerate development of things you really need implemented by posting at `Bountysource <https://www.bountysource.com/teams/coolprop>`_ 

* Have a look at the coverity stats |coveritystatus|

.. 
   Downloads and other stats
   -------------------------
   
   ===============  ==============================
   Binary release:  |sfdownloads| |ghversion| 
   PyPI release:    |pypidownloads| |pypiversion|
   ===============  ==============================




.. |ghversion| image:: https://img.shields.io/github/release/CoolProp/CoolProp.svg?label=SF-binaries
    :alt: CoolProp version tag

.. |sfdownloads| image:: https://img.shields.io/sourceforge/dm/CoolProp.svg?label=SF-downloads
    :target: http://sourceforge.net/projects/coolprop/files
    :alt: sourceforge downloads

.. |pypidownloads| image:: https://img.shields.io/pypi/dm/CoolProp.svg?label=PyPI-downloads
    :target: http://pypi.python.org/pypi/CoolProp/
    :alt: PyPI downloads

.. |pypiversion| image:: https://img.shields.io/pypi/v/coolprop.svg?label=PyPI-binaries
    :target: http://pypi.python.org/pypi/CoolProp/
    :alt: PyPI version

.. |ghlicense| image:: https://img.shields.io/github/license/CoolProp/CoolProp.svg
    :target: https://github.com/CoolProp/CoolProp/blob/master/LICENSE
    :alt: license

.. |travisbuilds| image:: https://travis-ci.org/CoolProp/CoolProp.svg?branch=master
    :target: https://travis-ci.org/CoolProp/CoolProp
    :alt: Travis CI builds

.. |coveritystatus| image:: https://scan.coverity.com/projects/4375/badge.svg
    :target: https://scan.coverity.com/projects/coolprop
    :alt: Coverity Scan Build Status

.. 
   image:: https://www.bountysource.com/badge/team?team_id=14160&style=raised
    
.. |bounties| image:: https://img.shields.io/bountysource/team/coolprop/activity.svg
   :alt: Post a bounty at https://www.bountysource.com/teams/coolprop
   :target: https://www.bountysource.com/teams/coolprop?utm_source=CoolProp&utm_medium=shield&utm_campaign=raised

.. 
   image:: https://badges.gitter.im/Join%20Chat.svg
   :alt: Join the chat at https://gitter.im/CoolProp/CoolProp
   :target: https://gitter.im/CoolProp/CoolProp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
Description
No description provided
Readme MIT Cite this repository 50 MiB
Languages
C++ 59%
Python 24.5%
CMake 2.5%
TeX 2.3%
Cython 2.3%
Other 9%