Class CalculatorLibrary

java.lang.Object

neqsim.process.equipment.util.CalculatorLibrary

public final class CalculatorLibrary
extends Object

Catalog of reusable Calculator presets. These presets provide declarative building blocks that can be paired with Calculator.setCalculationMethod(BiConsumer) to encourage consistent AI- or rule-generated logic across simulations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CalculatorLibrary.Preset	Preset identifiers that can be resolved through byName(String).

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CalculatorLibrary()

Method Summary

Modifier and Type	Method	Description
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	antiSurge()	Create an anti-surge recycle calculator with no surge margin.
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	antiSurge(double surgeMarginFactor)	Create an anti-surge recycle calculator with a configurable surge margin factor.
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	byName(String presetName)	Resolve a preset calculation by name (case-insensitive).
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	dewPointTargeting()	Create a dew-point targeting calculator with zero temperature margin.
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	dewPointTargeting(double marginKelvin)	Create a dew-point targeting calculator.
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	energyBalance()	Create an energy-balance calculator.
static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface>	preset(CalculatorLibrary.Preset preset)	Resolve a preset calculation.
private static Stream	requireFirstStream(ArrayList<ProcessEquipmentInterface> inputs, String role)
private static Stream	requireStream(ProcessEquipmentInterface equipment, String role)

Methods inherited from class Object

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

Field Details

logger

private static final org.apache.logging.log4j.Logger logger

Constructor Details

CalculatorLibrary

private CalculatorLibrary()

Method Details

byName

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> byName(String presetName)

Resolve a preset calculation by name (case-insensitive). This is useful when wiring calculators declaratively from metadata or AI-generated instructions.

Parameters:

presetName - the preset identifier (e.g., "energyBalance" or "dewPointTargeting")

Returns:

a BiConsumer ready for Calculator.setCalculationMethod(BiConsumer)

preset

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> preset(CalculatorLibrary.Preset preset)

Resolve a preset calculation.

Parameters:

preset - the preset identifier

Returns:

a BiConsumer ready for Calculator.setCalculationMethod(BiConsumer)

energyBalance

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> energyBalance()

Create an energy-balance calculator. The output stream is flashed at its current pressure so that its enthalpy equals the sum of the input stream enthalpies.

Returns:

a calculator function that performs energy balance

dewPointTargeting

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> dewPointTargeting(double marginKelvin)

Create a dew-point targeting calculator. It sets the output stream temperature to the hydrocarbon dew point of the first input stream at the output stream's current pressure. A small positive margin can be applied to stay above dew point.

Parameters:

marginKelvin - temperature margin to add to the dew point (K)

Returns:

a calculator function that performs dew point targeting

dewPointTargeting

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> dewPointTargeting()

Create a dew-point targeting calculator with zero temperature margin.

Returns:

a calculator function that performs dew point targeting

antiSurge

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> antiSurge()

Create an anti-surge recycle calculator with no surge margin. The recycle flow through the splitter's second outlet is adjusted so the compressor inlet actual volumetric flow equals the surge flow from the compressor chart.

Input variable 0 must be a Compressor with a loaded compressor chart. The output variable must be a Splitter whose split stream index 1 is the recycle line.

Returns:

a calculator function that performs anti-surge recycle adjustment

antiSurge

public static BiConsumer<ArrayList<ProcessEquipmentInterface>, ProcessEquipmentInterface> antiSurge(double surgeMarginFactor)

Create an anti-surge recycle calculator with a configurable surge margin factor. The target flow is surgeFlow * surgeMarginFactor. A factor of 1.1 targets 10 % above surge.

All flow comparisons use actual volumetric flow (m3/hr) to match the coordinate system of the compressor chart's surge curve.

Parameters:

surgeMarginFactor - multiplicative margin applied to the surge flow (1.0 = no margin)

Returns:

a calculator function that performs anti-surge recycle adjustment

requireStream

private static Stream requireStream(ProcessEquipmentInterface equipment,
 String role)

requireFirstStream

private static Stream requireFirstStream(ArrayList<ProcessEquipmentInterface> inputs,
 String role)