Function CP_PropsSI

wrappers/MathCAD/CoolPropMathcad.cpp:416–450

This code executes the user function CP_PropsSI, which is a wrapper for the CoolProp.PropsSI() function, used to extract a fluid-specific parameter that is dependent on the state

// This code executes the user function CP_PropsSI, which is a wrapper for
// the CoolProp.PropsSI() function, used to extract a fluid-specific parameter that is dependent on the state
static LRESULT CP_PropsSI(LPCOMPLEXSCALAR Prop,         // pointer to the result
                          LPCMCSTRING OutputName,       // string with a valid CoolProp OutputName
                          LPCMCSTRING InputName1,       // CoolProp InputName1
                          LPCCOMPLEXSCALAR InputProp1,  // CoolProp InputProp1
                          LPCMCSTRING InputName2,       // CoolProp InputName2
                          LPCCOMPLEXSCALAR InputProp2,  // CoolProp InputProp2
                          LPCMCSTRING FluidName)        // CoolProp Fluid
{
    // unsigned int errPos = 0;
    std::string Prop1Name(InputName1->str);
    std::string Prop2Name(InputName2->str);
    std::string FluidString = FluidName->str;

    // check that the first scalar argument is real
    LRESULT r = CheckRealOrError(InputProp1, 3);
    if (r) return r;

    // check that the second scalar argument is real
    r = CheckRealOrError(InputProp2, 5);
    if (r) return r;

    // pass the arguments to the CoolProp.PropsSI() function
    Prop->real = CoolProp::PropsSI(OutputName->str, InputName1->str, InputProp1->real, InputName2->str, InputProp2->real, FluidName->str);

    // Note: PropsSI does not throw exceptions, but instead
    // sets global parameter "errstring" and returns _HUGE.
    // Use ValidNumber(val) to see if PropsSI failed with an error message...
    if (!ValidNumber(Prop->real)) {
        std::string emsg = CoolProp::get_global_param_string("errstring");
        CoolProp::set_error_string(emsg);  // reset error string so Mathcad can retrieve it
        return HandlePropsSIError(emsg, Prop1Name, 0u);
    }
    // normal return
    return 0;
}

// This code executes the user function CP_PropsSImulti, which is a wrapper for
// the CoolProp.PropsSImulti() function, used to extract a range of fluid-specific parameter dependent on the state ranges