Class Mixer

java.lang.Object

neqsim.util.NamedBaseClass

neqsim.process.SimulationBaseClass

neqsim.process.equipment.ProcessEquipmentBaseClass

neqsim.process.equipment.mixer.Mixer

All Implemented Interfaces:

Serializable, Runnable, CapacityConstrainedEquipment, MixerInterface, ProcessEquipmentInterface, ProcessElementInterface, SimulationInterface, NamedInterface

Direct Known Subclasses:

SimpleTray, StaticMixer

public class Mixer
extends ProcessEquipmentBaseClass
implements MixerInterface, CapacityConstrainedEquipment

Mixer class.

Version:

$Id: $Id

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private double	designPressureDrop	Design pressure drop [bar].
private boolean	doMultiPhaseCheck
private boolean	isSetOutTemperature
(package private) static org.apache.logging.log4j.Logger	logger	Logger object for class.
(package private) double	lowestPressure
private double	maxDesignVelocity	Maximum design velocity [m/s].
private MixerMechanicalDesign	mechanicalDesign	Mechanical design for the mixer.
protected StreamInterface	mixedStream
private boolean	mixerCapacityAnalysisEnabled	Whether capacity analysis is enabled.
private Map<String, CapacityConstraint>	mixerCapacityConstraints	Mixer capacity constraints map.
private int	numberOfInputStreams
private double	outTemperature
private static final long	serialVersionUID	Serialization version UID.
protected ArrayList<StreamInterface>	streams

Fields inherited from class ProcessEquipmentBaseClass

conditionAnalysisMessage, energyStream, hasController, isSolved, properties, report

Fields inherited from class SimulationBaseClass

calcIdentifier, calculateSteadyState, time

Fields inherited from class NamedBaseClass

name

Constructor Summary

Constructors

Constructor	Description
Mixer(String name)	Constructor for Mixer.

Method Summary

Modifier and Type	Method	Description
void	addCapacityConstraint(CapacityConstraint constraint)	Adds a capacity constraint to this equipment.
void	addStream(StreamInterface newStream)	addStream.
double	calcMixStreamEnthalpy()	calcMixStreamEnthalpy.
void	clearCapacityConstraints()	Clears all capacity constraints from this equipment.
void	displayResult()	displayResult.
boolean	equals(Object obj)
CapacityConstraint	getBottleneckConstraint()	Gets the bottleneck (most limiting) constraint for this equipment.
Map<String, CapacityConstraint>	getCapacityConstraints()	Gets all capacity constraints defined for this equipment.
double	getDesignPressureDrop()	Gets the design pressure drop.
double	getEntropyProduction(String unit)	getEntropyProduction.
List<StreamInterface>	getInletStreams()	Returns all inlet streams connected to this equipment.
double	getMassBalance(String unit)	getMassBalance.
double	getMaxDesignVelocity()	Gets the maximum design velocity.
double	getMaxUtilization()	Gets the maximum utilization across all enabled constraints.
MechanicalDesign	getMechanicalDesign()	Get a mechanicalDesign for the equipment.
double	getMixedSalinity()	Calculates the flow-weighted average salinity of the mixed stream.
int	getNumberOfInputStreams()	Getter for the field numberOfInputStreams.
StreamInterface	getOutletStream()	Getter for outlet stream object.
List<StreamInterface>	getOutletStreams()	Returns all outlet streams produced by this equipment.
double	getOutletTemperature()	Getter for the outlet temperature.
double	getOutTemperature()	Deprecated. use getOutletTemperature() instead
StreamInterface	getStream(int i)	getStream.
SystemInterface	getThermoSystem()	getThermoSystem.
double	guessTemperature()	guessTemperature.
int	hashCode()
private void	initializeMixerCapacityConstraints()	Initialize mixer capacity constraints.
void	initMechanicalDesign()	Initialize a initMechanicalDesign for the equipment.
boolean	isCapacityAnalysisEnabled()	Checks if capacity analysis is enabled for this equipment.
boolean	isCapacityExceeded()	Checks if any capacity constraint is violated (exceeds 100% utilization).
boolean	isDoMultiPhaseCheck()	Getter for the field doMultiPhaseCheck.
boolean	isHardLimitExceeded()	Checks if any HARD constraint limit is exceeded.
boolean	isSetOutTemperature()	isSetOutTemperature.
void	isSetOutTemperature(boolean isSetOutTemperature)	isSetOutTemperature.
void	mixStream()	mixStream.
boolean	removeCapacityConstraint(String constraintName)	Removes a capacity constraint by name.
void	removeInputStream(int i)	removeInputStream.
void	replaceStream(int i, StreamInterface newStream)	replaceStream.
void	run(UUID id)	In this method all thermodynamic and unit operations will be calculated in a steady state calculation.
void	setCapacityAnalysisEnabled(boolean enabled)	Enables or disables capacity analysis for this equipment.
void	setDesignPressureDrop(double pressureDrop)	Sets the design pressure drop.
void	setMaxDesignVelocity(double velocity)	Sets the maximum design velocity.
void	setMultiPhaseCheck(boolean doMultiPhaseCheck)	Setter for the field doMultiPhaseCheck.
void	setOutletTemperature(double outTemperature)	Set the outlet temperature of the mixer.
void	setOutTemperature(double outTemperature)	Deprecated. use setOutletTemperature(double) instead
void	setPressure(double pres)	Setter for the field pressure.
void	setTemperature(double temp)	Setter for the field temperature.
String	toJson()	Serializes the Process Equipment along with its state to a JSON string.
String	toJson(ReportConfig cfg)	Serializes the Process Equipment with configurable level of detail.
ValidationResult	validateSetup()	Validate the process equipment before execution.

