def get_saturationProperties(materialPropertyDF: DataFrame, P: Union[float, int] = float('nan'), T: Union[float, int] = float('nan')) -> Tuple[StatePure, StatePure]:
"""Returns saturated liquid and vapor states at the provided pressure or temperature for the material whose materialPropertyDF is provided."""
# at least the T or P must be provided
if isNumeric(P):
satLiq_atP = materialPropertyDF.query('P == {0} and x == 0'.format(P))
if satLiq_atP.empty:
# exact state (saturated liquid at P - state denoted "_f") not found
satLiq_atP = interpolate_onSaturationCurve(materialPropertyDF, interpolate_by='P', interpolate_at=P, endpoint='f')
materialPropertyDF.append(satLiq_atP.get_asDict_allProperties(), ignore_index=True) # append the calculated (interpolated) state to materialProperty table for future use in runtime if needed - won't have to interpolate again
else:
# if query found direct match (saturated liquid state at pressure), convert DFRow to a StatePure object
satLiq_atP = StatePure().init_fromDFRow(satLiq_atP)
satVap_atP = materialPropertyDF.query('P == {0} and x == 1'.format(P))
if satVap_atP.empty:
# exact state (saturated vapor at P - state denoted "_g") not found
satVap_atP = interpolate_onSaturationCurve(materialPropertyDF, interpolate_by='P', interpolate_at=P, endpoint='g')
materialPropertyDF.append(satVap_atP.get_asDict_allProperties(), ignore_index=True) # append the calculated (interpolated) state to materialProperty table for future use in runtime if needed - won't have to interpolate again
else:
# if query found direct match (saturated vapor state at pressure), convert DFRow to a StatePure object
satVap_atP = StatePure().init_fromDFRow(satVap_atP)
assert satLiq_atP.isFullyDefined() and satVap_atP.isFullyDefined()
assert satLiq_atP.x == 0 and satVap_atP.x == 1
assert satLiq_atP.T == satVap_atP.T
if isNumeric(T):
assert isWithin(satLiq_atP.T, 3, '%', T), 'InputError: Provided saturation temperature and pressure do not match.'
return satLiq_atP, satVap_atP
elif isNumeric(T):
satLiq_atT = materialPropertyDF.query('T == {0} and x == 0'.format(T))
if satLiq_atT.empty:
# exact state (saturated liquid at T - state denoted "_f") not found
satLiq_atT = interpolate_onSaturationCurve(materialPropertyDF, interpolate_by='T', interpolate_at=T, endpoint='f')
materialPropertyDF.append(satLiq_atT.get_asDict_allProperties(), ignore_index=True) # append the calculated (interpolated) state to materialProperty table for future use in runtime if needed - won't have to interpolate again
else:
# if query found direct match (saturated liquid state at pressure), convert DFRow to a StatePure object
satLiq_atT = StatePure().init_fromDFRow(satLiq_atT)
satVap_atT = materialPropertyDF.query('T == {0} and x == 1'.format(T))
if satVap_atT.empty:
# exact state (saturated vapor at T - state denoted "_g") not found
satVap_atT = interpolate_onSaturationCurve(materialPropertyDF, interpolate_by='T', interpolate_at=T, endpoint='g')
materialPropertyDF.append(satVap_atT.get_asDict_allProperties(), ignore_index=True) # append the calculated (interpolated) state to materialProperty table for future use in runtime if needed - won't have to interpolate again
else:
# if query found direct match (saturated vapor state at pressure), convert DFRow to a StatePure object
satVap_atT = StatePure().init_fromDFRow(satVap_atT)
assert satLiq_atT.isFullyDefined() and satVap_atT.isFullyDefined()
assert satLiq_atT.x == 0 and satVap_atT.x == 1
return satLiq_atT, satVap_atT
def defineState_ifDefinable(self, state: StatePure):
if not state.isFullyDefined() and state.isFullyDefinable():
try:
state.copy_fromState(self.define(state))
except NeedsExtrapolationError:
print(
'Fluid.defineState_ifDefinable: Leaving state @ {0} not fully defined'
.format(state))
return state