DWSIM Class Library Documentation
DWSIM
DWSIM Namespaces
DWSIM.Thermodynamics Namespaces
DWSIM.Thermodynamics.Streams
MaterialStream Class
MaterialStream Methods
_GetComponentList Method
Add Method
Assign Method
AssignFromPhase Method
AssignProps Method
AssignSolidData Method
AvailableProps Method
CalcAndGetLnPhi Method
CalcEquilibrium Method
CalcEquilibrium1 Method
CalcEquilibrium2 Method
CalcEquilibrium3 Method
CalcOverallCompMassFractions Method
CalcOverallCompMoleFractions Method
CalcOverallMolecularWeight Method
CalcPhaseMassComposition Method
CalcProp Method
CalcProp1 Method
CalcProp2 Method
CalcSinglePhaseProp Method
CalcTwoPhaseProp Method
Calculate Method
CheckDirtyStatus Method
CheckEquilibriumSpec Method
CheckSinglePhasePropSpec Method
CheckTwoPhasePropSpec Method
Clear Method
ClearAllProps Method
ClearCalculatedProps Method
ClearPropertyPackageInstance Method
Clone Method
Clone1 Method
CloneJSON Method
CloneXML Method
CloseEditForm Method
CopyCompositions Method
CopyFromMaterial Method
CreateMaterial Method
CreateMaterialObject Method
CreateMaterialObject1 Method
DeepClear Method
DisplayEditForm Method
Duplicate Method
Empty Method
EmptyPropertyPackage Method
EqualizeOverallComposition Method
GetComponentConstant Method
GetComponentConstant1 Method
GetComponentList Method
GetCompoundConstant Method
GetCompoundList Method
GetCompoundMassConcentration Method
GetCompoundMassFlow Method
GetCompoundMolarFlow Method
GetCompoundNames Method
GetConstPropList Method
GetDebugReport Method
GetDefaultProperties Method
GetDisplayDescription Method
GetDisplayName Method
GetEnergyFlow Method
GetFlashSpec Method
GetIconBitmap Method
GetIndependentVar Method
GetMassEnthalpy Method
GetMassEntropy Method
GetMassFlow Method
GetMolarFlow Method
GetNumComponents Method
GetNumCompounds Method
GetNumPhases Method
GetOverallComposition Method
GetOverallHeatOfFormation Method
GetOverallMassComposition Method
GetOverallMolecularWeight Method
GetOverallProp Method
GetOverallTPFraction Method
GetPDependentProperty Method
GetPDependentPropList Method
GetPhase Method
GetPhaseComposition Method
GetPhaseInfo Method
GetPhaseList Method
GetPhaseList1 Method
GetPresentPhases Method
GetPressure Method
GetProcessFlowsheetProperties Method
GetProp Method
GetProperties Method
GetPropertyDescription Method
GetPropertyPackageObject Method
GetPropertyPackageObjectCopy Method
GetPropertyUnit Method
GetPropertyValue Method
GetPropList Method
GetPropList1 Method
GetPropList2 Method
GetPropUnits Method
GetReport Method
GetSinglePhaseProp Method
GetSinglePhaseProp2 Method
GetSinglePhasePropDefaultUnits Method
GetSinglePhasePropList Method
GetStructuredReport Method
GetTDependentProperty Method
GetTDependentPropList Method
GetTemperature Method
GetTPFraction Method
GetTwoPhaseProp Method
GetTwoPhasePropList Method
GetUniversalConstant Method
GetUniversalConstant1 Method
GetUniversalConstantList Method
GetVolumetricFlow Method
IMaterialStream.GetPhase2 Method
LoadData Method
MassFractionsToMoleFractions Method
Mix Method
MoleFractionsToMassFractions Method
NormalizeOverallMassComposition Method
NormalizeOverallMoleComposition Method
PropCheck Method
PropCheck1 Method
PropCheck2 Method
PropCheck3 Method
PropList Method
RemoveResults Method
RunDynamicModel Method
SaveData Method
SetCurrentMaterialStream Method
SetFlashSpec Method
SetIndependentVar Method
SetMassEnthalpy Method
SetMassEntropy Method
SetMassFlow Method
SetMaterial Method
SetMolarFlow Method
SetOverallComposition Method
SetOverallCompoundMassFlow Method
SetOverallCompoundMolarFlow Method
SetOverallMassComposition Method
SetOverallMolarComposition Method
SetOverallProp Method
SetPhaseComposition Method
SetPhaseComposition1 Method
SetPresentPhases Method
SetPressure Method
SetProp Method
SetProp1 Method
SetPropertyPackage Method
SetPropertyPackageInstance Method
SetPropertyValue Method
SetSinglePhaseProp Method
SetTemperature Method
SetTwoPhaseProp Method
SetVolumetricFlow Method
ShallowClone Method
Subtract Method
ThrowCAPEException Method
ToString Method
TranslateString Method
UnsetMaterial Method
UpdateEditForm Method
Validate Method
Validate1 Method
ValidityCheck Method
ValidityCheck1 Method
ValidityCheck2 Method
ValidityCheck3 Method
Click or drag to resize

MaterialStreamCheckSinglePhasePropSpec Method

Checks whether it is possible to calculate a property with the CalcSinglePhaseProp method for a given Phase.

Namespace: DWSIM.Thermodynamics.Streams
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 8.8.1.0
Syntax
Copy
public bool CheckSinglePhasePropSpec(
	string property,
	string phaseLabel
)
Request Example View Source

Parameters

property  String
The identifier of the property to check. To be valid this must be one of the supported single-phase properties or derivatives (as given by the GetSinglePhasePropList method).
phaseLabel  String
The Phase label for the calculation check. This must be one of the labels returned by the GetPhaseList method on the ICapeThermoPhases interface.

Return Value

Boolean
Set to True if the combination of property and phaseLabel is supported or False if not supported.

Implements

ICapeThermoPropertyRoutine.CheckSinglePhasePropSpec(String, String)
Remarks
The result of the check should only depend on the capabilities and configuration (Compounds and Phases supported) of the component that implements the ICapeThermoPropertyRoutine interface (e.g. a Property Package). It should not depend on whether a Material Object has been set nor on the state (temperature, pressure, composition etc.), or configuration of a Material Object that might be set. It is expected that the PME, or other client, will use this method to check whether the properties it requires are supported by the Property Package when the package is imported. If any essential properties are not available, the import process should be aborted. If either the property or the phaseLabel arguments are not recognised by the component that implements the ICapeThermoPropertyRoutine interface this method should return False.
See Also