Class SpreadsheetBlock

java.lang.Object

neqsim.util.NamedBaseClass

neqsim.process.SimulationBaseClass

neqsim.process.equipment.ProcessEquipmentBaseClass

neqsim.process.equipment.util.SpreadsheetBlock

All Implemented Interfaces:

Serializable, Runnable, ProcessEquipmentInterface, ProcessElementInterface, SimulationInterface, NamedInterface

public class SpreadsheetBlock
extends ProcessEquipmentBaseClass

Inline spreadsheet / calculator block for embedding custom calculations directly in a flowsheet. Similar to UniSim's spreadsheet, this block lets users define named import cells that pull values from process streams or equipment, named formula cells that perform arithmetic on those values, and export cells that push computed results back into the process.

Usage example:

SpreadsheetBlock sheet = new SpreadsheetBlock("Energy Calc");
sheet.addStreamImportCell("T_in", feed, s -> s.getTemperature("C"));
sheet.addStreamImportCell("T_out", product, s -> s.getTemperature("C"));
sheet.addStreamImportCell("mdot", feed, s -> s.getFlowRate("kg/hr"));
sheet.addFormulaCell("deltaT", cells -> cells.get("T_out") - cells.get("T_in"));
sheet.addFormulaCell("duty_kW",
    cells -> cells.get("mdot") * 4.18 * cells.get("deltaT") / 3600.0);
sheet.addExportCell("duty_kW", cooler, (eq, val) -> ((Cooler) eq).setEnergyInput(val));

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	SpreadsheetBlock.CellDefinition	Base interface for cell definitions.
private static class	SpreadsheetBlock.ConstantCell	Cell with a constant value.
private static class	SpreadsheetBlock.ExportTarget	Internal record for export targets.
static interface	SpreadsheetBlock.ExportWriter	Functional interface for writing a computed value to process equipment.
private static class	SpreadsheetBlock.FormulaCell	Cell computed by a formula referencing other cells.
private static class	SpreadsheetBlock.ImportCellFromEquipment	Cell that reads from process equipment.
private static class	SpreadsheetBlock.ImportCellFromStream	Cell that reads from a stream.

Field Summary

Fields

Modifier and Type	Field	Description
private final LinkedHashMap<String, SpreadsheetBlock.CellDefinition>	cells	Ordered map of cell names to their definitions.
private final LinkedHashMap<String,Double>	cellValues	Current computed values for each cell.
private final List<SpreadsheetBlock.ExportTarget>	exportTargets	Export targets that push computed values back into the process.
private static final org.apache.logging.log4j.Logger	logger	Logger object for class.
private static final long	serialVersionUID	Serialization version UID.

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
SpreadsheetBlock(String name)	Constructor for SpreadsheetBlock.

Method Summary

Modifier and Type	Method	Description
void	addConstantCell(String cellName, double value)	Add a constant cell with a fixed value.
void	addExportCell(String cellName, ProcessEquipmentInterface target, SpreadsheetBlock.ExportWriter writer)	Add an export target that pushes a computed cell value back into process equipment after calculation.
void	addFormulaCell(String cellName, Function<Map<String,Double>, Double> formula)	Add a formula cell that computes a value from the current cell values.
void	addImportCell(String cellName, ProcessEquipmentInterface equipment, Function<ProcessEquipmentInterface, Double> reader)	Add an import cell that reads a value from any process equipment each time the block runs.
void	addStreamImportCell(String cellName, StreamInterface stream, Function<StreamInterface, Double> reader)	Add an import cell that reads a value from a stream each time the block runs.
Map<String,Double>	getAllCellValues()	Get all current cell values as an unmodifiable map.
List<String>	getCellNames()	Get the names of all defined cells in order.
double	getCellValue(String cellName)	Get the current computed value of a cell.
void	run(UUID id)	In this method all thermodynamic and unit operations will be calculated in a steady state calculation.

Methods inherited from class ProcessEquipmentBaseClass

addCapacityConstraint, addController, copy, displayResult, equals, getAvailableMargin, getAvailableMarginPercent, getBottleneckConstraint, getCapacityConstraints, getConditionAnalysisMessage, getConstraintEvaluationReport, getController, getController, getControllers, getEffectiveCapacityFactor, getEnergyStream, getEntropyProduction, getExergyChange, getFailureMode, getMassBalance, getMassBalance, getMaxUtilization, getMaxUtilizationPercent, getMechanicalDesign, getMinimumFlow, getPressure, getPressure, getProperty, getReferenceDesignation, getReport_json, getResultTable, getSpecification, getTemperature, getTemperature, getThermoSystem, getUtilizationSummary, hashCode, initElectricalDesign, initializeDefaultConstraints, initInstrumentDesign, initMechanicalDesign, isActive, isActive, isCapacityAnalysisEnabled, isCapacityExceeded, isFailed, isHardLimitExceeded, isNearCapacityLimit, isSetEnergyStream, reportResults, restoreFromFailure, run_step, runConditionAnalysis, setCapacityAnalysisEnabled, setController, setEnergyStream, setEnergyStream, setFailureMode, setFlowValveController, setMinimumFlow, setPressure, setReferenceDesignation, setRegulatorOutSignal, setSpecification, setTemperature, simulateDegradedOperation, simulateTrip, solved, toJson, toJson

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 NamedInterface

getName, getTagName, getTagNumber, setName, setTagName, setTagNumber

Methods inherited from interface ProcessEquipmentInterface

getCapacityDuty, getCapacityMax, getElectricalDesign, getEquipmentState, getExergyChange, getExergyDestruction, getExergyDestruction, getFluid, getInletStreams, getInstrumentDesign, getOperatingEnvelopeViolation, getOutletFlowRate, getOutletPressure, getOutletStreams, getOutletTemperature, getReferenceDesignationString, getRestCapacity, getSimulationValidationErrors, isSimulationValid, isWithinOperatingEnvelope, needRecalculation, validateSetup

Methods inherited from interface SimulationInterface

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

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version UID.

See Also:

• Constant Field Values

logger

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

Logger object for class.

cells

private final LinkedHashMap<String, SpreadsheetBlock.CellDefinition> cells

Ordered map of cell names to their definitions.

cellValues

private final LinkedHashMap<String,Double> cellValues

Current computed values for each cell.

exportTargets

private final List<SpreadsheetBlock.ExportTarget> exportTargets

Export targets that push computed values back into the process.

Constructor Details

SpreadsheetBlock

public SpreadsheetBlock(String name)

Constructor for SpreadsheetBlock.

Parameters:

name - a String name for this spreadsheet block

Method Details

addStreamImportCell

public void addStreamImportCell(String cellName,
 StreamInterface stream,
 Function<StreamInterface, Double> reader)

Add an import cell that reads a value from a stream each time the block runs.

Parameters:

cellName - unique name for this cell (e.g. "T_inlet")

stream - the source stream to read from

reader - function that extracts a double value from the stream

addImportCell

public void addImportCell(String cellName,
 ProcessEquipmentInterface equipment,
 Function<ProcessEquipmentInterface, Double> reader)

Add an import cell that reads a value from any process equipment each time the block runs.

Parameters:

cellName - unique name for this cell

equipment - the source equipment to read from

reader - function that extracts a double value from the equipment

addConstantCell

public void addConstantCell(String cellName,
 double value)

Add a constant cell with a fixed value.

Parameters:

cellName - unique name for this cell

value - the constant value

addFormulaCell

public void addFormulaCell(String cellName,
 Function<Map<String,Double>, Double> formula)

Add a formula cell that computes a value from the current cell values. Formula cells can reference any previously defined cell (import, constant, or earlier formula cells).

Parameters:

cellName - unique name for this cell

formula - function that takes the map of current cell values and returns the computed value

addExportCell

public void addExportCell(String cellName,
 ProcessEquipmentInterface target,
 SpreadsheetBlock.ExportWriter writer)

Add an export target that pushes a computed cell value back into process equipment after calculation.

Parameters:

cellName - the cell whose value to export

target - the equipment to receive the value

writer - biconsumer that applies the value to the equipment

getCellValue

public double getCellValue(String cellName)

Get the current computed value of a cell.

Parameters:

cellName - the cell name

Returns:

the current value, or Double.NaN if not yet computed

getAllCellValues

public Map<String,Double> getAllCellValues()

Get all current cell values as an unmodifiable map.

Returns:

map of cell name to computed value

getCellNames

public List<String> getCellNames()

Get the names of all defined cells in order.

Returns:

list of cell names

run

public void run(UUID id)

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

Parameters:

id - UUID