Class RatioControllerStructure

java.lang.Object

neqsim.process.controllerdevice.structure.RatioControllerStructure

All Implemented Interfaces:

Serializable, ControlStructureInterface

public class RatioControllerStructure
extends Object
implements ControlStructureInterface

Ratio control structure adjusting a controller set-point such that the controlled variable maintains a specified ratio to a reference measurement.

Author:

esol

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final ControllerDeviceInterface	controller
private boolean	isActive
private double	output
private double	ratio
private final MeasurementDeviceInterface	ratioMeasurement
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
RatioControllerStructure(ControllerDeviceInterface controller, MeasurementDeviceInterface ratioMeasurement)	Create a ratio controller structure.

Method Summary

Modifier and Type	Method	Description
double	getOutput()	Get resulting output signal from the control structure.
boolean	isActive()	Check whether the control structure is currently active.
void	runTransient(double dt)	Execute one transient calculation step.
void	setActive(boolean isActive)	Enable or disable the entire control structure.
void	setRatio(double ratio)	Set desired ratio between controlled variable and reference measurement.

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

controller

private final ControllerDeviceInterface controller

ratioMeasurement

private final MeasurementDeviceInterface ratioMeasurement

ratio

private double ratio

output

private double output

isActive

private boolean isActive

Constructor Details

RatioControllerStructure

public RatioControllerStructure(ControllerDeviceInterface controller,
 MeasurementDeviceInterface ratioMeasurement)

Create a ratio controller structure.

Parameters:

controller - feedback controller acting on the manipulated variable

ratioMeasurement - measurement providing the base for the ratio

Method Details

setRatio

public void setRatio(double ratio)

Set desired ratio between controlled variable and reference measurement.

Parameters:

ratio - desired ratio

runTransient

public void runTransient(double dt)

Execute one transient calculation step.

Specified by:

runTransient in interface ControlStructureInterface

Parameters:

dt - time step in seconds

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