Skip to content

Commit

Permalink
Mark new features
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl authored and speth committed Jan 12, 2023
1 parent 88c306b commit 2d97daf
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions include/cantera/base/AnyMap.h
Expand Up @@ -449,6 +449,7 @@ class AnyMap : public AnyBase
std::string keys_str() const;

//! Return an unordered set of keys
//! @since New in Cantera 3.0.
std::set<std::string> keys() const;

//! Set a metadata value that applies to this AnyMap and its children.
Expand Down
4 changes: 4 additions & 0 deletions include/cantera/base/SolutionArray.h
Expand Up @@ -20,6 +20,10 @@ class ThermoPhase;
* thermodynamic states using the same Solution object. C++ SolutionArray objects are
* one-dimensional by design; extensions to multi-dimensional arrays need to be
* implemented in high-level API's.
*
* @since New in Cantera 3.0.
* @warning This function is an experimental part of the %Cantera API and may be
* changed or removed without notice.
*/
class SolutionArray
{
Expand Down
4 changes: 4 additions & 0 deletions include/cantera/base/Storage.h
Expand Up @@ -48,6 +48,10 @@ namespace Cantera

/*!
* A wrapper class handling storage to HDF; acts as a thin wrapper for HighFive
*
* @since New in Cantera 3.0.
* @warning This function is an experimental part of the %Cantera API and may be
* changed or removed without notice.
*/
class Storage
{
Expand Down
1 change: 1 addition & 0 deletions include/cantera/base/global.h
Expand Up @@ -106,6 +106,7 @@ std::string gitCommit();
bool debugModeEnabled();

//! Returns true if Cantera was compiled with C++ HighFive HDF support.
//! @since New in Cantera 3.0.
bool usesHighFive();

/*!
Expand Down
2 changes: 2 additions & 0 deletions include/cantera/base/stringUtils.h
Expand Up @@ -112,6 +112,8 @@ void tokenizeString(const std::string& oval,
*
* @param oval String to be broken up
* @param v Output vector of tokens.
*
* @since New in Cantera 3.0.
*/
void tokenizePath(const std::string& oval,
std::vector<std::string>& v);
Expand Down
4 changes: 4 additions & 0 deletions include/cantera/oneD/Domain1D.h
Expand Up @@ -319,6 +319,8 @@ class Domain1D
//! Save the state of this domain as a SolutionArray
/*!
* @param soln local solution vector for this domain
*
* @since New in Cantera 3.0.
*/
virtual std::shared_ptr<SolutionArray> asArray(const double* soln) const;

Expand All @@ -337,6 +339,8 @@ class Domain1D
* @param[out] soln Value of the solution vector, local to this domain
* @param[in] loglevel 0 to suppress all output; 1 to show warnings; 2 for
* verbose output
*
* @since New in Cantera 3.0.
*/
virtual void restore(SolutionArray& arr, double* soln, int loglevel);

Expand Down
2 changes: 2 additions & 0 deletions include/cantera/oneD/Sim1D.h
Expand Up @@ -123,6 +123,7 @@ class Sim1D : public OneDim

/**
* Save the current solution to YAML (legacy implementation). @see save
* @since New in Cantera 3.0.
*/
void write_yaml(const std::string& fname, const std::string& id,
const std::string& desc, int loglevel=1);
Expand All @@ -148,6 +149,7 @@ class Sim1D : public OneDim
/**
* Initialize the solution with a previously-saved solution (legacy implementation).
* @see restore
* @since New in Cantera 3.0.
*/
void read_yaml(const std::string& fname, const std::string& id, int loglevel=2);

Expand Down
4 changes: 4 additions & 0 deletions interfaces/cython/cantera/_onedim.pyx
Expand Up @@ -1486,6 +1486,8 @@ cdef class Sim1D:
quiet=True):
"""
Save the solution in YAML format (legacy implementation)
.. versionadded:: 3.0
"""
loglevel = 1 - quiet
self.sim.write_yaml(stringify(str(filename)), stringify(name),
Expand All @@ -1510,6 +1512,8 @@ cdef class Sim1D:
def read_yaml(self, filename, name='solution', description='none', quiet=True):
"""
Set the solution vector to a previously-saved solution (legacy implementation)
.. versionadded:: 3.0
"""
loglevel = 2 * (1 - quiet)
self.sim.read_yaml(stringify(str(filename)), stringify(name), loglevel)
Expand Down
2 changes: 2 additions & 0 deletions interfaces/cython/cantera/_utils.pyx
Expand Up @@ -98,6 +98,8 @@ def hdf_support():
Returns list of libraries that include HDF support:
- 'h5py': HDF support by Python package 'h5py'.
- 'HighFive': if Cantera was compiled with C++ HighFive HDF support.
.. versionadded:: 3.0
"""
out = []
try:
Expand Down

0 comments on commit 2d97daf

Please sign in to comment.