Adjust Class
Represents an Adjust (controller) block that iterates a manipulated variable of one simulation
object until the controlled variable of another object reaches a specified target value.
Uses a bisection or secant numerical method with an optional reference object for relative targets.
Definition
Namespace: DWSIM.UnitOperations.SpecialOps
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0
C#
[SerializableAttribute]
public class Adjust : SpecialOpBaseClass, IAdjustVB
<SerializableAttribute>
Public Class Adjust
Inherits SpecialOpBaseClass
Implements IAdjust- Inheritance
- Object BaseClass SpecialOpBaseClass Adjust
- Implements
- IAdjust
Constructors
| Adjust | Initializes a new default instance of the Adjust class. |
| Adjust(String, String) | Initializes a new instance of the Adjust class with a name and description. |
Properties
| AdjustValue | Gets or sets the target (setpoint) value for the controlled variable. |
| 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 | (Inherited from BaseClass) |
| ComponentName | (Inherited from BaseClass) |
| ControlledObject | Gets or sets the controlled simulation object instance (not serialized). |
| ControlledObjectData | Gets or sets the metadata describing the controlled simulation object and its property. |
| ControlledVariable | Gets or sets the property identifier of the variable to be controlled (driven to the target value). |
| CreateChartAction | (Inherited from BaseClass) |
| CvOk | Gets or sets whether the controlled variable object and property are correctly configured. |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DetailedDebugReport | (Inherited from BaseClass) |
| DynamicsOnly | (Inherited from BaseClass) |
| DynamicsSpec | (Inherited from BaseClass) |
| 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) |
| 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) |
| InfoCarrierVarType | (Inherited from BaseClass) |
| InitialEstimate | Gets or sets the optional initial estimate for the manipulated variable used to seed the solver. |
| 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 | (Inherited from BaseClass) |
| 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) |
| ManipulatedObject | Gets or sets the manipulated simulation object instance (not serialized). |
| ManipulatedObjectData | Gets or sets the metadata describing the manipulated simulation object and its property. |
| ManipulatedVariable | Gets or sets the property identifier of the variable to be manipulated by the solver. |
| MaximumIterations | Gets or sets the maximum number of solver iterations allowed before declaring non-convergence. |
| MaxVal | Gets or sets the optional upper bound for the manipulated variable search range. |
| MinVal | Gets or sets the optional lower bound for the manipulated variable search range. |
| MobileCompatible | Gets a value indicating whether this block is compatible with the DWSIM mobile interface. (Overrides BaseClassMobileCompatible) |
| MvOk | Gets or sets whether the manipulated variable object and property are correctly configured. |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| ObjectClass |
Gets or sets the simulation object class, which is always Logical
for special operations.
(Inherited from SpecialOpBaseClass) |
| OverrideCalculationRoutine | (Inherited from BaseClass) |
| Phases |
Phase collection, only implemented for Material Streams.
(Inherited from BaseClass) |
| 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 | (Inherited from BaseClass) |
| Referenced | Gets or sets whether the target is expressed relative to the reference object's variable value. |
| ReferencedObjectData | Gets or sets the metadata describing the optional reference simulation object and its property. |
| ReferenceObject | Gets or sets the optional reference simulation object instance (not serialized). |
| ReferenceVariable | Gets or sets the property identifier of the optional reference variable used as a relative target basis. |
| Right | (Inherited from BaseClass) |
| RvOk | Gets or sets whether the reference variable object and property are correctly configured. |
| SimultaneousAdjust | Gets or sets whether this block participates in simultaneous adjustment with other Adjust blocks. |
| SolvingMethodSelf | Gets or sets the solving method index used by this block (0 = bisection, 1 = secant, etc.). |
| 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) |
| Status | Gets or sets a status message describing the outcome of the last calculation attempt. |
| StepSize | Gets or sets the step size used by the initial perturbation of the manipulated variable. |
| StoreDetailedDebugReport | (Inherited from BaseClass) |
| SupportsDynamicMode | (Inherited from BaseClass) |
| Tolerance | Gets or sets the convergence tolerance for the controlled variable error. |
| Top | (Inherited from BaseClass) |
| UserDefinedChartNames | (Inherited from BaseClass) |
| Visible | (Inherited from BaseClass) |
| Width | (Inherited from BaseClass) |
Methods
| AddDynamicProperty | (Inherited from BaseClass) |
| AddExtraProperty | (Inherited from BaseClass) |
| AppendDebugLine | (Inherited from BaseClass) |
| Calculate |
Calculates the object.
(Inherited from BaseClass) |
| CheckDirtyStatus | (Inherited from BaseClass) |
| CheckSpec |
Checks if a value is valid.
(Inherited from BaseClass) |
| ClearExtraProperties | (Inherited from BaseClass) |
| ClearPropertyPackageInstance | (Inherited from BaseClass) |
| Clone |
Clones the current object, returning a new one with identical properties.
(Inherited from BaseClass) |
| CloneJSON | Creates a deep copy of this adjust block via JSON serialization. (Overrides BaseClassCloneJSON) |
| CloneXML | Creates a deep copy of this adjust block via XML serialization. (Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm | Closes and disposes the editing form for this adjust block if it is open. (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) |
| CreateDynamicProperties | (Inherited from BaseClass) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | (Inherited from BaseClass) |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm | Opens or activates the editing form for this adjust block. (Overrides BaseClassDisplayEditForm) |
| DisplayExtraPropertiesEditForm | (Inherited from BaseClass) |
| Dispose | (Inherited from BaseClass) |
| Dispose(Boolean) | (Inherited from BaseClass) |
| 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) |
| GetConnectionPortsInfo | (Inherited from BaseClass) |
| GetConnectionPortsList | (Inherited from BaseClass) |
| GetDebugReport | (Inherited from BaseClass) |
| GetDebugWriter | (Inherited from BaseClass) |
| GetDefaultProperties | (Inherited from BaseClass) |
| GetDisplayDescription | Returns the localized display description for the adjust block type. (Overrides BaseClassGetDisplayDescription) |
| GetDisplayName | Returns the localized display name for the adjust block 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) |
| GetExtraPropertyValue | (Inherited from BaseClass) |
| GetFlowsheet | (Inherited from BaseClass) |
| GetIconBitmap | Returns the icon bitmap resource for the adjust block. (Overrides BaseClassGetIconBitmap) |
| GetIconBitmapBytes | Returns the raw bytes of the adjust block icon image resource. (Overrides BaseClassGetIconBitmapBytes) |
| GetMassBalanceResidual | (Inherited from BaseClass) |
| GetPowerGeneratedOrConsumed | (Inherited from BaseClass) |
| GetPreferredGraphicObjectHeight | (Inherited from BaseClass) |
| GetPreferredGraphicObjectWidth | (Inherited from BaseClass) |
| GetProperties |
Returns the list of property identifiers available for this adjust block.
(Overrides BaseClassGetProperties(PropertyType)) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription | (Inherited from BaseClass) |
| GetPropertyUnit |
Returns the unit string for the specified property (always an empty string for this block).
(Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue |
Returns the value of the specified property.
(Overrides BaseClassGetPropertyValue(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 adjust block state from a list of XML elements.
(Overrides BaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel | (Inherited from BaseClass) |
| SaveData |
Serializes the adjust block state to a list of XML elements for persistence.
(Overrides BaseClassSaveData) |
| 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) |
| SetPropertyPackageInstance | (Inherited from BaseClass) |
| SetPropertyValue |
Sets the value of the specified property.
(Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure)) |
| SetPropertyValue2 | (Inherited from BaseClass) |
| Solve | (Inherited from BaseClass) |
| StoreDebugReport | (Inherited from BaseClass) |
| ToString | (Inherited from BaseClass) |
| TransferAdditionalSolidData | (Inherited from BaseClass) |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | Refreshes the displayed data in the editing form if it is currently open. (Overrides BaseClassUpdateEditForm) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| Validate |
Validates the object, checking its connections and other parameters.
(Inherited from BaseClass) |
Fields
| _CanUsePreviousResults | (Inherited from BaseClass) |
| _IsDirty | (Inherited from BaseClass) |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_AdjustValue | |
| m_ControlledObject | |
| m_ControlledObjectData | |
| m_ControlledVariable | |
| m_CV_OK | |
| m_flowsheet | (Inherited from BaseClass) |
| m_initialEstimate | |
| m_IsReferenced | |
| m_IsSimultAdjustEnabled | |
| m_ManipulatedObject | |
| m_ManipulatedObjectData | |
| m_ManipulatedVariable | |
| m_MaxIterations | |
| m_maxVal | |
| m_minVal | |
| m_MV_OK | |
| m_ReferencedObjectData | |
| m_ReferenceObject | |
| m_ReferenceVariable | |
| m_RV_OK | |
| m_Status | |
| m_StepSize | |
| m_Tolerance |
Extension Methods
| GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |