CoolProp.CoolProp module

class CoolProp.CoolProp.AbstractState(self, arg0: str, arg1: str, /)

Bases: object

Bvirial(self) → float

Cvirial(self) → float

PIP(self) → float

Prandtl(self) → float

Q(self) → float

Qmass(self) → float

T(self) → float

T_critical(self) → float

T_reducing(self) → float

Tmax(self) → float

Tmin(self) → float

Ttriple(self) → float

acentric_factor(self) → float

all_critical_points(self) → list[CoolProp.CoolProp.CriticalState]

alpha0(self) → float

alphar(self) → float

apply_simple_mixing_rule(self, arg0: int, arg1: int, arg2: str, /) → None

available_in_high_level(self) → bool

backend_name(self) → str

build_options_json(self) → str

build_phase_envelope(self, arg: str, /) → None

build_spinodal(self) → None

change_EOS(self, arg0: int, arg1: str, /) → None

chemical_potential(self, arg: int, /) → float

chemical_potentials(self) → list[float]

clear(self) → bool

compressibility_factor(self) → float

conductivity(self) → float

conductivity_contributions(self) → dict

conformal_state(self, arg0: str, arg1: float, arg2: float, /) → dict

cp0mass(self) → float

cp0molar(self) → float

cpmass(self) → float

cpmolar(self) → float

criticality_contour_values(self) → tuple

cvmass(self) → float

cvmolar(self) → float

d2alpha0_dDelta2(self) → float

d2alpha0_dDelta_dTau(self) → float

d2alpha0_dTau2(self) → float

d2alphar_dDelta2(self) → float

d2alphar_dDelta_dTau(self) → float

d2alphar_dTau2(self) → float

d3alpha0_dDelta2_dTau(self) → float

d3alpha0_dDelta3(self) → float

d3alpha0_dDelta_dTau2(self) → float

d3alpha0_dTau3(self) → float

d3alphar_dDelta2_dTau(self) → float

d3alphar_dDelta3(self) → float

d3alphar_dDelta_dTau2(self) → float

d3alphar_dTau3(self) → float

d4alphar_dDelta2_dTau2(self) → float

d4alphar_dDelta3_dTau(self) → float

d4alphar_dDelta4(self) → float

d4alphar_dDelta_dTau3(self) → float

d4alphar_dTau4(self) → float

dBvirial_dT(self) → float

dCvirial_dT(self) → float

dalpha0_dDelta(self) → float

dalpha0_dTau(self) → float

dalphar_dDelta(self) → float

dalphar_dTau(self) → float

delta(self) → float

dipole_moment(self) → float

fast_evaluate(self, input_pair: CoolProp.CoolProp.input_pairs, val1: ndarray[dtype=float64, shape=(*), order='C', writable=False], val2: ndarray[dtype=float64, shape=(*), order='C', writable=False], outputs: ndarray[dtype=int32, shape=(*), order='C', writable=False], out: ndarray[dtype=float64, shape=(*, *), order='C'], status: ndarray[dtype=int32, shape=(*), order='C'], imposed_phase: CoolProp.CoolProp.phases = phases.iphase_not_imposed) → None

first_partial_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, /) → float

first_saturation_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, /) → float

first_two_phase_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, /) → float

first_two_phase_deriv_splined(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, arg3: float, /) → float

fluid_names(self) → list[str]

fluid_param_string(self, arg: str, /) → str

fugacities(self) → list[float]

fugacity(self, arg: int, /) → float

fugacity_coefficient(self, arg: int, /) → float

fugacity_coefficients(self) → list[float]

fundamental_derivative_of_gas_dynamics(self) → float

gas_constant(self) → float

get_binary_interaction_double(self, arg0: str, arg1: str, arg2: str, /) → float

get_binary_interaction_double(self, arg0: int, arg1: int, arg2: str, /) → float

get_binary_interaction_string(self, arg0: str, arg1: str, arg2: str, /) → str

