CoolProp  4.2.5
An open-source fluid property and humid air property database
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Functions
CoolPropDLL.h File Reference
#include "CoolPropTools.h"

Go to the source code of this file.

Functions

EXPORT_CODE double CONVENTION Props1SI (const char *FluidName, const char *Output)
 
EXPORT_CODE double CONVENTION PropsSI (const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Ref)
 
EXPORT_CODE double CONVENTION PropsS (const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Ref)
 
EXPORT_CODE double CONVENTION Props (const char *Output, const char Name1, double Prop1, const char Name2, double Prop2, const char *Ref)
 
EXPORT_CODE double CONVENTION Props1 (const char *FluidName, const char *Output)
 
EXPORT_CODE int CONVENTION IsFluidType (const char *Ref, const char *Type)
 
EXPORT_CODE double CONVENTION DerivTerms (const char *Term, double T, double rho, const char *Ref)
 
EXPORT_CODE long CONVENTION Phase (const char *Fluid, double T, double p, char *Phase_str)
 
EXPORT_CODE long CONVENTION Phase_Trho (const char *Fluid, double T, double p, char *Phase_str)
 
EXPORT_CODE long CONVENTION Phase_Tp (const char *Fluid, double T, double rho, char *Phase_str)
 
EXPORT_CODE void CONVENTION set_phase (const char *Phase_str)
 
EXPORT_CODE double CONVENTION fromSI (const char *input, const double value, const char *new_system)
 
EXPORT_CODE double CONVENTION toSI (const char *input, const double value, const char *old_system)
 
EXPORT_CODE long CONVENTION get_global_param_string (const char *param, char *Output)
 
EXPORT_CODE long CONVENTION get_fluid_param_string (const char *fluid, const char *param, char *Output)
 
EXPORT_CODE int CONVENTION set_reference_stateS (const char *Ref, const char *reference_state)
 
EXPORT_CODE int CONVENTION set_reference_stateD (const char *Ref, double T, double rho, double h0, double s0)
 
EXPORT_CODE double CONVENTION IPropsSI (long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid)
 
EXPORT_CODE double CONVENTION IProps (long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid)
 
EXPORT_CODE double CONVENTION F2K (double T_F)
 Convert from degrees Fahrenheit to Kelvin (useful primarily for testing) More...
 
EXPORT_CODE double CONVENTION K2F (double T_K)
 Convert from Kelvin to degrees Fahrenheit (useful primarily for testing) More...
 
EXPORT_CODE int CONVENTION get_standard_unit_system ()
 
EXPORT_CODE void CONVENTION set_standard_unit_system (int val)
 
EXPORT_CODE long CONVENTION get_param_index (const char *param)
 
EXPORT_CODE long CONVENTION get_Fluid_index (const char *param)
 
EXPORT_CODE long CONVENTION redirect_stdout (const char *file)
 
EXPORT_CODE int CONVENTION get_debug_level ()
 
EXPORT_CODE void CONVENTION set_debug_level (int level)
 
EXPORT_CODE bool CONVENTION enable_TTSE_LUT (const char *FluidName)
 Enable the TTSE for this fluid. More...
 
EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT (const char *FluidName)
 Check if TTSE is enabled. More...
 
EXPORT_CODE bool CONVENTION disable_TTSE_LUT (const char *FluidName)
 Disable the TTSE. More...
 
EXPORT_CODE bool CONVENTION enable_TTSE_LUT_writing (const char *FluidName)
 Enable the writing of TTSE tables to file for this fluid. More...
 
EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT_writing (const char *FluidName)
 Check if the writing of TTSE tables to file is enabled. More...
 
EXPORT_CODE bool CONVENTION disable_TTSE_LUT_writing (const char *FluidName)
 Disable the writing of TTSE tables to file for this fluid. More...
 
EXPORT_CODE bool CONVENTION set_TTSESat_LUT_size (const char *FluidName, int)
 Over-ride the default size of both of the saturation LUT. More...
 
EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_size (const char *FluidName, int Np, int Nh)
 Over-ride the default size of the single-phase LUT. More...
 
EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_range (const char *FluidName, double hmin, double hmax, double pmin, double pmax)
 Over-ride the default range of the single-phase LUT. More...
 
EXPORT_CODE bool CONVENTION get_TTSESinglePhase_LUT_range (const char *FluidName, double *hmin, double *hmax, double *pmin, double *pmax)
 Get the current range of the single-phase LUT. More...
 
EXPORT_CODE int CONVENTION set_TTSE_mode (const char *FluidName, const char *Value)
 Set the TTSE mode (normal or bicubic) More...
 

Function Documentation

EXPORT_CODE double CONVENTION DerivTerms ( const char *  Term,
double  T,
double  rho,
const char *  Ref 
)

Definition at line 84 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION disable_TTSE_LUT ( const char *  FluidName)

Disable the TTSE.

Disable the TTSE.

Definition at line 184 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION disable_TTSE_LUT_writing ( const char *  FluidName)

Disable the writing of TTSE tables to file for this fluid.

Definition at line 204 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION enable_TTSE_LUT ( const char *  FluidName)

Enable the TTSE for this fluid.

TTSE Tabular Taylor Series Expansion

Enable the TTSE

Definition at line 171 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION enable_TTSE_LUT_writing ( const char *  FluidName)

Enable the writing of TTSE tables to file for this fluid.

Definition at line 191 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION F2K ( double  T_F)

Convert from degrees Fahrenheit to Kelvin (useful primarily for testing)

Definition at line 81 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION fromSI ( const char *  input,
const double  value,
const char *  new_system 
)

Definition at line 91 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION get_debug_level ( )

Get the debug level

Returns
level The level of the verbosity for the debugging output (0-10) 0: no debgging output

Definition at line 100 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION get_Fluid_index ( const char *  param)

Definition at line 102 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION get_fluid_param_string ( const char *  fluid,
const char *  param,
char *  Output 
)

Definition at line 145 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION get_global_param_string ( const char *  param,
char *  Output 
)

Definition at line 140 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION get_param_index ( const char *  param)

Definition at line 135 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION get_standard_unit_system ( void  )

Returns the value for the integer flag corresponding to the current set of units

Returns
val The integer value for the current set of units, one of enumerated values UNIT_SYSTEM_SI, UNIT_SYSTEM_KSI
See also
GlobalConstants.h

Returns the value for the integer flag corresponding to the current set of units

Returns
val The integer value for the current set of units, one of enumerated values UNIT_SYSTEM_SI, UNIT_SYSTEM_KSI (see GlobalConstants.h)

Definition at line 248 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION get_TTSESinglePhase_LUT_range ( const char *  FluidName,
double *  hmin,
double *  hmax,
double *  pmin,
double *  pmax 
)

Get the current range of the single-phase LUT.

Definition at line 232 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION IProps ( long  iOutput,
long  iName1,
double  Prop1,
long  iName2,
double  Prop2,
long  iFluid 
)

Definition at line 758 of file CoolProp.cpp.

EXPORT_CODE double CONVENTION IPropsSI ( long  iOutput,
long  iName1,
double  Prop1,
long  iName2,
double  Prop2,
long  iFluid 
)

Definition at line 861 of file CoolProp.cpp.

EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT ( const char *  FluidName)

Check if TTSE is enabled.

Definition at line 178 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT_writing ( const char *  FluidName)

Check if the writing of TTSE tables to file is enabled.