Methods inherited from class ProcessEquipmentBaseClass

addController, copy, getAvailableMargin, getAvailableMarginPercent, getConditionAnalysisMessage, getConstraintEvaluationReport, getController, getController, getControllers, getEffectiveCapacityFactor, getEnergyStream, getExergyChange, getFailureMode, getMassBalance, getMaxUtilizationPercent, getMinimumFlow, getPressure, getPressure, getProperty, getReferenceDesignation, getReport_json, getResultTable, getSpecification, getTemperature, getTemperature, getUtilizationSummary, initElectricalDesign, initializeDefaultConstraints, initInstrumentDesign, isActive, isActive, isFailed, isNearCapacityLimit, isSetEnergyStream, reportResults, restoreFromFailure, run_step, runConditionAnalysis, setController, setEnergyStream, setEnergyStream, setFailureMode, setFlowValveController, setMinimumFlow, setReferenceDesignation, setRegulatorOutSignal, setSpecification, simulateDegradedOperation, simulateTrip, solved

Methods inherited from class SimulationBaseClass

getCalculateSteadyState, getCalculationIdentifier, getTime, increaseTime, isRunInSteps, setCalculateSteadyState, setCalculationIdentifier, setRunInSteps, setTime

Methods inherited from class NamedBaseClass

getName, getTagNumber, setName, setTagNumber

Methods inherited from class Object

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

Methods inherited from interface CapacityConstrainedEquipment

disableAllConstraints, enableAllConstraints, getAvailableMargin, getAvailableMarginPercent, getMaxUtilizationPercent, getUtilizationSummary, isNearCapacityLimit

Methods inherited from interface MixerInterface

getOutStream

Methods inherited from interface NamedInterface

getName, getTagName, getTagNumber, setName, setTagName, setTagNumber

Methods inherited from interface ProcessEquipmentInterface

