Material |
Inheritance HierarchyNamespace: DWSIM.Thermodynamics.Streams
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 8.8.1.0
Syntax[SerializableAttribute] public class MaterialStream : BaseClass, ICapeIdentification, ICapeThermoMaterialObject, ICapeThermoCalculationRoutine, ICapeThermoEquilibriumServer, ICapeThermoPropertyPackage, ICapeThermoMaterialTemplate, ICapeThermoMaterial, ICapeThermoCompounds, ICapeThermoPhases, ICapeThermoUniversalConstant, ICapeThermoPropertyRoutine, ICapeThermoEquilibriumRoutine, ICapeThermoMaterialContext, ECapeUser, ECapeUnknown, ECapeRoot, IMaterialStream
The MaterialStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MaterialStream | |
| MaterialStream(String, String) | |
| MaterialStream(String, String, IFlowsheet, PropertyPackage) |
Properties| Name | Description | |
|---|---|---|
 | AdditionalSolidPhaseProperties | |
| AdjustVarType |
If an Adjust object is attached to this object, returns a variable describing how this object is used by it (manipulated, controlled or reference).
(Inherited from BaseClass) |
| Annotation | (Inherited from BaseClass) |
| AtEquilibrium | Gets or sets if this stream is at thermodynamic equilbirium or not. |
| AttachedAdjustId |
If an Adjust object is attached to this object, returns its ID.
(Inherited from BaseClass) |
| AttachedSpecId |
If an Specification object is attached to this object, returns its ID.
(Inherited from BaseClass) |
| AttachedUtilities | (Inherited from BaseClass) |
| Calculated | (Inherited from BaseClass) |
| CanUsePreviousResults | (Inherited from BaseClass) |
| code | |
| ComponentDescription | (Overrides BaseClassComponentDescription) |
| ComponentIds | Returns the list of compound IDs of a given Material Object. |
| ComponentName | (Overrides BaseClassComponentName) |
| CompositionBasis | |
| CreateChartAction | (Inherited from BaseClass) |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DefinedFlow | |
| description | |
| DetailedDebugReport | (Inherited from BaseClass) |
| DynamicsOnly | (Inherited from BaseClass) |
| DynamicsSpec | (Inherited from BaseClass) |
| EditorState | |
| EnergyFlow |
Energy Flow property. Only implemented for Energy Streams.
(Inherited from BaseClass) |
| ErrorMessage |
Gets or sets the error message regarding the last calculation attempt.
(Inherited from BaseClass) |
| ExtraProperties | (Inherited from BaseClass) |
| ExtraPropertiesDescriptions | (Inherited from BaseClass) |
| ExtraPropertiesTypes | (Inherited from BaseClass) |
| ExtraPropertiesUnitTypes | (Inherited from BaseClass) |
| FloatingTableAmountBasis | |
| FlowSheet |
Gets the current flowsheet where this object is located.
(Inherited from BaseClass) |
| Flowsheet1 | |
| ForcePhase | |
| GHGEmissionData | (Inherited from BaseClass) |
| GraphicObject |
Gets or sets the graphic object representation of this object in the flowsheet.
(Inherited from BaseClass) |
| HasPropertiesForDynamicMode | (Overrides BaseClassHasPropertiesForDynamicMode) |
| InputComposition | |
| interfaceName | |
| IsAdjustAttached |
Checks if an Adjust operation is attached to this object.
(Inherited from BaseClass) |
| IsDirty | (Inherited from BaseClass) |
| IsElectrolyteStream | |
| IsFunctional | (Inherited from BaseClass) |
| IsSink | (Inherited from BaseClass) |
| IsSource | (Inherited from BaseClass) |
| IsSpecAttached |
Checks if an Specification operation is attached to this object.
(Inherited from BaseClass) |
| LastSolutionInputData | |
| LastSolutionInputSnapshot | (Inherited from BaseClass) |
| LastUpdated | (Inherited from BaseClass) |
| MaximumAllowableDynamicMassFlowRate | |
| MobileCompatible | (Overrides BaseClassMobileCompatible) |
| moreInfo | |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| Name2 | |
| ObjectClass | (Overrides BaseClassObjectClass) |
| operation | |
| OverrideCalculationRoutine | (Inherited from BaseClass) |
| OverrideSingleCompoundFlashBehavior | Use this property to disable automatic PH-Flash for single-compound streams connected to unit operations. Default is 'False'. |
| PhaseIds | It returns the phases existing in the Material Object at that moment. |
| Phases |
Gets the collection of phases in this stream.
(Overrides BaseClassPhases) |
| PhasesArray | |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| ProductAssembly | (Inherited from BaseClass) |
| ProductAuthor | (Inherited from BaseClass) |
| ProductContactInfo | (Inherited from BaseClass) |
| ProductDescription | (Inherited from BaseClass) |
| ProductName | (Inherited from BaseClass) |
| ProductPage | (Inherited from BaseClass) |
| ProductVersion | (Inherited from BaseClass) |
| PropertyPackage | Gets or sets the associated Property Package for this stream. |
| ReferenceSolvent | |
| scope | |
| SolidParticleData | |
| SpecType | |
| SpecVarType |
If an Specification object is attached to this object, returns a variable describing how this object is used by it (target or source).
(Inherited from BaseClass) |
| StoreDetailedDebugReport | (Inherited from BaseClass) |
| SupportsDynamicMode | (Overrides BaseClassSupportsDynamicMode) |
| TotalEnergyFlow | |
| UserDefinedChartNames | (Inherited from BaseClass) |
| Visible | (Inherited from BaseClass) |
Methods| Name | Description | |
|---|---|---|
 | _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. |