Definition at line 198 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION IsFluidType ( const char *  Ref,
const char *  Type 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
IsFluidType(std::string, std::string)

Definition at line 390 of file CoolProp.cpp.

EXPORT_CODE double CONVENTION K2F ( double  T_K)

Convert from Kelvin to degrees Fahrenheit (useful primarily for testing)

Definition at line 78 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION Phase ( const char *  Fluid,
double  T,
double  p,
char *  Phase_str 
)

Definition at line 151 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION Phase_Tp ( const char *  Fluid,
double  T,
double  rho,
char *  Phase_str 
)

Definition at line 156 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION Phase_Trho ( const char *  Fluid,
double  T,
double  p,
char *  Phase_str 
)

Definition at line 161 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION Props ( const char *  Output,
const char  Name1,
double  Prop1,
const char  Name2,
double  Prop2,
const char *  Ref 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
Props(std::string, std::string, double, std::string, double, std::string)

Definition at line 40 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION Props1 ( const char *  FluidName,
const char *  Output 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
Props1(std::string, std::string)

Definition at line 27 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION Props1SI ( const char *  FluidName,
const char *  Output 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
Props1SI(std::string, std::string)

Definition at line 31 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION PropsS ( const char *  Output,
const char *  Name1,
double  Prop1,
const char *  Name2,
double  Prop2,
const char *  Ref 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
Props(std::string, std::string, double, std::string, double, std::string)

Definition at line 35 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION PropsSI ( const char *  Output,
const char *  Name1,
double  Prop1,
const char *  Name2,
double  Prop2,
const char *  Ref 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
PropsSI(std::string, std::string, double, std::string, double, std::string)

Definition at line 73 of file CoolPropDLL.cpp.

EXPORT_CODE long CONVENTION redirect_stdout ( const char *  file)

Definition at line 13 of file CoolPropDLL.cpp.

EXPORT_CODE void CONVENTION set_debug_level ( int  level)

Set the debug level

Parameters
levelThe level of the verbosity for the debugging output (0-10) 0: no debgging output

Definition at line 101 of file CoolPropDLL.cpp.

EXPORT_CODE void CONVENTION set_phase ( const char *  Phase_str)

Definition at line 167 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION set_reference_stateD ( const char *  Ref,
double  T,
double  rho,
double  h0,
double  s0 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
set_reference_stateD(std::string, double, double, double, double)

Definition at line 22 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION set_reference_stateS ( const char *  Ref,
const char *  reference_state 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
set_reference_stateS(std::string, std::string)

Definition at line 18 of file CoolPropDLL.cpp.

EXPORT_CODE void CONVENTION set_standard_unit_system ( int  val)

Sets the flag for the integer flag corresponding to the current set of units

Parameters
valThe integer value for the current set of units, one of enumerated values UNIT_SYSTEM_SI, UNIT_SYSTEM_KSI
See also
GlobalConstants.h

Sets the flag for the integer flag corresponding to the current set of units

Parameters
valThe integer value for the current set of units, one of enumerated values UNIT_SYSTEM_SI, UNIT_SYSTEM_KSI (see GlobalConstants.h)

Definition at line 253 of file CoolPropDLL.cpp.

EXPORT_CODE int CONVENTION set_TTSE_mode ( const char *  FluidName,
const char *  Value 
)

Set the TTSE mode (normal or bicubic)

Definition at line 106 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION set_TTSESat_LUT_size ( const char *  FluidName,
int   
)

Over-ride the default size of both of the saturation LUT.

Definition at line 211 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_range ( const char *  FluidName,
double  hmin,
double  hmax,
double  pmin,
double  pmax 
)

Over-ride the default range of the single-phase LUT.

Definition at line 225 of file CoolPropDLL.cpp.

EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_size ( const char *  FluidName,
int  Np,
int  Nh 
)

Over-ride the default size of the single-phase LUT.

Definition at line 218 of file CoolPropDLL.cpp.

EXPORT_CODE double CONVENTION toSI ( const char *  input,
const double  value,
const char *  old_system 
)

Definition at line 95 of file CoolPropDLL.cpp.

Generated on Sun Aug 10 2014 16:02:42 for CoolProp by   doxygen 1.8.7