Class OverrideControllerStructure

java.lang.Object

neqsim.process.controllerdevice.structure.OverrideControllerStructure

All Implemented Interfaces:

Serializable, ControlStructureInterface

public class OverrideControllerStructure
extends Object
implements ControlStructureInterface

Override (selector) control structure that selects the output of one of two controllers using a HIGH-select or LOW-select strategy. This is commonly used for safety overrides where a temperature or pressure controller can take over from a flow controller when limits are approached.

In OverrideControllerStructure.SelectionType.HIGH_SELECT mode, the controller with the highest output wins. In OverrideControllerStructure.SelectionType.LOW_SELECT mode, the controller with the lowest output wins.

Version:

1.0

Author:

NeqSim

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OverrideControllerStructure.SelectionType	Selection strategy for the override structure.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isActive
private double	output
private boolean	overrideActive
private final ControllerDeviceInterface	overrideController
private final ControllerDeviceInterface	primaryController
private final OverrideControllerStructure.SelectionType	selectionType
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
OverrideControllerStructure(ControllerDeviceInterface primaryController, ControllerDeviceInterface overrideController, OverrideControllerStructure.SelectionType selectionType)	Create an override control structure.

Method Summary

Modifier and Type	Method	Description
double	getOutput()	Get resulting output signal from the control structure.
OverrideControllerStructure.SelectionType	getSelectionType()	Get the selection type of this override structure.
boolean	isActive()	Check whether the control structure is currently active.
boolean	isOverrideActive()	Check whether the override controller is currently dominating the output.
void	runTransient(double dt)	Execute one transient calculation step.
void	setActive(boolean isActive)	Enable or disable the entire control structure.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

primaryController

private final ControllerDeviceInterface primaryController

overrideController

private final ControllerDeviceInterface overrideController

selectionType

private final OverrideControllerStructure.SelectionType selectionType

output

private double output

overrideActive

private boolean overrideActive

isActive

private boolean isActive

Constructor Details

OverrideControllerStructure

public OverrideControllerStructure(ControllerDeviceInterface primaryController,
 ControllerDeviceInterface overrideController,
 OverrideControllerStructure.SelectionType selectionType)

Create an override control structure.

Parameters:

primaryController - the normal-operation controller

overrideController - the safety/override controller

selectionType - HIGH_SELECT or LOW_SELECT

Method Details

runTransient

public void runTransient(double dt)

Execute one transient calculation step.

Specified by:

runTransient in interface ControlStructureInterface

Parameters:

dt - time step in seconds

isOverrideActive

public boolean isOverrideActive()

Check whether the override controller is currently dominating the output.

Returns:

true if the override controller output was selected, false if the primary controller is in control

getSelectionType

public OverrideControllerStructure.SelectionType getSelectionType()

Get the selection type of this override structure.

Returns:

the selection type

getOutput

public double getOutput()

Get resulting output signal from the control structure.

Specified by:

getOutput in interface ControlStructureInterface

Returns:

control signal

setActive

public void setActive(boolean isActive)

Enable or disable the entire control structure.

Specified by:

setActive in interface ControlStructureInterface

Parameters:

isActive - set true to enable

isActive

public boolean isActive()

Check whether the control structure is currently active.

Specified by:

isActive in interface ControlStructureInterface

Returns:

true if active