PEMFuelCellUnitOpBase Class

Abstract base class for PEM Fuel Cell unit operations that use the OPEM Python library to model different fuel-cell polarisation curves (Amphlett, Chamberline–Kim, Larminie–Dicks).

Definition

Namespace: DWSIM.UnitOperations.UnitOperations
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0

C#Request Example

public abstract class PEMFuelCellUnitOpBase : UnitOpBaseClass, 
	IExternalUnitOperation

VBRequest Example

Public MustInherit Class PEMFuelCellUnitOpBase
	Inherits UnitOpBaseClass
	Implements IExternalUnitOperation

Inheritance: Object BaseClass UnitOpBaseClass PEMFuelCellUnitOpBase

Derived: DWSIM.UnitOperations.UnitOperationsPEMFC_Amphlett

Implements: IExternalUnitOperation

Constructors

PEMFuelCellUnitOpBase	Initializes a new default instance.
PEMFuelCellUnitOpBase(String, String)	Initializes a new instance with a name and description.

Properties

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)
AttachedAdjustId	If an Adjust object is attached to this object, returns its ID. (Inherited from BaseClass)
AttachedInfoCarrierId	(Inherited from BaseClass)
AttachedSpecId	If an Specification object is attached to this object, returns its ID. (Inherited from BaseClass)
AttachedUtilities	(Inherited from BaseClass)
Bottom	(Inherited from BaseClass)
Calculated	(Inherited from BaseClass)
CanUsePreviousResults	(Inherited from BaseClass)
ComponentDescription	Gets or sets the display description for this unit operation. (Overrides UnitOpBaseClassComponentDescription)
ComponentName	Gets or sets the display name for this unit operation. (Overrides UnitOpBaseClassComponentName)
CreateChartAction	(Inherited from BaseClass)
CSVreport	Gets or sets the generated CSV report from the OPEM model.
DebugMode	(Inherited from BaseClass)
DebugText	(Inherited from BaseClass)
Description	Gets the description of this external unit operation.
DetailedDebugReport	(Inherited from BaseClass)
Dimensions	Gets or sets the list of physical dimensions (e.g. vessel diameter, length) associated with this unit operation. (Inherited from UnitOpBaseClass)
DynamicsOnly	(Inherited from BaseClass)
DynamicsSpec	(Inherited from BaseClass)
EnergyFlow	Energy Flow property. Only implemented for Energy Streams. (Inherited from BaseClass)
EquipmentTypes	Gets the list of available equipment type names supported by this unit operation. (Inherited from UnitOpBaseClass)
ErrorMessage	Gets or sets the error message regarding the last calculation attempt. (Inherited from BaseClass)
ExternalSolverConfigData	Gets or sets serialized configuration data for the external solver associated with this unit operation. (Inherited from UnitOpBaseClass)
ExternalSolverID	Gets or sets the unique identifier of an external solver to be used for this unit operation. (Inherited from UnitOpBaseClass)
ExtraProperties	(Inherited from BaseClass)
ExtraPropertiesDescriptions	(Inherited from BaseClass)
ExtraPropertiesTypes	(Inherited from BaseClass)
ExtraPropertiesUnitTypes	(Inherited from BaseClass)
FlowSheet	Gets the current flowsheet where this object is located. (Inherited from BaseClass)
GHGEmissionData	(Inherited from BaseClass)
GraphicObject	Gets or sets the graphic object representation of this object in the flowsheet. (Inherited from BaseClass)
HasPropertiesForDynamicMode	(Inherited from BaseClass)
Height	(Inherited from BaseClass)
HTMLreport	Gets or sets the generated HTML report from the OPEM model.
InfoCarrierVarType	(Inherited from BaseClass)
InputParameters	Gets or sets the dictionary of input parameters sent to the OPEM model.
IsAdjustAttached	Checks if an Adjust operation is attached to this object. (Inherited from BaseClass)
IsDirty	(Inherited from BaseClass)
IsFunctional	(Inherited from BaseClass)
IsInfoCarrierAttached	(Inherited from BaseClass)
IsSink	(Inherited from BaseClass)
IsSource	Gets a value indicating this unit operation acts as an energy source. (Overrides BaseClassIsSource)
IsSpecAttached	Checks if an Specification operation is attached to this object. (Inherited from BaseClass)
LastSolutionInputSnapshot	(Inherited from BaseClass)
LastUpdated	(Inherited from BaseClass)
Left	(Inherited from BaseClass)
MobileCompatible	Gets a value indicating this unit operation is not compatible with mobile interfaces. (Overrides BaseClassMobileCompatible)
Name	Object's Unique ID (Name) (Inherited from BaseClass)
ObjectClass	Gets or sets the simulation object class category (CleanPowerSources). (Overrides BaseClassObjectClass)
OPEMPath	Gets or sets the relative path to the embedded OPEM Python runtime.
OPEMreport	Gets or sets the generated plain-text OPEM report.
OutputParameters	Gets or sets the dictionary of output parameters received from the OPEM model.
OverrideCalculationRoutine	(Inherited from BaseClass)
ParticleSizeDistributions	Gets or sets the dictionary of particle size distribution data, keyed by compound or stream name. (Inherited from UnitOpBaseClass)
Phases	Phase collection, only implemented for Material Streams. (Inherited from BaseClass)
PreferredFlashAlgorithmTag	(Inherited from BaseClass)
Prefix	When overridden, gets or sets the default name prefix for this unit operation.
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 property package associated with this object. (Inherited from UnitOpBaseClass)
Right	(Inherited from BaseClass)
SelectedEquipmentType	Gets or sets the name of the equipment type currently selected for this unit operation. (Inherited from UnitOpBaseClass)
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	(Inherited from BaseClass)
SupportsParticleSizeDistributions	Gets a value indicating whether this unit operation supports particle size distribution calculations. (Inherited from UnitOpBaseClass)
SupportsRestoreStateAfterError	Gets a value indicating whether this unit operation supports restoring its state after a solver error. (Inherited from UnitOpBaseClass)
Top	(Inherited from BaseClass)
UserDefinedChartNames	(Inherited from BaseClass)
Visible	(Inherited from BaseClass)
Width	(Inherited from BaseClass)

Methods

AddDefaultInputParameters	When overridden, populates the input parameter dictionary with default values for the specific model.
AddDynamicProperty	(Inherited from BaseClass)
AddExtraProperty	(Inherited from BaseClass)
AppendDebugLine	(Inherited from BaseClass)
Calculate	Calculates the object. (Inherited from BaseClass)
CallSolverIfNeeded
CheckDirtyStatus	Checks whether the unit operation's input data has changed since the last successful solve, and updates the dirty flag accordingly. (Inherited from UnitOpBaseClass)
CheckSpec	Checks if a value is valid. (Inherited from BaseClass)
ClearExtraProperties	(Inherited from BaseClass)
ClearPropertyPackageInstance	Removes the externally set property package instance from this unit operation, reverting to the flowsheet-level property package lookup. (Inherited from UnitOpBaseClass)
Clone	Clones the current object, returning a new one with identical properties. (Inherited from BaseClass)
CloneJSON	(Inherited from BaseClass)
CloneXML	(Inherited from BaseClass)
CloseDynamicsEditForm	(Inherited from BaseClass)
CloseEditForm	Closes and disposes the editing form. (Overrides BaseClassCloseEditForm)
ConnectEnergyStream	(Inherited from BaseClass)
ConnectFeedEnergyStream	(Inherited from BaseClass)
ConnectFeedMaterialStream	(Inherited from BaseClass)
ConnectProductEnergyStream	(Inherited from BaseClass)
ConnectProductMaterialStream	(Inherited from BaseClass)
CopyDataToClipboard	Copies the object properties to the Clipboard. (Inherited from BaseClass)
CreateConnectors	Creates the graphic connector definitions (hydrogen inlet, oxygen inlet, inerts outlet, power outlet).
CreateDimensionsList	Initializes the list of equipment dimensions for this unit operation. Override to populate the Dimensions collection with dimension entries. (Inherited from UnitOpBaseClass)
CreateDynamicProperties	(Inherited from BaseClass)
CreateNew	(Inherited from BaseClass)
DeCalculate	Decalculates the object. (Inherited from UnitOpBaseClass)
DeCalculate(Object)	(Inherited from BaseClass)
DisplayDynamicsEditForm	(Inherited from BaseClass)
DisplayEditForm	Opens or activates the editing form for this fuel cell. (Overrides BaseClassDisplayEditForm)
DisplayExtraPropertiesEditForm	(Inherited from BaseClass)
Dispose	(Inherited from BaseClass)
Dispose(Boolean)	(Inherited from BaseClass)
Draw	Draws the fuel-cell icon on the given SkiaSharp canvas.
FT	Formats a property string, adding its units in parenthesis. (Inherited from BaseClass)
GetAsObject	(Inherited from BaseClass)
GetBytesFromResource	(Inherited from BaseClass)
GetCalculationModes	Returns the list of available calculation mode names for this unit operation. (Inherited from UnitOpBaseClass)
GetChartModel	(Inherited from BaseClass)
GetChartModelNames	(Inherited from BaseClass)
GetConnectionPortsInfo	(Inherited from BaseClass)
GetConnectionPortsList	(Inherited from BaseClass)
GetDebugReport	Runs the unit operation in debug mode and returns a formatted text report containing intermediate calculation steps and any error information. (Inherited from UnitOpBaseClass)
GetDebugWriter	(Inherited from BaseClass)
GetDefaultProperties	(Inherited from BaseClass)
GetDisplayDescription	(Inherited from BaseClass)
GetDisplayName	(Inherited from BaseClass)
GetDynamicContents	Returns the current mass held in the accumulation stream of this unit operation. (Inherited from UnitOpBaseClass)
GetDynamicProperty	(Inherited from BaseClass)
GetDynamicPropertyUnitType	(Inherited from BaseClass)
GetDynamicResidenceTime	Returns the dynamic residence time of this unit operation, computed as volume divided by the total volumetric inlet flow rate. (Inherited from UnitOpBaseClass)
GetDynamicVolume	Returns the dynamic volume of this unit operation from its dynamic property store. (Inherited from UnitOpBaseClass)
GetEditingForm	(Inherited from BaseClass)
GetEnergyBalanceResidual	(Inherited from BaseClass)
GetEnergyConsumption	Returns the total energy consumed by this unit operation by summing the energy flows from all connected energy streams and the energy connector. (Inherited from UnitOpBaseClass)
GetExtraPropertyValue	(Inherited from BaseClass)
GetFlowsheet	(Inherited from BaseClass)
GetIconBitmap	(Inherited from BaseClass)
GetIconBitmapBytes	(Inherited from BaseClass)
GetKeyPropertyNames	Returns the names of the key output properties reported by this unit operation. (Inherited from UnitOpBaseClass)
GetKeyPropertyUnits	Returns the display unit string for a named key property. (Inherited from UnitOpBaseClass)
GetKeyPropertyValue	Returns the current numeric value of a named key property in SI units. (Inherited from UnitOpBaseClass)
GetMassBalanceResidual	(Inherited from BaseClass)
GetPowerGeneratedOrConsumed	(Inherited from BaseClass)
GetPreferredGraphicObjectHeight	(Inherited from BaseClass)
GetPreferredGraphicObjectWidth	(Inherited from BaseClass)
GetProperties	Returns an array of property identifiers for the specified property type. (Overrides BaseClassGetProperties(PropertyType))
GetProperties2	(Inherited from BaseClass)
GetPropertyDescription	(Inherited from BaseClass)
GetPropertyUnit	Returns the unit string for the specified property. (Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure))
GetPropertyUnits2	(Inherited from BaseClass)
GetPropertyValue	Returns the value of the specified property, converted to SI. (Overrides UnitOpBaseClassGetPropertyValue(String, IUnitsOfMeasure))
GetPropertyValue2	(Inherited from BaseClass)
GetReport	(Inherited from BaseClass)
GetStructuredReport	(Inherited from BaseClass)
GetVersion	(Inherited from BaseClass)
IsDynamicProperty	(Inherited from BaseClass)
LoadData	Restores the fuel-cell state, including input and output parameter dictionaries, from XML. (Overrides UnitOpBaseClassLoadData(ListXElement))
ObjectCopy	(Inherited from BaseClass)
PerformPostCalcValidation	Performs post-calculation validation (no-op for PEM fuel cells). (Overrides BaseClassPerformPostCalcValidation)
PopulateEditorPanel	When overridden, populates the cross-platform editor panel with controls.
RemoveDynamicProperty	(Inherited from BaseClass)
RemoveExtraProperty	(Inherited from BaseClass)
ReturnInstance	When overridden, creates and returns a new instance of this fuel-cell type for deserialization.
RunDynamicModel	(Inherited from BaseClass)
SaveData	Serializes the fuel-cell state, including input and output parameter dictionaries, to XML. (Overrides UnitOpBaseClassSaveData)
SetCalculationMode	Sets the active calculation mode for this unit operation by numeric identifier. (Inherited from UnitOpBaseClass)
SetCanUsePreviousResults	(Inherited from BaseClass)
SetDirtyStatus	(Inherited from BaseClass)
SetDynamicProperty	(Inherited from BaseClass)
SetExtraPropertyValue	(Inherited from BaseClass)
SetFlowsheet	Sets the Flowsheet to which this object belongs to. (Inherited from BaseClass)
SetKeyPropertyValue	Sets the value of a named key property, converting from the supplied units to SI internally. (Inherited from UnitOpBaseClass)
SetPropertyPackageInstance	Assigns an externally supplied property package instance to this unit operation, bypassing the flowsheet-level property package lookup. (Inherited from UnitOpBaseClass)
SetPropertyValue	Sets the value of the specified input parameter. (Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure))
SetPropertyValue2	(Inherited from BaseClass)
Solve	Solves the unit operation, optionally saving and restoring state on error when the flowsheet option RestoreUnitOperationStateAfterError is enabled. (Inherited from UnitOpBaseClass)
StoreDebugReport	(Inherited from BaseClass)
ToList	Converts a Python list object to a .NET List(Of Double).
ToString	(Inherited from BaseClass)
TransferAdditionalSolidData	(Inherited from BaseClass)
Unsolve	Decalculates the object. (Inherited from UnitOpBaseClass)
UpdateDimensionsList	Updates the equipment dimensions list after a successful calculation. Override to refresh computed dimension values. (Inherited from UnitOpBaseClass)
UpdateDynamicsEditForm	(Inherited from BaseClass)
UpdateEditForm	Refreshes the editing form with updated data. (Overrides BaseClassUpdateEditForm)
UpdateExtraPropertiesEditForm	(Inherited from BaseClass)
Validate	Validates the object, checking its connections and other parameters. (Inherited from BaseClass)

Fields

_CanUsePreviousResults	(Inherited from BaseClass)
_capeopenmode	(Inherited from UnitOpBaseClass)
_IsDirty	(Inherited from BaseClass)
_pp	(Inherited from UnitOpBaseClass)
_ppid	(Inherited from UnitOpBaseClass)
AccumulationStream	(Inherited from UnitOpBaseClass)
CalculationRoutineOverride	(Inherited from BaseClass)
disposedValue	(Inherited from BaseClass)
ExtraPropertiesEditor	(Inherited from BaseClass)
f
fd	(Inherited from BaseClass)
Image
ImagePath
LaunchExternalPropertyEditor	(Inherited from BaseClass)
m_flowsheet	(Inherited from BaseClass)

Extension Methods

GetEnergyStream	(Defined by StreamListExtender)
GetEnumNames	(Defined by General)
GetInletEnergyStream	(Defined by StreamListExtender)
GetInletMaterialStream	(Defined by StreamListExtender)
GetOutletEnergyStream	(Defined by StreamListExtender)
GetOutletMaterialStream	(Defined by StreamListExtender)
IsValidDouble	(Defined by General)

Explicit Interface Implementations

IExternalUnitOperationName