get_fluid_constant(self, arg0: int, arg1: CoolProp.CoolProp.parameters, /) → float

get_fluid_parameter_double(self, arg0: int, arg1: str, /) → float

get_mass_fractions(self) → list[float]

get_mole_fractions(self) → list[float]

get_phase_envelope_data(self) → CoolProp.CoolProp.PhaseEnvelopeData

get_reducing_state(self) → CoolProp.CoolProp.SimpleState

get_spinodal_data(self) → CoolProp.CoolProp.SpinodalData

get_state(self, arg: str, /) → CoolProp.CoolProp.SimpleState

gibbsmass(self) → float

gibbsmass_excess(self) → float

gibbsmolar(self) → float

gibbsmolar_excess(self) → float

gibbsmolar_residual(self) → float

has_melting_line(self) → bool

helmholtzmass(self) → float

helmholtzmass_excess(self) → float

helmholtzmolar(self) → float

helmholtzmolar_excess(self) → float

hmass(self) → float

hmass_excess(self) → float

hmass_idealgas(self) → float

hmolar(self) → float

hmolar_excess(self) → float

hmolar_idealgas(self) → float

hmolar_residual(self) → float

ideal_curve(self, arg: str, /) → tuple

isobaric_expansion_coefficient(self) → float

isothermal_compressibility(self) → float

keyed_output(self, arg: CoolProp.CoolProp.parameters, /) → float

melting_line(self, arg0: int, arg1: int, arg2: float, /) → float

molar_mass(self) → float

mole_fractions_liquid(self) → list[float]

mole_fractions_liquid_double(self) → list[float]

mole_fractions_vapor(self) → list[float]

mole_fractions_vapor_double(self) → list[float]

name(self) → str

neff(self) → float

p(self) → float

p_critical(self) → float

p_triple(self) → float

phase(self) → CoolProp.CoolProp.phases

pmax(self) → float

rhomass(self) → float

rhomass_critical(self) → float

rhomass_reducing(self) → float

rhomolar(self) → float

rhomolar_critical(self) → float

rhomolar_reducing(self) → float

saturated_liquid_keyed_output(self, arg: CoolProp.CoolProp.parameters, /) → float

saturated_vapor_keyed_output(self, arg: CoolProp.CoolProp.parameters, /) → float

saturation_ancillary(self, arg0: CoolProp.CoolProp.parameters, arg1: int, arg2: CoolProp.CoolProp.parameters, arg3: float, /) → float

second_partial_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, arg3: CoolProp.CoolProp.parameters, arg4: CoolProp.CoolProp.parameters, /) → float

second_saturation_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, /) → float

second_two_phase_deriv(self, arg0: CoolProp.CoolProp.parameters, arg1: CoolProp.CoolProp.parameters, arg2: CoolProp.CoolProp.parameters, arg3: CoolProp.CoolProp.parameters, arg4: CoolProp.CoolProp.parameters, /) → float

set_T(self, arg: float, /) → None

set_binary_interaction_double(self, arg0: str, arg1: str, arg2: str, arg3: float, /) → None

set_binary_interaction_double(self, arg0: int, arg1: int, arg2: str, arg3: float, /) → None

set_binary_interaction_string(self, arg0: str, arg1: str, arg2: str, arg3: str, /) → None

set_binary_interaction_string(self, arg0: int, arg1: int, arg2: str, arg3: str, /) → None

set_cubic_alpha_C(self, arg0: int, arg1: str, arg2: float, arg3: float, arg4: float, /) → None

set_fluid_parameter_double(self, arg0: int, arg1: str, arg2: float, /) → None

set_mass_fractions(self, arg: collections.abc.Sequence[float], /) → None

set_mole_fractions(self, arg: collections.abc.Sequence[float], /) → None

set_volu_fractions(self, arg: collections.abc.Sequence[float], /) → None

smass(self) → float