| AssignSolidData | |
| 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 | |
| CalcEquilibrium3 | |
| CalcOverallCompMassFractions | |
| CalcOverallCompMoleFractions | |
| CalcOverallMolecularWeight | |
| CalcPhaseMassComposition | |
| CalcProp | This method is responsible for doing all property calculations or delegating these calculations to the associated Property Package. |
| CalcProp1 | |
| CalcProp2 | |
| 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) | (Overrides BaseClassCalculate(Object)) |
| Calculate(Boolean, Boolean) | Calculates equilibrium and/or properties for this stream. |
| CheckDirtyStatus | (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 | (Overrides BaseClassClearPropertyPackageInstance) |
| Clone | (Overrides BaseClassClone) |
| Clone1 | |
| CloneJSON | (Overrides BaseClassCloneJSON) |
| CloneXML | (Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm | (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 | |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | (Inherited from BaseClass) |
| DeepClear | |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm | (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 | |
| FT |
Formats a property string, adding its units in parenthesis.
(Inherited from BaseClass) |
| GetAsObject | (Inherited from BaseClass) |
| GetChartModel | (Inherited from BaseClass) |
| GetChartModelNames | (Inherited from BaseClass) |
| GetComponentConstant | Retrieve pure compound constants from the Property Package. |
| GetComponentConstant1 | |
| GetComponentList | |
| 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 | |
| GetCompoundMassFlow | |
| GetCompoundMolarFlow | |
| GetCompoundNames | |
| GetConnectionPortsInfo | (Inherited from BaseClass) |
| GetConnectionPortsList | (Inherited from BaseClass) |
| GetConstPropList | Returns the list of supported constant Physical Properties. |
| GetDebugReport | (Overrides BaseClassGetDebugReport) |
| GetDebugWriter | (Inherited from BaseClass) |
| GetDefaultProperties | (Overrides BaseClassGetDefaultProperties) |
| GetDisplayDescription | (Overrides BaseClassGetDisplayDescription) |
| GetDisplayName | (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 | |
| GetExtraPropertyValue | (Inherited from BaseClass) |
| GetFlashSpec | |
| GetFlowsheet | (Inherited from BaseClass) |
| GetIconBitmap | (Overrides BaseClassGetIconBitmap) |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| GetProp(String, String) | |
| GetProp(String, String, Object, String, String) | This method is responsible for retrieving the results from calculations from the Material Object. |
| GetProperties | (Overrides BaseClassGetProperties(PropertyType)) |
| GetPropertyDescription | (Overrides BaseClassGetPropertyDescription(String)) |
| GetPropertyPackageObject | |
| GetPropertyPackageObjectCopy | |
| GetPropertyUnit | (Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyValue | (Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropList | Returns list of properties that can be calculated by the Material Object. |
| GetPropList1 | |
| GetPropList2 | |
 | GetPropUnits | |
| GetReport | (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetSinglePhaseProp | Retrieves single-phase non-constant Physical Property values for a mixture. |
| GetSinglePhaseProp2 | |
| GetSinglePhasePropDefaultUnits | |
| GetSinglePhasePropList | Returns the list of supported non-constant single-phase Physical Properties. |
| GetStructuredReport | (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 | |
| GetUniversalConstantList | Returns the identifiers of the supported Universal Constants. |
| GetVersion | (Inherited from BaseClass) |
| GetVolumetricFlow | Returns the stream volumetric flow. |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData | (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 | |
| NormalizeOverallMoleComposition | |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| PropCheck | Checks to see if a list of given properties can be calculated. |
| PropCheck1 | |
| PropCheck2 | |
| PropCheck3 | |
| PropList | |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RemoveResults | RemoveResults |
| RunDynamicModel | (Overrides BaseClassRunDynamicModel) |
| SaveData | (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) | |
| 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 | |
| SetOverallMolarComposition | |
| SetOverallProp | Sets non-constant property values for the overall mixture. |
| SetPhaseComposition | Sets the molar composition of a phase. |
| SetPhaseComposition1 | |
| 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 | |
| SetPropertyPackage | |
| SetPropertyPackageInstance | (Overrides BaseClassSetPropertyPackageInstance(IPropertyPackage)) |
| SetPropertyValue | (Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure)) |
| 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 | |
| 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. |
| ThrowCAPEException | |
| ToString | (Overrides BaseClassToString) |
| TransferAdditionalSolidData | (Inherited from BaseClass) |
| TranslateString | |
| UnsetMaterial | Removes any previously set Material interface. |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | (Overrides BaseClassUpdateEditForm) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| Validate | (Overrides BaseClassValidate) |
| Validate1 | |
| ValidityCheck | Checks the validity of the calculation. This method is deprecated. |
| ValidityCheck1 | |
| ValidityCheck2 | |
| ValidityCheck3 |
Fields| Name | Description | |
|---|---|---|
 | _CanUsePreviousResults | (Inherited from BaseClass) |
 | _code | |
| _description | |
| _flowsheet | |
| _interfacename | |
| _IsDirty | (Inherited from BaseClass) |
| _moreinfo | |
| _operation | |
 | _pp | |
| _ppid | |
| _ppwasset | |
| _scope | |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_flowsheet | (Inherited from BaseClass) |
| m_Phases | |
| PostCreationAction1 | |
| PostCreationAction2 | |
| PostCreationAction3 |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
 | IMaterialStreamGetPhase |
See Also