Property
The Property Package Class contains methods to do thermodynamic calculations for all supported phases in DWSIM.
Definition
Namespace: DWSIM.Thermodynamics.PropertyPackages
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 10.0.0.0
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 10.0.0.0
C#
[SerializableAttribute]
public abstract class PropertyPackage : ICapeIdentification,
ICapeThermoPropertyPackage, ICapeUtilities, ICapeThermoEquilibriumServer, ICapeThermoCalculationRoutine, ICapeThermoPhases,
ICapeThermoPropertyRoutine, ICapeThermoCompounds, ICapeThermoUniversalConstant, ICapeThermoMaterialContext, ICapeThermoEquilibriumRoutine,
IPersistStreamInit, ECapeUser, ECapeUnknown, ECapeRoot, IDisposable,
ICustomXMLSerialization, IPropertyPackageVB
<SerializableAttribute>
Public MustInherit Class PropertyPackage
Implements ICapeIdentification, ICapeThermoPropertyPackage, ICapeUtilities, ICapeThermoEquilibriumServer,
ICapeThermoCalculationRoutine, ICapeThermoPhases, ICapeThermoPropertyRoutine, ICapeThermoCompounds, ICapeThermoUniversalConstant,
ICapeThermoMaterialContext, ICapeThermoEquilibriumRoutine, IPersistStreamInit, ECapeUser, ECapeUnknown,
ECapeRoot, IDisposable, ICustomXMLSerialization, IPropertyPackage- Inheritance
- Object PropertyPackage
- Derived
- Implements
- ECapeRoot, ECapeUnknown, ECapeUser, ICapeIdentification, ICapeThermoCalculationRoutine, ICapeThermoCompounds, ICapeThermoEquilibriumRoutine, ICapeThermoEquilibriumServer, ICapeThermoMaterialContext, ICapeThermoPhases, ICapeThermoPropertyPackage, ICapeThermoPropertyRoutine, ICapeThermoUniversalConstant, ICapeUtilities, ICustomXMLSerialization, IPersistStreamInit, IPropertyPackage, IDisposable
Remarks
The base class is inherited by each implemented property package, which contains its own methods.
Constructors
Properties
Methods
| AddDefaultCompounds | |
| AUX_CheckTrivial | |
| AUX_CONDTG | |
| AUX_CONDTL | |
| AUX_CONVERT_MASS_TO_MOL(Double) | |
| AUX_CONVERT_MASS_TO_MOL(String, Int32) | |
| AUX_CONVERT_MOL_TO_MASS(Double) | |
| AUX_CONVERT_MOL_TO_MASS(String, Int32) | |
| AUX_CPi(ICompoundConstantProperties, Double) | |
| AUX_CPi(String, Double) | |
| AUX_CPm(IPhase, Double) | |
| AUX_CPm(Phase, Double) | |
| AUX_CPm1 | |
| AUX_DELGF_T | |
| AUX_DELGFM_T | |
| AUX_DELGig_RT | |
| AUX_DELHig_RT | |
| AUX_ERASE | |
| AUX_GFm25(Double) | |
| AUX_GFm25(Phase) | |
| AUX_HFm25(Double) | |
| AUX_HFm25(Phase) | |
| AUX_HFUSi | |
| AUX_HVAPi | |
| AUX_INT_CPDT_Ti | |
| AUX_INT_CPDT_Tm(Double, Double, Phase) | |
| AUX_INT_CPDT_Tm(Double, Double, Double) | |
| AUX_INT_CPDTi(Double, Double, ICompoundConstantProperties) | |
| AUX_INT_CPDTi(Double, Double, Int32) | |
| AUX_INT_CPDTi(Double, Double, String) | |
| AUX_INT_CPDTi_L(Double, Double, Int32) | |
| AUX_INT_CPDTi_L(Double, Double, String) | |
| AUX_INT_CPDTm(Double, Double, Phase) | |
| AUX_INT_CPDTm(Double, Double, Double) | |
| AUX_INT_CPDTm_L | |
| AUX_IS_SINGLECOMP(Double) | |
| AUX_IS_SINGLECOMP(Phase) | |
| AUX_KHenry | |
| AUX_KIJ | |
| AUX_LIQ_Cpi | |
| AUX_LIQCPm | |
| AUX_LIQDENS(Double, Array, Double, Double, Boolean) | |
| AUX_LIQDENS(Double, Double, Double, Int32, Boolean) | |
| AUX_LIQDENSi(ICompound, Double) | |
| AUX_LIQDENSi(ICompoundConstantProperties, Double) | |
| AUX_LIQDENSi(Int32, Double) | |
| AUX_LIQTHERMCONDi | |
| AUX_LIQVISCi | |
| AUX_LIQVISCm | |
| AUX_MMM(Phase) | |
| AUX_MMM(Phase) | |
| AUX_MMM(Double, String) | |
| AUX_MMM1 | |
| AUX_NORMALIZE | |
| AUX_PCM | |
| AUX_PSUBLi(Int32, Double) | |
| AUX_PSUBLi(String, Double) | |
| AUX_PVAPi(ICompoundConstantProperties, Double) | |
| AUX_PVAPi(Int32, Double) | |
| AUX_PVAPi(String, Double) | |
| AUX_PVAPM(Object) | |
| AUX_PVAPM(Double, Double) | |
| AUX_PVAPM(Phase, Double) | |
| AUX_Rackett_Kij | |
| AUX_Rackett_PHIi | |
| AUX_Rackett_Tcij | |
| AUX_Rackett_Tcm | |
| AUX_SFm25(Double) | |
| AUX_SFm25(Phase) | |
| AUX_SINGLECOMPIDX(Object) | |
| AUX_SINGLECOMPIDX(Phase) | |
| AUX_SOLIDCP | |
| AUX_SOLIDDENS | |
| AUX_SOLIDDENSi | |
| AUX_SolidHeatCapacity | |
| AUX_SURFTi | |
| AUX_SURFTM(Double) | |
| AUX_SURFTM(Int32, Double) | |
| AUX_TBM | |
| AUX_TCM | |
| AUX_TFM | |
| AUX_TSATi(Double, ICompoundConstantProperties) | |
| AUX_TSATi(Double, Int32) | |
| AUX_TSATi(Double, String) | |
| AUX_TSATi(Double, ICompoundConstantProperties, Double) | |
| AUX_TSUBLi | |
| AUX_VAPDENS | |
| AUX_VAPTHERMCONDi | |
| AUX_VAPVISCi | |
| AUX_VAPVISCm | |
| AUX_VCM | |
| AUX_WM | |
| AUX_Z | |
| AUX_ZCM | |
| AUX_ZRAM | |
| CalcAdditionalEnergyTerms | |
| CalcAdditionalPhaseProperties | |
| CalcAdditionalPhaseProperties(Int32) | |
| CalcAndGetLnPhi | 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. |
| CalcCSTDepProp | |
| CalcDiffusionCoefficients | |
| CalcEnthalpyEntropyF | |
| CalcEquilibrium | Method responsible for calculating/delegating phase equilibria. |
| CalcEquilibrium1 | 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. |
| CalcEquilibrium2 | Method responsible for calculating phase equilibria. |
| CalcGibbsFreeEnergy | |
| CalcHelmholtzEnergy | |
| CalcIdealGasCpCv | |
| CalcInternalEnergy | |
| CalcIsothermalCompressibility(IPhase) | |
| CalcIsothermalCompressibility(Double, Double, Double, PhaseName) | |
| CalcJouleThomsonCoefficient | |
| CalcProp | This method is responsible for doing all calculations on behalf of the Calculation Routine component. |
| CalcProp1 | |
| CalcSinglePhaseProp | 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. |
| CalcSolidEnthalpyFromCp | |
| CalcSpeedOfSound | |
| CalcTwoPhaseProp | 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. |
| CalculateCriticalPointForEnvelope | |
| CalculateEquilibrium | |
| CalculateEquilibrium2 | |
| CheckCompounds | |
| CheckEquilibriumSpec | Checks whether the Property Package can support a particular type of Equilibrium Calculation. |
| CheckSinglePhasePropSpec | Checks whether it is possible to calculate a property with the CalcSinglePhaseProp method for a given Phase. |
| CheckTwoPhasePropSpec | Checks whether it is possible to calculate a property with the CalcTwoPhaseProp method for a given set of Phases. |
| Clone | |
| Clone1 | |
| COMaterial_GetCompositions | |
| COMaterialtoDWMaterial | Converts a COM Material Object into a DWSIM Material Stream. |
| ConfigParameters | |
| CreatePhaseMappings | |
| CreatePhaseMappingsDW | |
| DeepClone | |
| DisplayAdvancedEditingForm | |
| DisplayEditingForm | |
| DisplayFlashConfigForm | |
| DisplayGroupedEditingForm | |
| Dispose | |
| Dispose(Boolean) | |
| DW_CalcAdditionalEnthalpyTerm | Calculates additional enthalpy terms like heat of reaction, absorption, etc |
| DW_CalcBubP | Does a Bubble Pressure calculation for the specified liquid composition at the specified temperature. |
| DW_CalcBubT | Does a Bubble Temperature calculation for the specified liquid composition at the specified pressure. |
| DW_CalcCompFugCoeff | |
| DW_CalcCompMassFlow | |
| DW_CalcCompMolarFlow | |
| DW_CalcCompPartialVolume | |
| DW_CalcCompVolFlow | |
| DW_CalcConcentrations | |
| DW_CalcCp_ISOL | |
| DW_CalcCv_ISOL | |
| DW_CalcdEnthalpydmoles | |
| DW_CalcdEnthalpydT | |
| DW_CalcdEntropydmoles | |
| DW_CalcdEntropydT | |
| DW_CalcDewP | Does a Dew Pressure calculation for the specified vapor phase composition at the specified temperature. |
| DW_CalcDewT | Does a Dew Temperature calculation for the specified vapor composition at the specified pressure. |
| DW_CalcdFugCoeffdT | |
| DW_CalcdKdT | |
| DW_CalcEnergyFlowMistura_ISOL | |
| DW_CalcEnthalpy | Calculates the enthalpy of a mixture. |
| DW_CalcEnthalpyDeparture | Calculates the enthalpy departure of a mixture. |
| DW_CalcEnthalpyOfReaction | Calculater enthalpy of reaction for a given phase |
| DW_CalcEntropy | Calculates the entropy of a mixture. |
| DW_CalcEntropyDeparture | Calculates the entropy departure of a mixture. |
| DW_CalcEquilibrio_ISOL | |
| DW_CalcEquilibrium | |
| DW_CalcFugCoeff(Double, Double, Double) | Calculates fugacity coefficients for the specified composition at the specified conditions. |
| DW_CalcFugCoeff(Array, Double, Double, State) | Calculates fugacity coefficients for the specified composition at the specified conditions. |
| DW_CalcGibbsEnergy | |
| DW_CalcK_ISOL | |
| DW_CalcKvalue | |
| DW_CalcKvalue(Array, Double, Double) | Calculates K-values of components in a mixture. |
| DW_CalcKvalue(Double, Double, Double, Double, String) | Calculates K-values of components in a mixture. |
| DW_CalcKvalue_Ideal_VP | Calculates Ideal K-values using Vapor Pressures. |
| DW_CalcKvalue_Ideal_Wilson | Calculates Ideal K-values using Critical Properties. |
| DW_CalcKvalue3 | Calculates K-values of components in a mixture. |
| DW_CalcLiqMixtureProps | |
| DW_CalcMassaEspecifica_ISOL | |
| DW_CalcMM_ISOL | |
| DW_CalcOverallDensity | |
| DW_CalcOverallProps | |
| DW_CalcP | Calculates system pressure for the specified temperature, volume and composition. |
| DW_CalcPhaseProps | |
| DW_CalcProp | Provides a wrapper function for CAPE-OPEN CalcProp/CalcSingleProp functions. |
| DW_CalcPVAP_ISOL | |
| DW_CalcSolidEnthalpy | |
| DW_CalcSolidFugCoeff | |
| DW_CalcSolidHeatCapacityCp | |
| DW_CalcSolidPhaseProps | Provides a default implementation for solid phase property calculations in CAPE-OPEN mode. Should be used by all derived propety packages. |
| DW_CalcTensaoSuperficial_ISOL | |
| DW_CalcTwoPhaseProps | |
| DW_CalculateCriticalPoints | Calculate the critical points of the current Material Stream |
| DW_CalcVazaoMassica | |
| DW_CalcVazaoMolar | |
| DW_CalcVazaoVolumetrica | |
| DW_CalcViscosidadeDinamica_ISOL | |
| DW_CheckKvaluesConsistency | |
| DW_GetConstantProperties | |
| DW_ReturnBinaryEnvelope | This function returns points to build the binary phase envelope. |
| DW_ReturnPhaseEnvelope | |
| DW_ZerarComposicoes | |
| DW_ZerarOverallProps | |
| DW_ZerarPhaseProps | |
| DW_ZerarTwoPhaseProps | |
| DW_ZerarVazaoMassica | |
| DW_ZerarVazaoMolar | |
| DW_ZerarVazaoVolumetrica | |
| Edit | 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. |
| EnthalpyPx | |
| EnthalpyTx | |
| EntropyPx | |
| EntropyTx | |
| GetAdvancedEditingContainers | |
| GetAdvancedEditingForm | |
| GetAsObject | |
| GetClassID | |
| GetComponentConstant | Returns the values of the Constant properties of the compounds contained in the passed Material Object. |
| GetComponentList | Returns the list of compounds of a given Property Package. |
| GetCompoundConstant | Returns the values of constant Physical Properties for the specified Compounds. |
| GetCompoundList | Returns the list of all Compounds. This includes the Compound identifiers recognised and extra information that can be used to further identify the Compounds. |
| GetConstPropList | Returns the list of supported constant Physical Properties. |
| GetDisplayIcon | |
| GetEditingForm | |
| GetEquationString | |
| GetFlash | |
| GetModel | |
| GetNumCompounds | Returns the number of Compounds supported. |
| GetNumPhases | |
| GetOverallPropList | |
| GetPDependentProperty | Returns the values of pressure-dependent Physical Properties for the specified pure Compounds. |
| GetPDependentPropList | Returns the list of supported pressure-dependent properties. |
| GetPhaseInfo | Returns information on an attribute associated with a Phase for the purpose of understanding what lies behind a Phase label. |
| GetPhaseList | 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. |
| GetPhaseList1 | Returns Phase labels and other important descriptive information for all the Phases supported. |
| GetPropList | Returns list of properties supported by the Property Package. |
| GetPropList1 | |
| GetSinglePhasePropList | Returns the list of supported non-constant single-phase Physical Properties. |
| GetSizeMax | |
| GetTDependentProperty | Returns the values of temperature-dependent Physical Properties for the specified pure Compounds. |
| GetTDependentPropList | Returns the list of supported temperature-dependent Physical Properties. |
| GetTwoPhasePropList | Returns the list of supported non-constant two-phase properties. |
| GetUniversalConstant | Returns the values of the Universal Constants. |
| GetUniversalConstant1 | Retrieves the value of a Universal Constant. |
| GetUniversalConstantList | Returns the identifiers of the supported Universal Constants. |
| HasHenryConstants | |
| InitCO | |
| Initialize | 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. |
| InitNew | |
| IsDirty | |
| Load | |
| LoadAdditionalCompounds | |
| LoadBDDB | |
| LoadCheDLDB | |
| LoadCPDB | |
| LoadCSDB | |
| LoadData | |
| LoadDWSIMDB | |
| LoadEDB | |
| LoadUserDBs | |
| MyResolveEventHandler | |
| ObjectCopy | |
| ParseEquation | |
| ProcessOverridenProperties | |
| PropCheck | Check to see if properties can be calculated. |
| PropCheck1 | Checks to see if a given type of flash calculations can be performed and whether the properties can be calculated after the flash calculation. |
| PropCheck2 | |
| PropList | Returns the flash types, properties, phases, and calculation types that are supported by a given Equilibrium Server Routine. |
| RET_Gid(Double, Double, Double, Phase) | |
| RET_Gid(Double, Double, Double, Double) | |
| RET_Gid_i | |
| RET_HFUSM | |
| RET_Hid(Double, Double, Phase) | |
| RET_Hid(Double, Double, Double) | |
| RET_Hid_FromLiqCp | |
| RET_Hid_i | |
| RET_Hid_i_L | |
| RET_Hid_L | |
| RET_HVAPM | |
| RET_NullVector | |
| RET_PHASECODE | |
| RET_PHASEID | |
| RET_Sid(Double, Double, Double, Phase) | |
| RET_Sid(Double, Double, Double, Double) | |
| RET_Sid_FromLiqCp | |
| RET_Sid_i | |
| RET_Sid_L | |
| RET_UnitaryVector | |
| RET_VCAS | |
| RET_VCP | |
| RET_VCSACIDS | |
| RET_VCSTLDAF | |
| RET_VCSTLDCV | |
| RET_VDHF | |
| RET_VHF | |
| RET_VHVAP | |
| RET_VIDS | |
| RET_VKij | |
| RET_VMAS | |
| RET_VMM | |
| RET_VMOL | |
| RET_VNAMES | |
| RET_VNAMES2 | |
| RET_VPC | |
| RET_VPVAP | |
| RET_VTB | |
| RET_VTC | |
| RET_VTF | |
| RET_VVC | |
| RET_VW | |
| RET_VZC | |
| RET_VZRa | |
| ReturnInstance | |
| RunPostMaterialStreamSetRoutine | |
| Save | |
| SaveData | |
| SetMaterial | 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. |
| SetPhaseEquilibriaCalculationMode | Sets the Phase Equilibria Calculation mode for this instance. Default behavior is SVLLE. |
| ShouldBypassEquilibriumCalculation | |
| SupportsComponent | |
| Terminate | 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. |
| ThrowCAPEException | |
| ToString | (Overrides ObjectToString) |
| UnsetMaterial | Removes any previously set Material interface. |
| ValidityCheck | Checks the validity of the calculation. This method is deprecated. |
| ValidityCheck1 | |
| ValidityCheck2 |
Fields
Extension Methods
| GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |