Class SoftSensor

java.lang.Object

neqsim.util.NamedBaseClass

neqsim.process.measurementdevice.MeasurementDeviceBaseClass

neqsim.process.measurementdevice.StreamMeasurementDeviceBaseClass

neqsim.process.measurementdevice.vfm.SoftSensor

All Implemented Interfaces:

Serializable, MeasurementDeviceInterface, NamedInterface

public class SoftSensor
extends StreamMeasurementDeviceBaseClass

Soft sensor for calculating derived properties from primary measurements and thermodynamic models.

Soft sensors provide real-time estimates of properties that cannot be directly measured, using a combination of available measurements and physics-based models. This is essential for AI-augmented production optimization.

Supported properties include:

• Gas-Oil Ratio (GOR)
• Water Cut
• Density
• Viscosity
• Compressibility
• Heating Value

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SoftSensor.PropertyType	Types of properties that can be estimated.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Double>	inputValues
private double	lastEstimate
private double[]	lastSensitivity
private SoftSensor.PropertyType	propertyType
private static final long	serialVersionUID

Fields inherited from class StreamMeasurementDeviceBaseClass

stream

Fields inherited from class MeasurementDeviceBaseClass

unit

Fields inherited from class NamedBaseClass

name

Constructor Summary

Constructors

Constructor	Description
SoftSensor(String name, StreamInterface stream, SoftSensor.PropertyType propertyType)	Creates a new soft sensor.

Method Summary

Modifier and Type	Method	Description
private double	calculateBubblePoint(SystemInterface fluid)
private double	calculateDewPoint(SystemInterface fluid)
private double	calculateGasFVF(SystemInterface fluid)
private double	calculateGOR(SystemInterface fluid)
private double	calculateHeatingValue(SystemInterface fluid)
private double	calculateOilFVF(SystemInterface fluid)
private double	calculateProperty(SystemInterface fluid)	Calculates the property from a flashed fluid.
private double	calculateSolutionGOR(SystemInterface fluid)
private double	calculateWaterCut(SystemInterface fluid)
double	estimate()	Estimates the property value from current inputs.
double	estimate(Map<String,Double> inputs)	Estimates the property value from specified inputs.
double[]	getLastSensitivity()	Gets the last calculated sensitivities.
double	getMeasuredValue(String unit)	Get Measured value in specified unit.
SoftSensor.PropertyType	getPropertyType()	Gets the property type being estimated.
double[]	getSensitivity()	Calculates sensitivity (Jacobian) of the output to input changes.
UncertaintyBounds	getUncertaintyBounds(double pressureUncertainty, double temperatureUncertainty)	Gets uncertainty bounds for the estimate.
private static String	getUnitForProperty(SoftSensor.PropertyType type)	Gets the default unit for a property type.
void	setInput(String name, double value)	Sets a single input value.
void	setInputs(Map<String,Double> inputs)	Sets input values for the estimation.
void	setPropertyType(SoftSensor.PropertyType propertyType)	Sets the property type to estimate.

Methods inherited from class StreamMeasurementDeviceBaseClass

getStream, setStream

Methods inherited from class MeasurementDeviceBaseClass

acknowledgeAlarm, applySignalModifiers, displayResult, doConditionAnalysis, evaluateAlarm, getAlarmConfig, getAlarmState, getConditionAnalysisMaxDeviation, getConditionAnalysisMessage, getDelaySteps, getMaximumValue, getMeasuredPercentValue, getMinimumValue, getNoiseStdDev, getOnlineMeasurementValue, getOnlineSignal, getUnit, isLogging, isOnlineSignal, runConditionAnalysis, setAlarmConfig, setConditionAnalysis, setConditionAnalysisMaxDeviation, setDelaySteps, setIsOnlineSignal, setLogging, setMaximumValue, setMinimumValue, setNoiseStdDev, setOnlineMeasurementValue, setOnlineSignal, setQualityCheckMessage, setRandomSeed, setUnit

Methods inherited from class NamedBaseClass

getName, getTagName, setName, setTagName

Methods inherited from class Object

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

Methods inherited from interface MeasurementDeviceInterface

equals, getMeasuredValue, getOnlineValue, hashCode

Methods inherited from interface NamedInterface

getName, getTagName, setName, setTagName

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

propertyType

private SoftSensor.PropertyType propertyType

inputValues

private Map<String,Double> inputValues

lastEstimate

private double lastEstimate

lastSensitivity

private double[] lastSensitivity

Constructor Details

SoftSensor

public SoftSensor(String name,
 StreamInterface stream,
 SoftSensor.PropertyType propertyType)

Creates a new soft sensor.

Parameters:

name - the sensor name/tag

stream - the stream to analyze

propertyType - the property to estimate

Method Details

getUnitForProperty

private static String getUnitForProperty(SoftSensor.PropertyType type)

Gets the default unit for a property type.

Parameters:

type - property descriptor

Returns:

canonical engineering unit for the property

setInputs

public void setInputs(Map<String,Double> inputs)

Sets input values for the estimation.

Parameters:

inputs - map of input names to values

setInput

public void setInput(String name,
 double value)

Sets a single input value.

Parameters:

name - input name (e.g., "pressure", "temperature")

value - input value

estimate

public double estimate()

Estimates the property value from current inputs.

Returns:

estimated property value

estimate

public double estimate(Map<String,Double> inputs)

Estimates the property value from specified inputs.

Parameters:

inputs - map of input values

Returns:

estimated property value

calculateProperty

private double calculateProperty(SystemInterface fluid)

Calculates the property from a flashed fluid.

Parameters:

fluid - equilibrated fluid instance

Returns:

property value expressed in the default unit

calculateGOR

private double calculateGOR(SystemInterface fluid)

calculateWaterCut

private double calculateWaterCut(SystemInterface fluid)

calculateHeatingValue

private double calculateHeatingValue(SystemInterface fluid)

calculateBubblePoint

private double calculateBubblePoint(SystemInterface fluid)

calculateDewPoint

private double calculateDewPoint(SystemInterface fluid)

calculateOilFVF

private double calculateOilFVF(SystemInterface fluid)

calculateGasFVF

private double calculateGasFVF(SystemInterface fluid)

calculateSolutionGOR

private double calculateSolutionGOR(SystemInterface fluid)

getSensitivity

public double[] getSensitivity()

Calculates sensitivity (Jacobian) of the output to input changes.

Uses finite differences to estimate partial derivatives.

Returns:

array of sensitivities [dOutput/dPressure, dOutput/dTemperature]

getLastSensitivity

public double[] getLastSensitivity()

Gets the last calculated sensitivities.

Returns:

array of [dOutput/dP, dOutput/dT]

getUncertaintyBounds

public UncertaintyBounds getUncertaintyBounds(double pressureUncertainty,
 double temperatureUncertainty)

Gets uncertainty bounds for the estimate.

Parameters:

pressureUncertainty - pressure measurement uncertainty in bar

temperatureUncertainty - temperature measurement uncertainty in K

Returns:

uncertainty bounds for the estimated property

getPropertyType

public SoftSensor.PropertyType getPropertyType()

Gets the property type being estimated.

Returns:

the property type

setPropertyType

public void setPropertyType(SoftSensor.PropertyType propertyType)

Sets the property type to estimate.

Parameters:

propertyType - the property type

getMeasuredValue

public double getMeasuredValue(String unit)

Description copied from class: MeasurementDeviceBaseClass

Get Measured value in specified unit.

Specified by:

getMeasuredValue in interface MeasurementDeviceInterface

Overrides:

getMeasuredValue in class MeasurementDeviceBaseClass

Parameters:

unit - a String object

Returns:

a double