addController, getAvailableMargin, getAvailableMarginPercent, getCapacityDuty, getCapacityMax, getConditionAnalysisMessage, getController, getController, getControllers, getElectricalDesign, getEquipmentState, getExergyChange, getExergyChange, getExergyDestruction, getExergyDestruction, getFluid, getInstrumentDesign, getMassBalance, getMaxUtilizationPercent, getOperatingEnvelopeViolation, getOutletFlowRate, getOutletPressure, getOutletTemperature, getPressure, getPressure, getReferenceDesignation, getReferenceDesignationString, getReport_json, getRestCapacity, getResultTable, getSimulationValidationErrors, getSpecification, getTemperature, getTemperature, getUtilizationSummary, initElectricalDesign, initInstrumentDesign, isNearCapacityLimit, isSimulationValid, isWithinOperatingEnvelope, needRecalculation, reportResults, runConditionAnalysis, setController, setReferenceDesignation, setRegulatorOutSignal, setSpecification

Methods inherited from interface SimulationInterface

getCalculateSteadyState, getCalculationIdentifier, getTime, increaseTime, isRunInSteps, run, run_step, run_step, runTransient, runTransient, setCalculateSteadyState, setCalculationIdentifier, setRunInSteps, setTime, solved

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version UID.

See Also:

• Constant Field Values

logger

static org.apache.logging.log4j.Logger logger

Logger object for class.

mechanicalDesign

private MixerMechanicalDesign mechanicalDesign

Mechanical design for the mixer.

mixerCapacityConstraints

private Map<String, CapacityConstraint> mixerCapacityConstraints

Mixer capacity constraints map.

mixerCapacityAnalysisEnabled

private boolean mixerCapacityAnalysisEnabled

Whether capacity analysis is enabled.

designPressureDrop

private double designPressureDrop

Design pressure drop [bar].

maxDesignVelocity

private double maxDesignVelocity

Maximum design velocity [m/s].

streams

protected ArrayList<StreamInterface> streams

numberOfInputStreams

private int numberOfInputStreams

mixedStream

protected StreamInterface mixedStream

isSetOutTemperature

private boolean isSetOutTemperature

outTemperature

private double outTemperature

lowestPressure

double lowestPressure

doMultiPhaseCheck

private boolean doMultiPhaseCheck

Constructor Details

Mixer

public Mixer(String name)

Constructor for Mixer.

Parameters:

name - a String object

Method Details

setMultiPhaseCheck

public void setMultiPhaseCheck(boolean doMultiPhaseCheck)

Setter for the field doMultiPhaseCheck.

Parameters:

doMultiPhaseCheck - a boolean

isDoMultiPhaseCheck

public boolean isDoMultiPhaseCheck()

Getter for the field doMultiPhaseCheck.

Returns:

a boolean

getMechanicalDesign

public MechanicalDesign getMechanicalDesign()

Get a mechanicalDesign for the equipment.

Specified by:

getMechanicalDesign in interface ProcessEquipmentInterface

Overrides:

getMechanicalDesign in class ProcessEquipmentBaseClass

Returns:

a MechanicalDesign object

initMechanicalDesign

public void initMechanicalDesign()

Initialize a initMechanicalDesign for the equipment.

Specified by:

initMechanicalDesign in interface ProcessEquipmentInterface

Overrides:

initMechanicalDesign in class ProcessEquipmentBaseClass

getThermoSystem

public SystemInterface getThermoSystem()

getThermoSystem.

Specified by:

getThermoSystem in interface MixerInterface

Specified by:

getThermoSystem in interface ProcessEquipmentInterface

Overrides:

getThermoSystem in class ProcessEquipmentBaseClass

Returns:

a SystemInterface object

replaceStream

public void replaceStream(int i,
 StreamInterface newStream)

replaceStream.

Specified by:

replaceStream in interface MixerInterface

Parameters:

i - a int

newStream - a StreamInterface object

removeInputStream

public void removeInputStream(int i)

removeInputStream.

Specified by:

removeInputStream in interface MixerInterface

Parameters:

i - a int

addStream

public void addStream(StreamInterface newStream)

addStream.

Specified by:

addStream in interface MixerInterface

Parameters:

newStream - a StreamInterface object

getStream

public StreamInterface getStream(int i)

getStream.

Parameters:

i - a int

Returns:

a StreamInterface object

mixStream

public void mixStream()

mixStream.

guessTemperature

public double guessTemperature()

guessTemperature.

Returns:

a double

calcMixStreamEnthalpy

public double calcMixStreamEnthalpy()

calcMixStreamEnthalpy.

Returns:

a double

getOutletStream

public StreamInterface getOutletStream()

Getter for outlet stream object.

Specified by:

getOutletStream in interface MixerInterface

Returns:

a StreamInterface object

getInletStreams

public List<StreamInterface> getInletStreams()

Returns all inlet streams connected to this equipment. Subclasses override to report their specific inlets. Used by graph builders, DEXPI export, and auto-instrumentation to discover topology without instanceof checks.

Specified by:

getInletStreams in interface ProcessEquipmentInterface

Returns:

unmodifiable list of inlet streams (empty by default)

getOutletStreams

public List<StreamInterface> getOutletStreams()

Returns all outlet streams produced by this equipment. Subclasses override to report their specific outlets. Used by graph builders, DEXPI export, and auto-instrumentation to discover topology without instanceof checks.

Specified by:

getOutletStreams in interface ProcessEquipmentInterface

Returns:

unmodifiable list of outlet streams (empty by default)

run

public void run(UUID id)

In this method all thermodynamic and unit operations will be calculated in a steady state calculation.

Specified by:

run in interface SimulationInterface

Parameters:

id - UUID

displayResult

public void displayResult()

displayResult.

Specified by:

displayResult in interface ProcessEquipmentInterface

Overrides:

displayResult in class ProcessEquipmentBaseClass

setPressure

public void setPressure(double pres)

Setter for the field pressure.

Specified by:

setPressure in interface ProcessEquipmentInterface

Overrides:

setPressure in class ProcessEquipmentBaseClass

Parameters:

pres - a double

setTemperature

public void setTemperature(double temp)

Setter for the field temperature.

Specified by:

setTemperature in interface ProcessEquipmentInterface

Overrides:

setTemperature in class ProcessEquipmentBaseClass

Parameters:

temp - Temperature in Kelvin

getOutletTemperature

public double getOutletTemperature()

Getter for the outlet temperature.

Returns:

outlet temperature in Kelvin

getOutTemperature

@Deprecated
public double getOutTemperature()

Deprecated.

use getOutletTemperature() instead

Getter for the field outTemperature.

Returns:

outlet temperature in Kelvin

setOutletTemperature

public void setOutletTemperature(double outTemperature)

Set the outlet temperature of the mixer.

Parameters:

outTemperature - outlet temperature in Kelvin

setOutTemperature

@Deprecated
public void setOutTemperature(double outTemperature)

Deprecated.

use setOutletTemperature(double) instead

Setter for the field outTemperature.

Parameters:

outTemperature - outlet temperature in Kelvin

isSetOutTemperature

public boolean isSetOutTemperature()

isSetOutTemperature.

Returns:

a boolean

isSetOutTemperature

public void isSetOutTemperature(boolean isSetOutTemperature)

isSetOutTemperature.

Parameters:

isSetOutTemperature - a boolean

getNumberOfInputStreams

public int getNumberOfInputStreams()

Getter for the field numberOfInputStreams.

Returns:

a int

getEntropyProduction

public double getEntropyProduction(String unit)

getEntropyProduction.

Specified by:

getEntropyProduction in interface ProcessEquipmentInterface

Overrides:

getEntropyProduction in class ProcessEquipmentBaseClass

Parameters:

unit - a String object

Returns:

a double

getMassBalance

public double getMassBalance(String unit)

getMassBalance.

Specified by:

getMassBalance in interface ProcessEquipmentInterface

Overrides:

getMassBalance in class ProcessEquipmentBaseClass

