CoolPropDLL.h

Go to the documentation of this file.

#ifndef COOLPROPDLL_H
#define COOLPROPDLL_H

    #include "CoolPropTools.h"
        
        // Functions with the call type like
        // EXPORT_CODE void CONVENTION AFunction(double, double);
        // will be exported to the DLL

    /*
    ####################################################################################
    Overloads for DLL wrapping puposes

    These functions take strings which are 0-terminated.  These functions pass directly to 
    equivalently named functions in CoolProp.h that take std::string
    ####################################################################################
    */

    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);
    
    // When using SWIG, it is extremely difficult to deal with char* for output strings, so just use 
        // the std::string version since SWIG can handle std::string just fine
        #if defined(SWIG)
                std::string get_global_param_string(std::string ParamName);
                std::string get_fluid_param_string(std::string FluidName, std::string ParamName);
        #else
                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);
        #endif

    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);
    /*
    ####################################################################################
    Implemented functions

    These functions take inputs that are compatible with DLL passing and are 
    implemented in CoolPropDLL.cpp
    ####################################################################################
    */

        // This version uses the indices in place of the strings for speed.  Get the parameter indices
        // from get_param_index('D') for instance and the Fluid index from get_Fluid_index('Air') for instance
        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);
    EXPORT_CODE double CONVENTION K2F(double T_K);

        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);

    // ---------------------------------
        // Getter and setter for debug level
        // ---------------------------------

        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);
        EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT(const char *FluidName);
        EXPORT_CODE bool CONVENTION disable_TTSE_LUT(const char *FluidName);
        EXPORT_CODE bool CONVENTION enable_TTSE_LUT_writing(const char *FluidName);
        EXPORT_CODE bool CONVENTION isenabled_TTSE_LUT_writing(const char *FluidName);
        EXPORT_CODE bool CONVENTION disable_TTSE_LUT_writing(const char *FluidName);
        EXPORT_CODE bool CONVENTION set_TTSESat_LUT_size(const char *FluidName, int);
        EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_size(const char *FluidName, int Np, int Nh);
        EXPORT_CODE bool CONVENTION set_TTSESinglePhase_LUT_range(const char *FluidName, double hmin, double hmax, double pmin, double pmax);
        EXPORT_CODE bool CONVENTION get_TTSESinglePhase_LUT_range(const char *FluidName, double *hmin, double *hmax, double *pmin, double *pmax);
        EXPORT_CODE int CONVENTION set_TTSE_mode(const char *FluidName, const char * Value);


#endif