From 02f24549e44b2ae0b60662cbd21a806231f28ccc Mon Sep 17 00:00:00 2001 From: Ian Bell Date: Sun, 1 Jun 2014 20:49:50 +0200 Subject: [PATCH] Docs for get_fluid_param_string --- include/CoolProp.h | 11 +++++++++-- src/main.cxx | 4 ++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/include/CoolProp.h b/include/CoolProp.h index b68fcb55..744f58c5 100644 --- a/include/CoolProp.h +++ b/include/CoolProp.h @@ -82,9 +82,16 @@ You might want to start by looking at CoolProp.h /// @returns long element from global type enumeration long getFluidType(std::string FluidName);*/ - /// Get a string for a value from a fluid (numerical values can be obtained from Props1 function) + /// Get a string for a value from a fluid (numerical values for the fluid can be obtained from Props1SI function) /// @param FluidName The name of the fluid that is part of CoolProp, for instance "n-Propane" - /// @param ParamName A string, one of "aliases", "CAS", "CAS_number", "ASHRAE34", "REFPROPName","REFPROP_name", + /// @param ParamName A string, can be in one of the terms described in the following table + /// + /// ParamName | Description + /// -------------------------- | ---------------------------------------- + /// "aliases" | A comma separated list of aliases for the fluid + /// "CAS", "CAS_number" | The CAS number + /// "ASHRAE34" | The ASHRAE standard 34 safety rating + /// "REFPROPName","REFPROP_name" | The name of the fluid used in REFPROP /// @returns str The string, or an error message if not valid input std::string get_fluid_param_string(std::string FluidName, std::string ParamName); diff --git a/src/main.cxx b/src/main.cxx index b0d58124..261fc9be 100644 --- a/src/main.cxx +++ b/src/main.cxx @@ -56,7 +56,7 @@ struct element }; int main() { - set_debug_level(10); + set_debug_level(0); if (0) { generate_melting_curve_data("Ethylene-I.mlt","ethylene",103.989,110.369); @@ -134,7 +134,7 @@ int main() } if (1) { - std::string RPname = get_fluid_param_string("Water","REFPROPname"); + std::string RPname = get_fluid_param_string("Water", "REFPROPname"); std::string s = get_BibTeXKey("n-Propane", "rr"); std::vector tags;