Parameters:

unit - a String object

Returns:

a double

hashCode

public int hashCode()

Specified by:

hashCode in interface ProcessEquipmentInterface

Overrides:

hashCode in class ProcessEquipmentBaseClass

equals

public boolean equals(Object obj)

Specified by:

equals in interface ProcessEquipmentInterface

Overrides:

equals in class ProcessEquipmentBaseClass

getMixedSalinity

public double getMixedSalinity()

Calculates the flow-weighted average salinity of the mixed stream. Assumes each input stream provides getSalinity() and getFlowRate("kg/hr").

Returns:

mixed salinity (same unit as getSalinity() returns)

toJson

public String toJson()

Serializes the Process Equipment along with its state to a JSON string.

Specified by:

toJson in interface ProcessEquipmentInterface

Overrides:

toJson in class ProcessEquipmentBaseClass

Returns:

json string.

toJson

public String toJson(ReportConfig cfg)

Serializes the Process Equipment with configurable level of detail.

Specified by:

toJson in interface ProcessEquipmentInterface

Overrides:

toJson in class ProcessEquipmentBaseClass

Parameters:

cfg - report configuration

Returns:

json string

validateSetup

public ValidationResult validateSetup()

Validate the process equipment before execution.

Checks for common setup errors:

• Equipment has a valid name
• Input streams connected
• Operating parameters in valid ranges

Validates the mixer setup before execution. Checks that:

• Equipment has a valid name
• At least one input stream is connected
• Mixed stream is initialized

Specified by:

validateSetup in interface ProcessEquipmentInterface

Returns:

validation result with errors and warnings

initializeMixerCapacityConstraints

private void initializeMixerCapacityConstraints()

Initialize mixer capacity constraints.

setDesignPressureDrop

public void setDesignPressureDrop(double pressureDrop)

Sets the design pressure drop.

Parameters:

pressureDrop - design pressure drop in bar

getDesignPressureDrop

public double getDesignPressureDrop()

Gets the design pressure drop.

Returns:

design pressure drop in bar

setMaxDesignVelocity

public void setMaxDesignVelocity(double velocity)

Sets the maximum design velocity.

Parameters:

velocity - max design velocity in m/s

getMaxDesignVelocity

public double getMaxDesignVelocity()

Gets the maximum design velocity.

Returns:

max design velocity in m/s

isCapacityAnalysisEnabled

public boolean isCapacityAnalysisEnabled()

Checks if capacity analysis is enabled for this equipment.

When disabled, this equipment is excluded from bottleneck detection, capacity utilization summaries, and optimization routines. The equipment still tracks its constraints but doesn't contribute to system-level analysis.

Specified by:

isCapacityAnalysisEnabled in interface CapacityConstrainedEquipment

Overrides:

isCapacityAnalysisEnabled in class ProcessEquipmentBaseClass

Returns:

true if capacity analysis is enabled (default is true)

setCapacityAnalysisEnabled

public void setCapacityAnalysisEnabled(boolean enabled)

Enables or disables capacity analysis for this equipment.

When disabled, this equipment is excluded from:

• System bottleneck detection (ProcessSystem.findBottleneck())
• Capacity utilization summaries (ProcessSystem.getCapacityUtilizationSummary())
• Equipment near capacity lists (ProcessSystem.getEquipmentNearCapacityLimit())
• Optimization constraint checking

The equipment still calculates and tracks its constraints internally.

Specified by:

setCapacityAnalysisEnabled in interface CapacityConstrainedEquipment

Overrides:

setCapacityAnalysisEnabled in class ProcessEquipmentBaseClass

Parameters:

enabled - true to include in capacity analysis, false to exclude

getCapacityConstraints

public Map<String, CapacityConstraint> getCapacityConstraints()

Gets all capacity constraints defined for this equipment.

