Material
Methods
| _GetComponentList | |
| Add | Adds a material stream to this one, returning the resulting mixed stream, leaving this instance unmodifed. |
| AddDynamicProperty | (Inherited from BaseClass) |
| AddExtraProperty | (Inherited from BaseClass) |
| AppendDebugLine | (Inherited from BaseClass) |
| Assign | Copies basic properties from another stream. |
| AssignFromPhase | Assign properties from another phase in another stream. |
| AssignProps | Copies phase properties from another stream. |
| AssignSelfToPP | Sets this stream as the current material stream on the associated property package. |
| AssignSolidData | Copies solid particle and additional solid phase data from another stream. |
| AvailableProps | Gets a list of properties that have been calculated. |
| 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. |
| CalcEquilibrium | This method is responsible for calculating a flash or delegating flash calculations to the associated Property Package or Equilibrium Server. |
| 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 | CAPE-OPEN 1.0 ICapeThermoEquilibriumServer: Calculates equilibrium. Delegates to the associated property package. |
| CalcEquilibrium3 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Calculates equilibrium. Delegates to the associated property package. |
| CalcOverallCompMassFractions | Calculates and stores the overall mass fractions for each compound from the current mole fractions and molecular weights. |
| CalcOverallCompMoleFractions | Calculates and stores the overall mole fractions for each compound from the current mass fractions and molecular weights. |
| CalcOverallMolecularWeight | Calculates the molecular weight of the overall mixture from current mole fractions and compound molecular weights. |
| CalcPhaseMassComposition | Calculates and stores the mass fractions for each compound in the specified phase, based on the current mole fractions. |
| CalcProp | This method is responsible for doing all property calculations or delegating these calculations to the associated Property Package. |
| CalcProp1 | CAPE-OPEN 1.0: Calculates properties for a material object. Delegates to the associated property package. |
| CalcProp2 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Calculates properties. Delegates to the associated property package. |
| 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. |
| 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. |
| Calculate(Object) |
Triggers a full equilibrium and property calculation for this stream, respecting flowsheet options.
(Overrides BaseClassCalculate(Object)) |
| Calculate(Boolean, Boolean) | Calculates equilibrium and/or properties for this stream. |
| CheckDirtyStatus |
Compares the current stream inputs against the last solution snapshot and marks the stream dirty if anything has changed.
(Overrides BaseClassCheckDirtyStatus) |
| 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. |
| CheckSpec |
Checks if a value is valid.
(Inherited from BaseClass) |
| CheckTwoPhasePropSpec | Checks whether it is possible to calculate a property with the CalcTwoPhaseProp method for a given set of Phases. |
| Clear | Clears the basic phase properties of this stream. |
| ClearAllProps | Remove all stored Physical Property values. |
| ClearCalculatedProps | Clear all calculated props on this stream. |
| ClearExtraProperties | (Inherited from BaseClass) |
| ClearPropertyPackageInstance |
Removes the directly-assigned property package instance, reverting to flowsheet lookup.
(Overrides BaseClassClearPropertyPackageInstance) |
| Clone |
Creates and returns a shallow clone of this stream.
(Overrides BaseClassClone) |
| Clone1 | Creates and returns a shallow clone of this stream as an IMaterialStream. |
| CloneJSON |
Creates a deep copy of this stream using JSON serialization.
(Overrides BaseClassCloneJSON) |
| CloneXML |
Creates a deep copy of this stream by adding compounds from the flowsheet and copying all properties.
(Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm |
Closes the stream editor form if it is currently open.
(Overrides BaseClassCloseEditForm) |
| ConnectEnergyStream | (Inherited from BaseClass) |
| ConnectFeedEnergyStream | (Inherited from BaseClass) |
| ConnectFeedMaterialStream | (Inherited from BaseClass) |
| ConnectProductEnergyStream | (Inherited from BaseClass) |
| ConnectProductMaterialStream | (Inherited from BaseClass) |
| CopyCompositions | Copy mass/mole fractions from one phase to another. |
| CopyDataToClipboard |
Copies the object properties to the Clipboard.
(Inherited from BaseClass) |
| CopyFromMaterial | Copies all the stored non-constant Physical Properties (which have been set using the SetSinglePhaseProp, SetTwoPhaseProp or SetOverallProp) from the source Material Object to the current instance of the Material Object. |
| CreateDynamicProperties | (Inherited from BaseClass) |
| CreateMaterial | Creates a Material Object with the same configuration as the current Material Object. |
| CreateMaterialObject | Create a Material Object from the parent Material Template of the current Material Object. |
| CreateMaterialObject1 | CAPE-OPEN 1.0 ICapeThermoMaterialTemplate: Creates a new material object from this template. Delegates to CreateMaterial. |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | (Inherited from BaseClass) |
| DeepClear | Clears basic phase properties and all calculated thermodynamic properties on this stream. |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm |
Opens or activates the stream editor form.
(Overrides BaseClassDisplayEditForm) |
| DisplayExtraPropertiesEditForm | (Inherited from BaseClass) |
| Dispose | (Inherited from BaseClass) |
| Dispose(Boolean) | (Inherited from BaseClass) |
| Duplicate | Creates a duplicate of the current Material Object. |
| Empty | Clears all phase properties, including temperature, pressure and overall composition. |
| EmptyPropertyPackage | |
| EqualizeOverallComposition | Sets equal mole fractions for all compounds in the overall mixture. |
| FT |
Formats a property string, adding its units in parenthesis.
(Inherited from BaseClass) |
| GetAsObject | (Inherited from BaseClass) |
| GetBytesFromResource | (Inherited from BaseClass) |
| GetChartModel | (Inherited from BaseClass) |
| GetChartModelNames | (Inherited from BaseClass) |
| GetComponentConstant | Retrieve pure compound constants from the Property Package. |
| GetComponentConstant1 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Returns compound constant properties. Delegates to the associated property package. |
| GetComponentList | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Returns the list of compounds. Delegates to the associated 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. |
| GetCompoundMassConcentration | Returns the mass concentration of the specified compound in the overall mixture, in kg/m³. |
| GetCompoundMassFlow | Returns the mass flow of the specified compound in the overall mixture, in kg/s. |
| GetCompoundMolarFlow | Returns the molar flow of the specified compound in the overall mixture, in mol/s. |
| GetCompoundNames | Returns an array of compound names present in this stream. |
| GetConnectionPortsInfo | (Inherited from BaseClass) |
| GetConnectionPortsList | (Inherited from BaseClass) |
| GetConstPropList | Returns the list of supported constant Physical Properties. |
| GetDebugReport |
Runs a full equilibrium and property calculation and returns diagnostic text output for debugging.
(Overrides BaseClassGetDebugReport) |
| GetDebugWriter | (Inherited from BaseClass) |
| GetDefaultProperties |
Returns the default set of property identifiers shown for this stream in the property panel.
(Overrides BaseClassGetDefaultProperties) |
| GetDisplayDescription |
Returns the localised display description for this stream type.
(Overrides BaseClassGetDisplayDescription) |
| GetDisplayName |
Returns the localised display name for this stream type.
(Overrides BaseClassGetDisplayName) |
| GetDynamicContents | (Inherited from BaseClass) |
| GetDynamicProperty | (Inherited from BaseClass) |
| GetDynamicPropertyUnitType | (Inherited from BaseClass) |
| GetDynamicResidenceTime | (Inherited from BaseClass) |
| GetDynamicVolume | (Inherited from BaseClass) |
| GetEditingForm | (Inherited from BaseClass) |
| GetEnergyBalanceResidual | (Inherited from BaseClass) |
| GetEnergyConsumption | (Inherited from BaseClass) |
| GetEnergyFlow | Returns the total energy flow associated with this stream, in kW. |
| GetExtraPropertyValue | (Inherited from BaseClass) |
| GetFlashSpec | Returns the current flash specification as a short string code (e.g. "PT", "PH", "PS", "PVF", "TVF"). |
| GetFlowsheet | (Inherited from BaseClass) |
| GetIconBitmap |
Returns the icon bitmap for this stream object.
(Overrides BaseClassGetIconBitmap) |
| GetIconBitmapBytes |
Returns the icon bitmap as a byte array for this stream object.
(Overrides BaseClassGetIconBitmapBytes) |
| GetIndependentVar | Returns the independent variables of a Material Object. This method is deprecated. |
| GetMassBalanceResidual | (Inherited from BaseClass) |
| GetMassEnthalpy | Returns the overall mass enthalpy. |
| GetMassEntropy | Returns the overall mass entropy. |
| GetMassFlow | Returns the stream mass flow. |
| GetMolarFlow | Returns the stream molar flow. |
| GetNumComponents | Returns number of chemical compounds in Material Object. |
| GetNumCompounds | Returns the number of Compounds supported. |
| GetNumPhases | Returns the number of Phases. |
| GetOverallComposition | Returns an array with the overall molar composition. |
| GetOverallHeatOfFormation | Returns the overall heat of formation term for energy balance check, in kJ/s |
| GetOverallMassComposition | Returns an array with the overall mass composition. |
| GetOverallMolecularWeight | Returns the molecular weight of the overall mixture. |
| GetOverallProp | Retrieves non-constant Physical Property values for the overall mixture. |
| GetOverallTPFraction | Retrieves temperature, pressure and composition for the overall mixture. |
| GetPDependentProperty | Returns the values of pressure-dependent Physical Properties for the specified pure Compounds. |
| GetPDependentPropList | Returns the list of supported pressure-dependent properties. |
| GetPhase | Returns the Phase object corresponding to the given phase name. |
| GetPhaseComposition | Returns the molar composition of a phase. |
| GetPhaseInfo | Returns information on an attribute associated with a Phase for the purpose of understanding what lies behind a Phase label. |
| GetPhaseList | Returns Phase labels and other important descriptive information for all the Phases supported. |
| GetPhaseList1 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Returns the list of phase labels. Delegates to the associated property package. |
| GetPhaseMassFlow | Returns the mass flow rate of the phase with the given name, in kg/s. |
| GetPhaseMassFraction | Returns the mass fraction of the phase with the given name. |
| GetPhaseMolarFlow | Returns the molar flow rate of the phase with the given name, in mol/s. |
| GetPhaseMolarFraction | Returns the molar fraction of the phase with the given name. |
| GetPowerGeneratedOrConsumed | (Inherited from BaseClass) |
| GetPreferredGraphicObjectHeight | (Inherited from BaseClass) |
| GetPreferredGraphicObjectWidth | (Inherited from BaseClass) |
| GetPresentPhases | Returns Phase labels for the Phases that are currently present in the Material Object. |
| GetPressure | Returns the stream pressure. |
| GetProcessFlowsheetProperties | Returns the set of property identifiers displayed on the process flowsheet for this stream. |
| GetProp(String, String) | Returns a single property value for the given property and phase, using Mass basis. |
| GetProp(String, String, Object, String, String) | This method is responsible for retrieving the results from calculations from the Material Object. |
| GetProperties |
Returns the list of property identifiers for the specified property type.
(Overrides BaseClassGetProperties(PropertyType)) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription |
Returns the localised description text for the specified property identifier.
(Overrides BaseClassGetPropertyDescription(String)) |
| GetPropertyPackageObject | Returns the property package instance associated with this stream. |
| GetPropertyPackageObjectCopy | Returns a deep copy of the property package associated with this stream. |
| GetPropertyUnit |
Returns the display unit string for the given property identifier.
(Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue |
Returns the value of a named stream property converted to the specified unit system.
(Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropertyValue2 | (Inherited from BaseClass) |
| GetPropList | Returns list of properties that can be calculated by the Material Object. |
| GetPropList1 | CAPE-OPEN 1.0: Returns the list of properties that can be calculated. Delegates to GetPropList. |
| GetPropList2 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Returns the list of supported properties. Delegates to the associated property package. |
| GetPropUnits | Returns the display unit string for a given CAPE-OPEN property and basis in the specified unit system. |
| GetReport |
Generates a formatted text report for this stream.
(Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetSinglePhaseProp | Retrieves single-phase non-constant Physical Property values for a mixture. |
| GetSinglePhaseProp2 | Helper that calls GetSinglePhaseProp(String, String, String, Object) and returns the result as a typed list. |
| GetSinglePhasePropDefaultUnits | Returns the default SI unit string for the given single-phase property and basis. |
| GetSinglePhasePropList | Returns the list of supported non-constant single-phase Physical Properties. |
| GetStructuredReport |
Returns a structured list of report items (labels and values) for display in the DWSIM report panel.
(Overrides BaseClassGetStructuredReport) |
| GetTDependentProperty | Returns the values of temperature-dependent Physical Properties for the specified pure Compounds. |
| GetTDependentPropList | Returns the list of supported temperature-dependent Physical Properties. |
| GetTemperature | Returns the stream temperature. |
| GetTPFraction | Retrieves temperature, pressure and composition for a Phase. |
| GetTwoPhaseProp | Retrieves two-phase non-constant Physical Property values for a mixture. |
| GetTwoPhasePropList | Returns the list of supported non-constant two-phase properties. |
| GetUniversalConstant(Object) | Retrieves values of universal constants from the Property Package. |
| GetUniversalConstant(String) | Retrieves the value of a Universal Constant. |
| GetUniversalConstant1 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Retrieves universal constants. Delegates to the associated property package. |
| GetUniversalConstantList | Returns the identifiers of the supported Universal Constants. |
| GetVersion | (Inherited from BaseClass) |
| GetVolumetricFlow | Returns the stream volumetric flow. |
| IsDynamicProperty | (Inherited from BaseClass) |
| IsSingleCompound | Returns True if the stream consists of a single compound (mole fraction > 0.999) and is not a black-oil compound. |
| LoadData |
Restores stream state from a list of XML elements previously produced by SaveData.
(Overrides BaseClassLoadData(ListXElement)) |
| MassFractionsToMoleFractions | Converts mass fractions to mole fractions using the current compound list. |
| Mix | Mixes this stream with another one. |
| MoleFractionsToMassFractions | Converts mole fractions to mass fractions using the current compound list. |
| NormalizeOverallMassComposition | Normalises the overall mass fractions so that they sum to 1. |
| NormalizeOverallMoleComposition | Normalises the overall mole fractions so that they sum to 1. |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| PropCheck | Checks to see if a list of given properties can be calculated. |
| PropCheck1 | CAPE-OPEN 1.0: Checks whether a list of properties can be calculated. Delegates to PropCheck(Object). |
| PropCheck2 | CAPE-OPEN 1.0 ICapeThermoEquilibriumServer: Checks property validity. Delegates to the associated property package. |
| PropCheck3 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Checks whether properties can be calculated. Delegates to the associated property package. |
| PropList | CAPE-OPEN 1.0 ICapeThermoEquilibriumServer: Returns property lists. Delegates to the associated property package. |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RemoveResults | RemoveResults |
| RunDynamicModel |
Executes the dynamic model step for this stream, updating phase properties according to the integrator settings.
(Overrides BaseClassRunDynamicModel) |
| SaveData |
Serializes the stream state to a list of XML elements.
(Overrides BaseClassSaveData) |
| SetCanUsePreviousResults | (Inherited from BaseClass) |
| SetCurrentMaterialStream | |
| SetDirtyStatus | (Inherited from BaseClass) |
| SetDynamicProperty | (Inherited from BaseClass) |
| SetExtraPropertyValue | (Inherited from BaseClass) |
| SetFlashSpec | Sets stream flash spec. |
| SetFlowsheet |
Sets the Flowsheet to which this object belongs to.
(Inherited from BaseClass) |
| SetIndependentVar | SetIndependentVar |
| SetMassEnthalpy(Double) | Sets stream enthalpy. |
| SetMassEnthalpy(String) | Sets the mass enthalpy according with the specified units. |
| SetMassEntropy(Double) | Sets stream mass entropy. |
| SetMassEntropy(String) | Sets the mass entropy according with the specified units. |
| SetMassFlow(Double) | Sets stream mass flow. |
| SetMassFlow(String) | Sets the mass flow according to the specified units. |
| 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. |
| SetMolarFlow(Double) | Sets stream molar flow. |
| SetMolarFlow(String) | Sets the molar flow according to the specified units. |
| SetOverallComposition | Sets the overall molar composition of the mixture. |
| SetOverallCompoundMassFlow(Int32, Double) | Set the mass flow for a single compound and updates the overall mass flow and composition. |
| SetOverallCompoundMassFlow(String, Double) | Set the mass flow for a single compound and updates the overall mass flow and composition. |
| SetOverallCompoundMolarFlow(Int32, Double) | Set the molar flow for a single compound and updates the overall molar flow and composition. |
| SetOverallCompoundMolarFlow(String, Double) | Set the molar flow for a single compound and updates the overall molar flow and composition. |
| SetOverallMassComposition | Sets the overall composition from a mass-fraction array, converting internally to mole fractions. |
| SetOverallMolarComposition | Sets the overall molar composition using a mole-fraction array. |
| SetOverallProp | Sets non-constant property values for the overall mixture. |
| SetPhaseComposition | Sets the molar composition of a phase. |
| SetPhaseComposition1 | Sets the molar composition of a phase by index. Delegates to SetPhaseComposition(Double, Phase). |
| SetPresentPhases | Allows the PME or the Property Package to specify the list of Phases that are currently present. |
| SetPressure(Double) | Sets stream pressure |
| SetPressure(String) | Sets the pressure according to the specified units. |
| SetProp | This method is responsible for setting the values for properties of the Material Object. |
| SetProp1 | CAPE-OPEN 1.0 ICapeThermoMaterialTemplate: Sets a property on the template. Not implemented in DWSIM. |
| SetPropertyPackage | |
| SetPropertyPackageInstance |
Assigns a property package instance directly to this stream, bypassing the flowsheet lookup.
(Overrides BaseClassSetPropertyPackageInstance(IPropertyPackage)) |
| SetPropertyValue |
Sets a stream property by identifier, converting the value from the specified unit system.
(Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure)) |
| SetPropertyValue2 | (Inherited from BaseClass) |
| SetSinglePhaseProp | Sets single-phase non-constant property values for a mixture. |
| SetTemperature(Double) | Sets stream temperature. |
| SetTemperature(String) | Sets the temperature according to the specified units. |
| SetTwoPhaseProp | Sets two-phase non-constant property values for a mixture. |
| SetVolumetricFlow(Double) | Sets stream volumetric flow. |
| SetVolumetricFlow(String) | Sets the volumetric flow according to the specified units. |
| ShallowClone | Creates a new MaterialStream with the same compounds, properties and settings as this one. |
| Solve | (Inherited from BaseClass) |
| StoreDebugReport | (Inherited from BaseClass) |
| Subtract | Subtracts a material stream contents from this one, returning a new stream object, leaving this instance unmodified. |
| SubtractFromPhase | Subtracts a given mass flow from the specified phase and updates all phase and overall flows accordingly. |
| ThrowCAPEException | |
| ToString |
Returns a string representation of this stream including T, P, flows, vapor fraction and compound mole fractions.
(Overrides BaseClassToString) |
| TransferAdditionalSolidData | (Inherited from BaseClass) |
| TranslateString | Converts a CAPE-OPEN property identifier string to a human-readable label. |
| UnsetMaterial | Removes any previously set Material interface. |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm |
Refreshes the stream editor form if it is currently open.
(Overrides BaseClassUpdateEditForm) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| UpdateStreamType | Inspects the graphic object connector state and updates StreamType accordingly. |
| Validate |
Validates the stream specification values and throws an ArgumentException if any are invalid.
(Overrides BaseClassValidate) |
| Validate1 | Validates the stream specification. Delegates to Validate. |
| ValidityCheck | Checks the validity of the calculation. This method is deprecated. |
| ValidityCheck1 | CAPE-OPEN 1.0: Checks the validity of a calculation. Delegates to ValidityCheck(Object). |
| ValidityCheck2 | CAPE-OPEN 1.0 ICapeThermoEquilibriumServer: Validity check. Not implemented in DWSIM. |
| ValidityCheck3 | CAPE-OPEN 1.0 ICapeThermoPropertyPackage: Checks calculation validity. Delegates to the associated property package. |
Extension Methods
| GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |