Click or drag to resize

PropertyPackage Class

The Property Package Class contains methods to do thermodynamic calculations for all supported phases in DWSIM.
Inheritance Hierarchy
SystemObject
  DWSIM.Thermodynamics.PropertyPackagesPropertyPackage
    More

Namespace: DWSIM.Thermodynamics.PropertyPackages
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 8.8.1.0
Syntax
Copy
[SerializableAttribute]
public abstract class PropertyPackage : ICapeIdentification, 
	ICapeThermoPropertyPackage, ICapeUtilities, ICapeThermoEquilibriumServer, ICapeThermoCalculationRoutine, ICapeThermoPhases, 
	ICapeThermoPropertyRoutine, ICapeThermoCompounds, ICapeThermoUniversalConstant, ICapeThermoMaterialContext, ICapeThermoEquilibriumRoutine, 
	IPersistStreamInit, ECapeUser, ECapeUnknown, ECapeRoot, IDisposable, 
	ICustomXMLSerialization, IPropertyPackage
Request Example View Source

The PropertyPackage type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyActivityCoefficientModels_IgnoreMissingInteractionParameters 
Public propertyAreModelParametersDirty 
Public propertyAutoEstimateMissingNRTLUNIQUACParameters 
Public propertyCalculateAdditionalMaterialStreamProperties 
Public propertycode 
Public propertyComponentDescription Gets the name of the component.
Public propertyComponentName Gets the description of the component.
Public propertyCurrentMaterialStream Gets or sets the current material stream for this property package.
Public propertydescription 
Public propertyDisplayDescription 
Public propertyDisplayName 
Public propertyEnthalpyEntropyCpCvCalculationMode 
Public propertyExceptionLog 
Public propertyFlashAlgorithm 
Public propertyFlashBase Returns the FlashAlgorithm object instance for this property package.
Public propertyFlashCalculationApproach 
Public propertyFlashSettings 
Public propertyFlowsheet 
Public propertyForcedSolids 
Public propertyForceNewFlashAlgorithmInstance 
Public propertyHasReactivePhase 
Public propertyIgnoreSalinityLimit 
Public propertyIgnoreVaporFractionLimit 
Public propertyImplementsAnalyticalDerivatives 
Public propertyinterfaceName 
Public propertyIsAmineModel 
Public propertyIsConfigurable 
Public propertyIsFunctional 
Public propertyLiquidDensity_CorrectExpDataForPressure 
Public propertyLiquidDensity_UsePenelouxVolumeTranslation 
Public propertyLiquidDensityCalculationMode_Subcritical 
Public propertyLiquidDensityCalculationMode_Supercritical 
Public propertyLiquidEnthalpyEntropyCpCvCalculationMode_EOS 
Public propertyLiquidFugacity_UsePoyntingCorrectionFactor 
Public propertyLiquidViscosity_CorrectExpDataForPressure 
Public propertyLiquidViscosity_MixingRule 
Public propertyLiquidViscosityCalculationMode_Subcritical 
Public propertyLiquidViscosityCalculationMode_Supercritical 
Public propertyMobileCompatible 
Public propertymoreInfo 
Public propertyName 
Public propertyoperation 
Public propertyOverrideEnthalpyCalculation 
Public propertyOverrideEntropyCalculation 
Public propertyOverrideKvalFugCoeff 
Public propertyPackageType 
Public propertyparameters1 Returns an ICapeCollection interface.
Public propertyParametersXMLString ' For mobile compatibility only.
Public propertyPhaseMappings 
Public propertyPopular 
Public propertyPropertyMethodsInfo 
Public propertyPropertyOverrides 
Public propertyscope 
Public propertyShouldUseKvalueMethod2 
Public propertyShouldUseKvalueMethod3 
Public propertysimulationContext Allows the PME to convey the PMC a reference to the former’s simulation context.
Public propertySingleCompoundCheckThreshold 
Public propertySolidPhaseEnthalpy_UsesCp 
Public propertySolidPhaseFugacity_UseIdealLiquidPhaseFugacity 
Public propertySolidPhaseFugacityCalculationMethod 
Public propertySupportedComponents 
Public propertyTag 
Public propertyUniqueID 
Public propertyUseHenryConstants 
Public propertyVaporPhaseFugacityCalculationMode 
Top
Methods
 NameDescription