Returns an unmodifiable map of constraint name to constraint object. Constraints are used by the optimization framework to detect bottlenecks, enforce limits, and guide production allocation. Equipment subclasses populate this map via ProcessEquipmentInterface.addCapacityConstraint(CapacityConstraint).

Specified by:

getCapacityConstraints in interface CapacityConstrainedEquipment

Specified by:

getCapacityConstraints in interface ProcessEquipmentInterface

Overrides:

getCapacityConstraints in class ProcessEquipmentBaseClass

Returns:

unmodifiable map of constraint name to constraint, empty if none defined

getBottleneckConstraint

public CapacityConstraint getBottleneckConstraint()

Gets the bottleneck (most limiting) constraint for this equipment.

Returns the enabled constraint with the highest utilization ratio. If no constraints are defined or enabled, returns null.

Specified by:

getBottleneckConstraint in interface CapacityConstrainedEquipment

Specified by:

getBottleneckConstraint in interface ProcessEquipmentInterface

Overrides:

getBottleneckConstraint in class ProcessEquipmentBaseClass

Returns:

the most limiting constraint, or null if none

isCapacityExceeded

public boolean isCapacityExceeded()

Checks if any capacity constraint is violated (exceeds 100% utilization).

A violated constraint means the equipment is operating beyond its design capacity. For HARD constraints, this may indicate equipment trip or failure. For SOFT constraints, this indicates reduced efficiency or accelerated wear.

Specified by:

isCapacityExceeded in interface CapacityConstrainedEquipment

Specified by:

isCapacityExceeded in interface ProcessEquipmentInterface

Overrides:

isCapacityExceeded in class ProcessEquipmentBaseClass

Returns:

true if any enabled constraint utilization exceeds 1.0 (100%)

isHardLimitExceeded

public boolean isHardLimitExceeded()

Checks if any HARD constraint limit is exceeded.

HARD limits represent absolute equipment limits (e.g., maximum speed) that cannot be exceeded without equipment trip or damage. This is more severe than general capacity exceedance.

Specified by:

isHardLimitExceeded in interface CapacityConstrainedEquipment

Specified by:

isHardLimitExceeded in interface ProcessEquipmentInterface

Overrides:

isHardLimitExceeded in class ProcessEquipmentBaseClass

Returns:

true if any enabled HARD constraint's max value is exceeded

getMaxUtilization

public double getMaxUtilization()

Gets the maximum utilization across all enabled constraints.

Returns the highest utilization ratio across all enabled constraints. Values above 1.0 indicate the equipment is over capacity. Returns 0.0 if no constraints are defined or enabled.

Specified by:

getMaxUtilization in interface CapacityConstrainedEquipment

Specified by:

getMaxUtilization in interface ProcessEquipmentInterface

Overrides:

getMaxUtilization in class ProcessEquipmentBaseClass

Returns:

maximum utilization as fraction (1.0 = 100% of design capacity)

addCapacityConstraint

public void addCapacityConstraint(CapacityConstraint constraint)

Adds a capacity constraint to this equipment.

Constraints can be added at any time. If a constraint with the same name already exists, it is replaced. Use the fluent builder API on CapacityConstraint to configure the constraint before adding.

Specified by:

addCapacityConstraint in interface CapacityConstrainedEquipment

Specified by:

addCapacityConstraint in interface ProcessEquipmentInterface

Overrides:

addCapacityConstraint in class ProcessEquipmentBaseClass

Parameters:

constraint - the capacity constraint to add (ignored if null)

removeCapacityConstraint

public boolean removeCapacityConstraint(String constraintName)

Removes a capacity constraint by name.

Specified by:

removeCapacityConstraint in interface CapacityConstrainedEquipment

Parameters:

constraintName - the name of the constraint to remove

Returns:

true if the constraint was found and removed

clearCapacityConstraints

public void clearCapacityConstraints()

Clears all capacity constraints from this equipment.

Specified by:

clearCapacityConstraints in interface CapacityConstrainedEquipment