smass_excess(self) → float

smass_idealgas(self) → float

smolar(self) → float

smolar_excess(self) → float

smolar_idealgas(self) → float

smolar_residual(self) → float

specify_phase(self, arg: CoolProp.CoolProp.phases, /) → None

speed_sound(self) → float

surface_tension(self) → float

tangent_plane_distance(self, arg0: float, arg1: float, arg2: collections.abc.Sequence[float], arg3: float, /) → float

tau(self) → float

trivial_keyed_output(self, arg: CoolProp.CoolProp.parameters, /) → float

true_critical_point(self) → tuple

umass(self) → float

umass_excess(self) → float

umass_idealgas(self) → float

umolar(self) → float

umolar_excess(self) → float

umolar_idealgas(self) → float

unspecify_phase(self) → None

update(self, arg0: CoolProp.CoolProp.input_pairs, arg1: float, arg2: float, /) → None

update_QT_pure_superanc(self, arg0: float, arg1: float, /) → None

update_with_guesses(self, arg0: CoolProp.CoolProp.input_pairs, arg1: float, arg2: float, arg3: CoolProp.CoolProp.GuessesStructure, /) → None

using_mass_fractions(self) → bool

using_mole_fractions(self) → bool

using_volu_fractions(self) → bool

viscosity(self) → float

viscosity_contributions(self) → dict

volumemass_excess(self) → float

volumemolar_excess(self) → float

class CoolProp.CoolProp.ChebyshevApproximation1D(self, expansions: collections.abc.Sequence[CoolProp.CoolProp.ChebyshevExpansion])

Bases: object

count_x_for_y_many(self, y: ndarray[dtype=float64, shape=(*), order='C'], bits: int, max_iter: int, boundstytol: float, counts: ndarray[dtype=uint64, shape=(*), order='C']) → None

eval_many(self, x: ndarray[dtype=float64, shape=(*), order='C'], y: ndarray[dtype=float64, shape=(*), order='C']) → None

get_x_for_y(self, y: float, bits: int, max_iter: int, boundstytol: float) → list[tuple[float, int]]

is_monotonic(self) → bool

monotonic_intervals(self) → list[CoolProp.CoolProp.IntervalMatch]

xmax(self) → float

xmin(self) → float

class CoolProp.CoolProp.ChebyshevExpansion(self, xmin: float, xmax: float, coef: collections.abc.Sequence[float])

Bases: object

coeff(self) → list[float]

eval_many(self, x: ndarray[dtype=float64, shape=(*), order='C'], y: ndarray[dtype=float64, shape=(*), order='C']) → None

solve_for_x(self, y: float, a: float, b: float, bits: int, max_iter: int, boundstytol: float) → float

solve_for_x_many(self, y: ndarray[dtype=float64, shape=(*), order='C'], a: float, b: float, bits: int, max_iter: int, boundstytol: float, x: ndarray[dtype=float64, shape=(*), order='C'], counts: ndarray[dtype=uint64, shape=(*), order='C']) → None

xmax(self) → float

xmin(self) → float

class CoolProp.CoolProp.CriticalState(self)

Bases: SimpleState

property stable

(self) -> bool

class CoolProp.CoolProp.Expression(self, json_block: str)

Bases: object

A compiled transport-property expression block.

Construct from the JSON text of a “type”: “expression” block ({“formula”: …, “state_variables”: […], “constants”: {…},

“arrays”: {…}}), then evaluate it at a state.

state_variables lists the thermodynamic quantities the formula reads, in CoolProp’s own spelling (“T”, “P”, “Dmolar”, “Smolar_residual”, …). It is opt-in: a name not declared there is never state, so a block that does not ask for pressure keeps p for its own coefficients. Raises ValueError on a bad formula, on reading an undeclared quantity, or on declaring one that cannot be honoured (a transport output, which would re-enter the correlation; or the configuration-dependent critical point and reducing state).

