From 9f04472cefdd9e290d5006c96dbf99a4e7850ac7 Mon Sep 17 00:00:00 2001 From: Ian Bell Date: Thu, 2 Oct 2014 17:01:33 +0200 Subject: [PATCH] Small docs modifications Signed-off-by: Ian Bell --- include/CoolPropFluid.h | 6 +++--- src/Backends/Helmholtz/PhaseEnvelopeRoutines.cpp | 1 + wrappers/Python/CoolProp/CoolProp.pxd | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/include/CoolPropFluid.h b/include/CoolPropFluid.h index eca84b00..5fea2933 100644 --- a/include/CoolPropFluid.h +++ b/include/CoolPropFluid.h @@ -447,9 +447,9 @@ class CoolPropFluid { std::string CAS; ///< The CAS number of the fluid std::vector aliases; ///< A vector of aliases of names for the fluid - BibTeXKeysStruct BibTeXKeys; - EnvironmentalFactorsStruct environment; - Ancillaries ancillaries; + BibTeXKeysStruct BibTeXKeys; ///< The BibTeX keys associated + EnvironmentalFactorsStruct environment; ///< The environmental variables for global warming potential, ODP, etc. + Ancillaries ancillaries; ///< The set of ancillary equations for dewpoint, bubblepoint, surface tension, etc. TransportPropertyData transport; SimpleState crit, ///< The state at the critical point triple_liquid, ///< The saturated liquid state at the triple point temperature diff --git a/src/Backends/Helmholtz/PhaseEnvelopeRoutines.cpp b/src/Backends/Helmholtz/PhaseEnvelopeRoutines.cpp index baa38d7e..34c1fd8b 100644 --- a/src/Backends/Helmholtz/PhaseEnvelopeRoutines.cpp +++ b/src/Backends/Helmholtz/PhaseEnvelopeRoutines.cpp @@ -414,6 +414,7 @@ std::vector > PhaseEnvelopeRoutines::find_in bool PhaseEnvelopeRoutines::is_inside(HelmholtzEOSMixtureBackend &HEOS, parameters iInput1, long double value1, parameters iInput2, long double value2, std::size_t &iclosest, SimpleState &closest_state) { PhaseEnvelopeData &env = HEOS.PhaseEnvelope; + // Find the indices that bound the solution(s) std::vector > intersections = find_intersections(HEOS, iInput1, value1); // For now, first input must be p diff --git a/wrappers/Python/CoolProp/CoolProp.pxd b/wrappers/Python/CoolProp/CoolProp.pxd index 9ba48844..20cdbd56 100644 --- a/wrappers/Python/CoolProp/CoolProp.pxd +++ b/wrappers/Python/CoolProp/CoolProp.pxd @@ -36,7 +36,7 @@ cdef extern from "CoolProp.h" namespace "CoolProp": void _set_debug_level "CoolProp::set_debug_level"(int level) except + string _get_fluid_param_string "CoolProp::get_fluid_param_string"(string ParamName, string FluidName) except + - # Convenience functions + # Convenience functions from v4 # long _get_parameter_index "CoolProp::get_parameter_index" (string param) # int _IsFluidType "IsFluidType"(char* Ref, char* Type) # string _get_BibTeXKey "CoolProp::get_BibTeXKey"(string Ref, string key)