Public methodAddDefaultCompounds 
Public methodAUX_CheckTrivial 
Public methodAUX_CONDTG 
Public methodAUX_CONDTL 
Public methodAUX_CONVERT_MASS_TO_MOL(Double) 
Public methodAUX_CONVERT_MASS_TO_MOL(String, Int32) 
Public methodAUX_CONVERT_MOL_TO_MASS(Double) 
Public methodAUX_CONVERT_MOL_TO_MASS(String, Int32) 
Public methodAUX_CPi(ICompoundConstantProperties, Double) 
Public methodAUX_CPi(String, Double) 
Public methodAUX_CPm(IPhase, Double) 
Public methodAUX_CPm(Phase, Double) 
Public methodAUX_CPm1 
Public methodAUX_DELGF_T 
Public methodAUX_DELGFM_T 
Public methodAUX_DELGig_RT 
Public methodAUX_DELHig_RT 
Public methodAUX_ERASE 
Public methodAUX_GFm25(Double) 
Public methodAUX_GFm25(Phase) 
Public methodAUX_HFm25(Double) 
Public methodAUX_HFm25(Phase) 
Public methodAUX_HFUSi 
Public methodAUX_HVAPi 
Public methodAUX_INT_CPDT_Ti 
Public methodAUX_INT_CPDT_Tm(Double, Double, Phase) 
Public methodAUX_INT_CPDT_Tm(Double, Double, Double) 
Public methodAUX_INT_CPDTi(Double, Double, ICompoundConstantProperties) 
Public methodAUX_INT_CPDTi(Double, Double, Int32) 
Public methodAUX_INT_CPDTi(Double, Double, String) 
Public methodAUX_INT_CPDTi_L(Double, Double, Int32) 
Public methodAUX_INT_CPDTi_L(Double, Double, String) 
Public methodAUX_INT_CPDTm(Double, Double, Phase) 
Public methodAUX_INT_CPDTm(Double, Double, Double) 
Public methodAUX_INT_CPDTm_L 
Public methodAUX_IS_SINGLECOMP(Double) 
Public methodAUX_IS_SINGLECOMP(Phase) 
Public methodAUX_KHenry 
Public methodAUX_KIJ 
Public methodAUX_LIQ_Cpi 
Public methodAUX_LIQCPm 
Public methodAUX_LIQDENS(Double, Array, Double, Double, Boolean) 
Public methodAUX_LIQDENS(Double, Double, Double, Int32, Boolean) 
Public methodAUX_LIQDENSi(ICompound, Double) 
Public methodAUX_LIQDENSi(ICompoundConstantProperties, Double) 
Public methodAUX_LIQDENSi(Int32, Double) 
Public methodAUX_LIQTHERMCONDi 
Public methodAUX_LIQVISCi 
Public methodAUX_LIQVISCm 
Public methodAUX_MMM(Phase) 
Public methodAUX_MMM(Phase) 
Public methodAUX_MMM(Double, String) 
Public methodAUX_MMM1 
Public methodAUX_NORMALIZE 
Public methodAUX_PCM 
Public methodAUX_PSUBLi(Int32, Double) 
Public methodAUX_PSUBLi(String, Double) 
Public methodAUX_PVAPi(ICompoundConstantProperties, Double) 
Public methodAUX_PVAPi(Int32, Double) 
Public methodAUX_PVAPi(String, Double) 
Public methodAUX_PVAPM(Object) 
Public methodAUX_PVAPM(Double, Double) 
Public methodAUX_PVAPM(Phase, Double) 
Private methodAUX_Rackett_Kij 
Private methodAUX_Rackett_PHIi 
Private methodAUX_Rackett_Tcij 
Private methodAUX_Rackett_Tcm 
Public methodAUX_SFm25(Double) 
Public methodAUX_SFm25(Phase) 
Public methodAUX_SINGLECOMPIDX(Object) 
Public methodAUX_SINGLECOMPIDX(Phase) 
Public methodAUX_SOLIDCP 
Public methodAUX_SOLIDDENS 
Public methodAUX_SOLIDDENSi 
Public methodAUX_SolidHeatCapacity 
Public methodAUX_SURFTi 
Public methodAUX_SURFTM(Double) 
Public methodAUX_SURFTM(Int32, Double) 
Public methodAUX_TBM 
Public methodAUX_TCM 
Public methodAUX_TFM 
Public methodAUX_TSATi(Double, ICompoundConstantProperties) 
Public methodAUX_TSATi(Double, Int32) 
Public methodAUX_TSATi(Double, String) 
Public methodAUX_TSATi(Double, ICompoundConstantProperties, Double) 
Public methodAUX_TSUBLi 
Public methodAUX_VAPDENS 
Public methodAUX_VAPTHERMCONDi 
Public methodAUX_VAPVISCi 
Public methodAUX_VAPVISCm 
Public methodAUX_VCM 
Public methodAUX_WM 
Public methodAUX_Z 
Public methodAUX_ZCM 
Public methodAUX_ZRAM 
Public methodCalcAdditionalEnergyTerms 
Public methodCalcAdditionalPhaseProperties 
Public methodCalcAdditionalPhaseProperties(Int32) 
Public methodCalcAndGetLnPhi This method is used to calculate the natural logarithm of the fugacity coefficients (and optionally their derivatives) in a single Phase mixture. The values of temperature, pressure and composition are specified in the argument list and the results are also returned through the argument list.
Public methodStatic memberCalcCSTDepProp 
Public methodCalcDiffusionCoefficients 
Public methodCalcEnthalpyEntropyF 
Public methodCalcEquilibrium Method responsible for calculating/delegating phase equilibria.
Public methodCalcEquilibrium1 CalcEquilibrium is used to calculate the amounts and compositions of Phases at equilibrium. CalcEquilibrium will calculate temperature and/or pressure if these are not among the two specifications that are mandatory for each Equilibrium Calculation considered.
Public methodCalcEquilibrium2 Method responsible for calculating phase equilibria.
Public methodCalcGibbsFreeEnergy 
Public methodCalcHelmholtzEnergy 
Public methodCalcIdealGasCpCv 
Public methodCalcInternalEnergy 
Public methodCalcIsothermalCompressibility(IPhase) 
Public methodCalcIsothermalCompressibility(Double, Double, Double, PhaseName) 
Public methodCalcJouleThomsonCoefficient 
Public methodCalcProp This method is responsible for doing all calculations on behalf of the Calculation Routine component.
Public methodCalcProp1 
Public methodCalcSinglePhaseProp CalcSinglePhaseProp is used to calculate properties and property derivatives of a mixture in a single Phase at the current values of temperature, pressure and composition set in the Material Object. CalcSinglePhaseProp does not perform phase Equilibrium Calculations.
Public methodCalcSolidEnthalpyFromCp 
Public methodCalcSpeedOfSound 
Public methodCalcTwoPhaseProp CalcTwoPhaseProp is used to calculate mixture properties and property derivatives that depend on two Phases at the current values of temperature, pressure and composition set in the Material Object. It does not perform Equilibrium Calculations.
Public methodCalculateEquilibrium 
Public methodCalculateEquilibrium2 
Public methodCheckEquilibriumSpec Checks whether the Property Package can support a particular type of Equilibrium Calculation.
Public methodCheckSinglePhasePropSpec Checks whether it is possible to calculate a property with the CalcSinglePhaseProp method for a given Phase.
Public methodCheckTwoPhasePropSpec Checks whether it is possible to calculate a property with the CalcTwoPhaseProp method for a given set of Phases.
Public methodClone 
Public methodClone1 
Public methodCOMaterial_GetCompositions 
Public methodCOMaterialtoDWMaterial Converts a COM Material Object into a DWSIM Material Stream.
Public methodConfigParameters 
Public methodCreatePhaseMappings 
Public methodCreatePhaseMappingsDW 
Public methodDeepClone 
Public methodDisplayAdvancedEditingForm 
Public methodDisplayEditingForm 
Public methodDisplayFlashConfigForm 
Public methodDisplayGroupedEditingForm 
Public methodDispose 
Protected methodDispose(Boolean) 
Public methodDW_CalcAdditionalEnthalpyTerm Calculates additional enthalpy terms like heat of reaction, absorption, etc
Public methodDW_CalcBubP Does a Bubble Pressure calculation for the specified liquid composition at the specified temperature.
Public methodDW_CalcBubT Does a Bubble Temperature calculation for the specified liquid composition at the specified pressure.
Public methodDW_CalcCompFugCoeff 
Public methodDW_CalcCompMassFlow 
Public methodDW_CalcCompMolarFlow 
Public methodDW_CalcCompPartialVolume 
Public methodDW_CalcCompVolFlow 
Public methodDW_CalcConcentrations 
Public methodDW_CalcCp_ISOLObsolete.
Public methodDW_CalcCv_ISOLObsolete.
Public methodDW_CalcdEnthalpydmoles 
Public methodDW_CalcdEnthalpydT 
Public methodDW_CalcdEntropydmoles 
Public methodDW_CalcdEntropydT 
Public methodDW_CalcDewP Does a Dew Pressure calculation for the specified vapor phase composition at the specified temperature.
Public methodDW_CalcDewT Does a Dew Temperature calculation for the specified vapor composition at the specified pressure.
Public methodDW_CalcdFugCoeffdT 
Public methodDW_CalcdKdT 
Public methodDW_CalcEnergyFlowMistura_ISOLObsolete.
Public methodDW_CalcEnthalpy Calculates the enthalpy of a mixture.
Public methodDW_CalcEnthalpyDeparture Calculates the enthalpy departure of a mixture.
Public methodDW_CalcEnthalpyOfReaction Calculater enthalpy of reaction for a given phase
Public methodDW_CalcEntropy Calculates the entropy of a mixture.
Public methodDW_CalcEntropyDeparture Calculates the entropy departure of a mixture.
Public methodDW_CalcEquilibrio_ISOLObsolete.
Public methodDW_CalcEquilibrium 
Public methodDW_CalcFugCoeff(Double, Double, Double) Calculates fugacity coefficients for the specified composition at the specified conditions.
Public methodDW_CalcFugCoeff(Array, Double, Double, State) Calculates fugacity coefficients for the specified composition at the specified conditions.
Public methodDW_CalcGibbsEnergy 
Public methodDW_CalcK_ISOLObsolete.
Public methodDW_CalcKvalue 
Public methodDW_CalcKvalue(Array, Double, Double) Calculates K-values of components in a mixture.
Public methodDW_CalcKvalue(Double, Double, Double, Double, String) Calculates K-values of components in a mixture.
Public methodDW_CalcKvalue_Ideal_VP Calculates Ideal K-values using Vapor Pressures.
Public methodDW_CalcKvalue_Ideal_Wilson Calculates Ideal K-values using Critical Properties.
Public methodDW_CalcKvalue3 Calculates K-values of components in a mixture.
Public methodDW_CalcLiqMixtureProps 
Public methodDW_CalcMassaEspecifica_ISOLObsolete.
Public methodDW_CalcMM_ISOLObsolete.
Public methodDW_CalcOverallDensity 
Public methodDW_CalcOverallProps 
Public methodDW_CalcP Calculates system pressure for the specified temperature, volume and composition.
Public methodDW_CalcPhaseProps 
Public methodDW_CalcProp Provides a wrapper function for CAPE-OPEN CalcProp/CalcSingleProp functions.
Public methodDW_CalcPVAP_ISOLObsolete.
Public methodDW_CalcSolidEnthalpy 
Public methodDW_CalcSolidFugCoeff 
Public methodDW_CalcSolidHeatCapacityCp 
Public methodDW_CalcSolidPhaseProps Provides a default implementation for solid phase property calculations in CAPE-OPEN mode. Should be used by all derived propety packages.
Public methodDW_CalcTensaoSuperficial_ISOLObsolete.
Public methodDW_CalcTwoPhaseProps 
Public methodDW_CalculateCriticalPoints Calculate the critical points of the current Material Stream
Public methodDW_CalcVazaoMassica 
Public methodDW_CalcVazaoMolar 
Public methodDW_CalcVazaoVolumetrica 
Public methodDW_CalcViscosidadeDinamica_ISOLObsolete.
Public methodDW_CheckKvaluesConsistency 
Public methodDW_GetConstantProperties 
Public methodDW_ReturnBinaryEnvelope This function returns points to build the binary phase envelope.
Public methodDW_ReturnPhaseEnvelope This function returns points to build the phase envelope.
Public methodDW_ZerarComposicoes 
Public methodDW_ZerarOverallProps 
Public methodDW_ZerarPhaseProps 
Public methodDW_ZerarTwoPhaseProps 
Public methodDW_ZerarVazaoMassica 
Public methodDW_ZerarVazaoMolar 
Public methodDW_ZerarVazaoVolumetrica 
Public methodEdit The PMC displays its user interface and allows the Flowsheet User to interact with it. If no user interface is available it returns an error.
Private methodEnthalpyPx 
Private methodEnthalpyTx 
Private methodEntropyPx 
Private methodEntropyTx 
Public methodGetAdvancedEditingContainers 
Public methodGetAdvancedEditingForm 
Public methodGetAsObject 
Public methodGetClassID 
Public methodGetComponentConstant Returns the values of the Constant properties of the compounds contained in the passed Material Object.
Public methodGetComponentList Returns the list of compounds of a given Property Package.
Public methodGetCompoundConstant Returns the values of constant Physical Properties for the specified Compounds.
Public methodGetCompoundList Returns the list of all Compounds. This includes the Compound identifiers recognised and extra information that can be used to further identify the Compounds.
Public methodGetConstPropList Returns the list of supported constant Physical Properties.
Public methodGetDisplayIcon 
Public methodGetEditingForm 
Public methodStatic memberGetEquationString 
Private methodGetFlash 
Public methodGetModel 
Public methodGetNumCompounds Returns the number of Compounds supported.
Public methodGetNumPhases 
Public methodStatic memberGetOverallPropList 
Public methodGetPDependentProperty Returns the values of pressure-dependent Physical Properties for the specified pure Compounds.
Public methodGetPDependentPropList Returns the list of supported pressure-dependent properties.
Public methodGetPhaseInfo Returns information on an attribute associated with a Phase for the purpose of understanding what lies behind a Phase label.
Public methodGetPhaseList Provides the list of the supported phases. When supported for one or more property calculations, the Overall phase and multiphase identifiers must be returned by this method.
Public methodGetPhaseList1 Returns Phase labels and other important descriptive information for all the Phases supported.
Public methodGetPropList Returns list of properties supported by the Property Package.
Public methodGetPropList1 
Public methodGetSinglePhasePropList Returns the list of supported non-constant single-phase Physical Properties.
Public methodGetSizeMax 
Public methodGetTDependentProperty Returns the values of temperature-dependent Physical Properties for the specified pure Compounds.
Public methodGetTDependentPropList Returns the list of supported temperature-dependent Physical Properties.
Public methodGetTwoPhasePropList Returns the list of supported non-constant two-phase properties.
Public methodGetUniversalConstant Returns the values of the Universal Constants.
Public methodGetUniversalConstant1 Retrieves the value of a Universal Constant.
Public methodGetUniversalConstantList Returns the identifiers of the supported Universal Constants.
Public methodHasHenryConstants 
Public methodInitCO 
Public methodInitialize Initially, this method was only present in the ICapeUnit interface. Since ICapeUtilities.Initialize is now available for any kind of PMC, ICapeUnit. Initialize is deprecated. The PME will order the PMC to get initialized through this method. Any initialisation that could fail must be placed here. Initialize is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialization persistence methods). Initialize has to be called once when the PMC is instantiated in a particular flowsheet. When the initialization fails, before signalling an error, the PMC must free all the resources that were allocated before the failure occurred. When the PME receives this error, it may not use the PMC anymore. The method terminate of the current interface must not either be called. Hence, the PME may only release the PMC through the middleware native mechanisms.
Public methodInitNew 
Public methodIsDirty 
Public methodLoad 
Public methodLoadAdditionalCompounds 
Public methodLoadBDDB 
Public methodLoadCheDLDB 
Public methodLoadCPDB 
Public methodLoadCSDB 
Public methodLoadData 
Public methodLoadDWSIMDB 
Public methodLoadEDB 
Public methodLoadUserDBs 
Private methodMyResolveEventHandler 
Public methodObjectCopy 
Public methodStatic memberParseEquation 
Public methodProcessOverridenProperties 
Public methodPropCheck Check to see if properties can be calculated.
Public methodPropCheck1 Checks to see if a given type of flash calculations can be performed and whether the properties can be calculated after the flash calculation.
Public methodPropCheck2 
Public methodPropList Returns the flash types, properties, phases, and calculation types that are supported by a given Equilibrium Server Routine.
Public methodRET_Gid(Double, Double, Double, Phase) 
Public methodRET_Gid(Double, Double, Double, Double) 
Public methodRET_Gid_i 
Public methodRET_HFUSM 
Public methodRET_Hid(Double, Double, Phase) 
Public methodRET_Hid(Double, Double, Double) 
Public methodRET_Hid_FromLiqCp 
Public methodRET_Hid_i 
Public methodRET_Hid_i_L 
Public methodRET_Hid_L 
Public methodRET_HVAPM 
Public methodRET_NullVector 
Public methodRET_PHASECODE 
Public methodRET_PHASEID 
Public methodRET_Sid(Double, Double, Double, Phase) 
Public methodRET_Sid(Double, Double, Double, Double) 
Public methodRET_Sid_FromLiqCp 
Public methodRET_Sid_i 
Public methodRET_Sid_L 
Public methodRET_UnitaryVector 
Public methodRET_VCAS 
Public methodRET_VCP 
Public methodRET_VCSACIDS 
Public methodRET_VCSTLDAF 
Public methodRET_VCSTLDCV 
Public methodRET_VDHF 
Public methodRET_VHF 
Public methodRET_VHVAP 
Public methodRET_VIDS 
Public methodRET_VKij 
Public methodRET_VMAS 
Public methodRET_VMM 
Public methodRET_VMOL 
Public methodRET_VNAMES 
Public methodRET_VNAMES2 
Public methodRET_VPC 
Public methodRET_VPVAP 
Public methodRET_VTB 
Public methodRET_VTC 
Public methodRET_VTF 
Public methodRET_VVC 
Public methodRET_VW 
Public methodRET_VZC 
Public methodRET_VZRa 
Public methodReturnInstance 
Public methodRunPostMaterialStreamSetRoutine 
Public methodSave 
Public methodSaveData 
Public methodSetMaterial Allows the client of a component that implements this interface to pass an ICapeThermoMaterial interface to the component, so that it can access the properties of a Material.
Public methodSetPhaseEquilibriaCalculationMode Sets the Phase Equilibria Calculation mode for this instance. Default behavior is SVLLE.
Public methodShouldBypassEquilibriumCalculation 
Public methodSupportsComponent 
Public methodTerminate Initially, this method was only present in the ICapeUnit interface. Since ICapeUtilities.Terminate is now available for any kind of PMC, ICapeUnit.Terminate is deprecated. The PME will order the PMC to get destroyed through this method. Any uninitialization that could fail must be placed here. ‘Terminate’ is guaranteed to be the last method called by the client (except low level methods such as class destructors). ‘Terminate’ may be called at any time, but may be only called once. When this method returns an error, the PME should report the user. However, after that the PME is not allowed to use the PMC anymore. The Unit specification stated that “Terminate may check if the data has been saved and return an error if not.” It is suggested not to follow this recommendation, since it’s the PME responsibility to save the state of the PMC before terminating it. In the case that a user wants to close a simulation case without saving it, it’s better to leave the PME to handle the situation instead of each PMC providing a different implementation.
Public methodThrowCAPEException 
Public methodToString
(Overrides ObjectToString)
Public methodUnsetMaterial Removes any previously set Material interface.
Public methodValidityCheck Checks the validity of the calculation. This method is deprecated.
Public methodValidityCheck1 
Public methodValidityCheck2 
Top
Fields
Extension Methods
 NameDescription
Public Extension MethodGetEnumNames
(Defined by General)
Public Extension MethodIsValidDouble
(Defined by General)
Top
Remarks
The base class is inherited by each implemented property package, which contains its own methods.
See Also
Inheritance Hierarchy