evaluate(self, AS: CoolProp.CoolProp.AbstractState) → float

Evaluate at the state AS (an AbstractState) is currently sitting at. Set the state the usual way – AS.update(DmolarT_INPUTS, rhomolar, T) – so any input pair, backend, or mixture composition works. Raises ValueError if an input reads back non-finite (an AbstractState that was never update()d).

required_inputs(self) → list[str]

The declared state variables the formula actually reads, in first-reference order (the order the formula mentions them, NOT the order they were declared).

class CoolProp.CoolProp.GuessesStructure(self)

Bases: object

property T

(self) -> float

clear(self) → None

property hmolar

(self) -> float

property p

(self) -> float

property rhomolar

(self) -> float

property rhomolar_liq

(self) -> float

property rhomolar_vap

(self) -> float

property smolar

(self) -> float

property x

(self) -> list[float]

property y

(self) -> list[float]

class CoolProp.CoolProp.IntervalMatch

Bases: object

property expansioninfo

(self) -> list[CoolProp.CoolProp.MonotonicExpansionMatch]

property xmax

(self) -> float

property xmin

(self) -> float

property ymax

(self) -> float

property ymin

(self) -> float

class CoolProp.CoolProp.MonotonicExpansionMatch

Bases: object

property idx

(self) -> int

property xmax

(self) -> float

property xmin

(self) -> float

property ymax

(self) -> float

property ymin

(self) -> float

class CoolProp.CoolProp.PhaseEnvelopeData(self)

Bases: object

property K

(self) -> list[list[float]]

property Q

(self) -> list[float]

property T

(self) -> list[float]

property conductivity_liq

(self) -> list[float]

property conductivity_vap

(self) -> list[float]

property cpmolar_liq

(self) -> list[float]

property cpmolar_vap

(self) -> list[float]

property cvmolar_liq

(self) -> list[float]

property cvmolar_vap

(self) -> list[float]

property hmolar_liq

(self) -> list[float]

property hmolar_vap

(self) -> list[float]

property lnK

(self) -> list[list[float]]

property lnT

(self) -> list[float]

property lnp

(self) -> list[float]

property lnrhomolar_liq

(self) -> list[float]

property lnrhomolar_vap

(self) -> list[float]

property p

(self) -> list[float]

property rhomolar_liq

(self) -> list[float]

property rhomolar_vap

(self) -> list[float]

property smolar_liq

(self) -> list[float]

property smolar_vap

(self) -> list[float]

property speed_sound_vap

(self) -> list[float]

property viscosity_liq

(self) -> list[float]

property viscosity_vap

(self) -> list[float]

property x

(self) -> list[list[float]]

property y

(self) -> list[list[float]]

CoolProp.CoolProp.PyCriticalState

alias of CriticalState

CoolProp.CoolProp.PyGuessesStructure

alias of GuessesStructure

CoolProp.CoolProp.PyPhaseEnvelopeData

alias of PhaseEnvelopeData

CoolProp.CoolProp.PySpinodalData

alias of SpinodalData

class CoolProp.CoolProp.SimpleState(self)

Bases: object

property T

(self) -> float

property p

(self) -> float

property rhomolar

(self) -> float

class CoolProp.CoolProp.SpinodalData(self)

Bases: object

property M1

(self) -> list[float]

property delta

(self) -> list[float]

property tau

(self) -> list[float]

class CoolProp.CoolProp.SuperAncillary(self, json_as_string: str)

Bases: object

eval_sat(self, T: float, prop: str, Q: int) → float

eval_sat_many(self, T: ndarray[dtype=float64, shape=(*), order='C'], prop: str, Q: int, y: ndarray[dtype=float64, shape=(*), order='C']) → None

class CoolProp.CoolProp.configuration_keys(*values)

Bases: IntEnum

ALLOW_SVDSBTL_IN_PROPSSI = 33

ALTERNATIVE_REFPROP_HMX_BNC_PATH = 7

ALTERNATIVE_REFPROP_LIBRARY_PATH = 8

ALTERNATIVE_REFPROP_PATH = 6

ALTERNATIVE_SVDTABLES_DIRECTORY = 5

ALTERNATIVE_TABLES_DIRECTORY = 4

ASSUME_CRITICAL_POINT_STABLE = 26

CRITICAL_SPLINES_ENABLED = 2

CRITICAL_WITHIN_1UK = 1

DONT_CHECK_PROPERTY_LIMITS = 16

ENABLE_MELTING_CALORIC_HS = 30

ENABLE_SUPERANCILLARIES = 29

FLOAT_PUNCTUATION = 28

HENRYS_LAW_TO_GENERATE_VLE_GUESSES = 17

HSU_D_TWOPHASE_EOS_POLISH = 31

LIST_STRING_DELIMITER = 32

MAXIMUM_TABLE_DIRECTORY_SIZE_IN_GB = 15

MIXTURE_STABILITY_ALGORITHM = 36

NORMALIZE_GAS_CONSTANTS = 0

OVERWRITE_BINARY_INTERACTION = 24

OVERWRITE_DEPARTURE_FUNCTION = 23

OVERWRITE_FLUIDS = 22

PHASE_ENVELOPE_STARTING_PRESSURE_PA = 18

REFPROP_DONT_ESTIMATE_INTERACTION_PARAMETERS = 9

REFPROP_ERROR_THRESHOLD = 12

REFPROP_IGNORE_ERROR_ESTIMATED_INTERACTION_PARAMETERS = 10

REFPROP_RESOLVE_COOLPROP_ALIASES = 14

REFPROP_USE_GERG = 11

REFPROP_USE_PENGROBINSON = 13

R_U_CODATA = 19

SAVE_RAW_TABLES = 3

SPINODAL_MINIMUM_DELTA = 21

SVDSBTL_SAMPLING_THREADS = 34

SVDSBTL_SURFACE_CACHE_MAX_ENTRIES = 38

SVDSBTL_SURFACE_CACHE_MAX_SIZE_MB = 39

TABULAR_NX = 35

TABULAR_NY = 37

USE_GUESSES_IN_PROPSSI = 25

VTPR_ALWAYS_RELOAD_LIBRARY = 27

VTPR_UNIFAC_PATH = 20

class CoolProp.CoolProp.fast_evaluate_status(*values)

Bases: IntEnum

fast_evaluate_internal_error = 5

fast_evaluate_ok = 0

fast_evaluate_out_of_range = 1

fast_evaluate_two_phase_disallowed = 2

fast_evaluate_unsupported_input = 3

fast_evaluate_unsupported_output = 4

class CoolProp.CoolProp.fluid_types(*values)

Bases: IntEnum

FLUID_TYPE_INCOMPRESSIBLE_LIQUID = 3

FLUID_TYPE_INCOMPRESSIBLE_SOLUTION = 4

FLUID_TYPE_PSEUDOPURE = 1

FLUID_TYPE_PURE = 0

FLUID_TYPE_REFPROP = 2

FLUID_TYPE_UNDEFINED = 5

class CoolProp.CoolProp.input_pairs(*values)

Bases: IntEnum

DmassHmass_INPUTS = 38

DmassP_INPUTS = 26

DmassQ_INPUTS = 15

DmassQmass_INPUTS = 16

DmassSmass_INPUTS = 40

DmassT_INPUTS = 18

DmassUmass_INPUTS = 42

DmolarHmolar_INPUTS = 39

DmolarP_INPUTS = 27

DmolarQ_INPUTS = 13

DmolarQmass_INPUTS = 14

DmolarSmolar_INPUTS = 41

DmolarT_INPUTS = 19

DmolarUmolar_INPUTS = 43

HmassP_INPUTS = 28

HmassQ_INPUTS = 11

HmassQmass_INPUTS = 12

HmassSmass_INPUTS = 34

HmassT_INPUTS = 21

HmolarP_INPUTS = 29

HmolarQ_INPUTS = 9

HmolarQmass_INPUTS = 10

HmolarSmolar_INPUTS = 35

HmolarT_INPUTS = 20

INPUT_PAIR_INVALID = 0

PQ_INPUTS = 3

PQmass_INPUTS = 4

PSmass_INPUTS = 30

PSmolar_INPUTS = 31

PT_INPUTS = 17

PUmass_INPUTS = 32

PUmolar_INPUTS = 33

QSmass_INPUTS = 7

QSmolar_INPUTS = 5

QT_INPUTS = 1

QmassSmass_INPUTS = 8

QmassSmolar_INPUTS = 6

QmassT_INPUTS = 2

SmassT_INPUTS = 23

SmassUmass_INPUTS = 36

SmolarT_INPUTS = 22

SmolarUmolar_INPUTS = 37

TUmass_INPUTS = 25

TUmolar_INPUTS = 24

class CoolProp.CoolProp.parameters(*values)

Bases: IntEnum

INVALID_PARAMETER = 0

iBvirial = 70

iCp0mass = 45

iCp0molar = 30

iCpmass = 44

iCpmolar = 29

iCvirial = 71

iCvmass = 46

iCvmolar = 31

iDelta = 25

iDmass = 41

iDmolar = 26

iFH = 82

iGWP100 = 80

iGWP20 = 79

iGWP500 = 81

iGmass = 48

iGmolar = 33

iGmolar_residual = 37

iHH = 83

iHelmholtzmass = 49

iHelmholtzmolar = 34

iHmass = 42

iHmass_idealgas = 50

iHmolar = 27

iHmolar_formation = 19

iHmolar_idealgas = 38

iHmolar_residual = 35

iODP = 85

iP = 21

iPH = 84

iPIP = 75

iP_critical = 10

iP_max = 16

iP_min = 17

iP_reducing = 11

iP_triple = 13

iPhase = 86

iPrandtl = 56

iQ = 22

iQmass = 23

iSmass = 43

iSmass_idealgas = 51

iSmolar = 28

iSmolar_idealgas = 39

iSmolar_residual = 36

iT = 20

iT_critical = 7

iT_freeze = 78

iT_max = 15

iT_min = 14

iT_reducing = 6

iT_triple = 12

iTau = 24

iUmass = 47

iUmass_idealgas = 52

iUmolar = 32

iUmolar_idealgas = 40

iZ = 74

iacentric_factor = 3

ialpha0 = 65

ialphar = 62

iconductivity = 54

id2alpha0_ddelta2_consttau = 68

id3alpha0_ddelta3_consttau = 69

idBvirial_dT = 72

idCvirial_dT = 73

idalpha0_ddelta_consttau = 67

idalpha0_dtau_constdelta = 66

idalphar_ddelta_consttau = 64

idalphar_dtau_constdelta = 63

idipole_moment = 18

ifraction_max = 77

ifraction_min = 76

ifundamental_derivative_of_gas_dynamics = 61

igas_constant = 1

iisentropic_expansion_coefficient = 60

iisobaric_expansion_coefficient = 59

iisothermal_compressibility = 58

imolar_mass = 2

irhomass_critical = 9

irhomass_reducing = 8

irhomolar_critical = 5

irhomolar_reducing = 4

ispeed_sound = 57

isurface_tension = 55

iundefined_parameter = 87

iviscosity = 53

class CoolProp.CoolProp.phases(*values)

Bases: IntEnum

iphase_critical_point = 4

iphase_gas = 5

iphase_liquid = 0

iphase_not_imposed = 8

iphase_supercritical = 1

iphase_supercritical_gas = 2

iphase_supercritical_liquid = 3

iphase_twophase = 6

iphase_unknown = 7