All Classes and Interfaces
Class
Description
AbsorberInterface interface.
AbsorberMechanicalDesign class.
AbsorptionColumnDesignStandard class.
Enumeration of convergence acceleration methods for recycle calculations.
Standardized action vector for RL control integration.
Action to activate a blowdown valve.
addIonToScaleSaturation class.
AdiabaticPipe class.
AdiabaticTwoPhasePipe class.
Adjuster class.
AdsorberMechanicalDesign class.
AdsorptionDehydrationDesignStandard class.
AdsorptionDehydrationlModule class.
AdsorptionInterface interface.
Comprehensive example demonstrating advanced process logic features.
Simple action implementation for example.
Advection schemes for compositional tracking in pipeline transient simulations.
Interface for an individual agent in a multi-agent system.
Marks a class, method, or field as exposed for AI/ML integration.
AI Integration Helper for NeqSim.
Result of a safe execution.
Execution status.
Documents a parameter for AI consumption.
Air cooler using humid air properties to estimate required air flow.
AirPhysicalProperties class.
Discovers and documents AI-exposed NeqSim functionality.
Schema for a discovered method.
Schema for a method parameter.
Interface for handling alarm-triggered actions.
Configuration describing the alarm limits, deadband and delay for a measurement signal.
Builder for
AlarmConfig instances.Utility class for evaluating alarms across multiple measurement devices.
Represents an alarm life-cycle event such as activation, acknowledgement or clearance.
Type of event produced during alarm evaluation.
Enumerates the discrete alarm levels used when evaluating measurement values.
Direction of the alarm (high or low).
Utility class for formatting and displaying alarm information.
Mutable alarm state tracking activation, acknowledgement and pending transitions.
Immutable snapshot of an alarm currently active in the system.
Result of well production allocation.
AmineDiffusivity class.
AminePhysicalProperties class.
AmineViscosity class.
Utility class implementing the Ammonia2023 reference equation of state.
Container for ideal Helmholtz derivatives.
Container for residual Helmholtz derivatives.
AnnularFlow class.
AntiSurge class for compressor surge protection in dynamic simulations.
Enum for anti-surge control strategies.
Artificial lift screening and selection tool.
Artificial lift method types.
Result for a single artificial lift method.
Screening result containing all evaluated methods.
AspenIP21Database class.
Characterizes asphaltene content using SARA fractionation data.
Compares De Boer screening with CPA-based thermodynamic asphaltene analysis.
Fits CPA asphaltene model parameters to measured asphaltene onset points.
Inner class to hold an onset data point.
Fitting function for asphaltene onset pressure/temperature.
Enum for different fitting parameter types.
Calculates the asphaltene onset pressure at a given temperature.
Calculates the asphaltene onset temperature at a given pressure.
High-level API for asphaltene stability analysis.
Risk level enumeration.
AtractiveTermMatCopPRUMRNew class.
AttractiveTermBaseClass class.
AttractiveTermCPAstatoil class.
AttractiveTermGERG class.
AttractiveTermInterface interface.
AttractiveTermMatCop class.
AttractiveTermMatCopPR class.
AttractiveTermMatCopPRUMR class.
AttractiveTermMollerup class.
AttractiveTermPr class.
AttractiveTermPr1978 class.
AttractiveTermPrDanesh class.
AttractiveTermPrDelft1998 class.
AttractiveTermPrGassem2001 class.
AttractiveTermRk class.
AttractiveTermSchwartzentruber class.
AttractiveTermSoreideWhitson class.
AttractiveTermSrk class.
AttractiveTermTwu class.
AttractiveTermTwuCoon class.
AttractiveTermTwuCoonParam class.
AttractiveTermTwuCoonStatoil class.
AttractiveTermUMRPRU class.
AUSM+ (Advection Upstream Splitting Method Plus) flux calculator for two-fluid model.
Flux vector for one phase.
State vector for one phase at a cell interface.
Combined flux result for both phases.
Automatically generates safety scenarios from equipment failure modes.
Represents a potential equipment failure.
Standard equipment failure modes.
Standard HAZOP deviation types.
Result of running a single safety scenario.
Bang-bang (on-off) controller with hysteresis.
BaseContract class.
Abstract BaseFunction class.
Abstract BaseOperation class.
BasePVTsimulation class.
BaseResponse class.
BaseTuningClass class.
BaseUnit class.
Batch runner for parallel evaluation of multiple concepts.
Results from batch evaluation.
Progress listener interface.
Batch parameter estimator using Levenberg-Marquardt optimization.
Represents a data point with conditions and measurements.
Represents a measured variable.
Represents a tunable parameter.
Container for batch parameter estimation results.
Parallel parameter study for rapid concept screening.
Results of a batch study.
Builder for BatchStudy.
Result of a single case.
Optimization direction.
Definition of an objective.
A set of parameter values for one case.
Definition of a parameter variation.
Simple battery storage unit maintaining a state of charge.
Validation of Beggs and Brill pipeline model against literature data and analytical solutions.
BerlSaddlePacking class.
BestPracticeHydrocarbonDewPoint class.
Enumeration of binary interaction parameter (BIP) estimation methods.
Utility class for estimating binary interaction parameters (BIPs) using correlations from the
literature.
Converter from a compositional (EOS) NeqSim fluid to a Black-Oil PVT table + stream.
Result class to hold the output of the conversion.
Black oil correlations for estimating PVT properties.
Core Black-Oil flash calculator.
DTO for Black-Oil flash results at (P,T).
Black-Oil PVT table with linear interpolation in pressure.
Record class to hold PVT data for a specific pressure.
Simple equilibrium Black-Oil separator at given (P_out, T_out).
Utility class for validating black-oil PVT tables per Whitson wiki guidelines.
Validation result container.
Unit system enumeration for Black Oil correlations.
Configuration for a single facility block.
Pre-defined facility block types for rapid facility assembly.
Blowdown Valve (BDValve) for emergency depressurization systems (ESD).
Bottleneck identification and debottlenecking analysis for process facilities.
Bottleneck analysis result.
Constraint type enumeration.
Debottlenecking option.
Equipment type enumeration.
Immutable container for environmental boundary conditions in safety scenarios.
Builder for BoundaryConditions.
Abstract base implementation for compressor limit curves such as surge and stone wall curves.
Common interface for compressor limit curves such as surge and stone wall curves.
Broyden's quasi-Newton acceleration method for multi-variable recycle convergence.
BubbleFlowNode class.
bubblePointPressureFlash class.
bubblePointPressureFlashDer class.
bubblePointTemperatureFlash class.
bubblePointTemperatureNoDer class.
BukacekWaterInGas class.
CalcIonicComposition class.
calcSaltSatauration class.
CalculationResult class.
Calculator class.
Catalog of reusable
Calculator presets.Preset identifiers that can be resolved through
CalculatorLibrary.byName(String).Example demonstrating the new calibration framework for online parameter estimation.
Represents calibration quality metrics for model validation.
Represents the result of a calibration operation.
Represents a validation alert indicating that a disposal unit is overloaded in a load case.
Cascade control structure where a primary controller sets the set-point of a secondary
controller.
Full-lifecycle cash flow engine for field development economics.
Represents cash flow for a single year.
Complete result of cash flow calculation.
Data point for Constant Composition Expansion (CCE) experiment.
Characterise class.
CharacteriseInterface interface.
Configuration options for fluid characterization operations.
Builder for CharacterizationOptions.
Naming scheme for pseudo-components in the characterized fluid.
Validation report for fluid characterization operations.
CharCoalFilter class.
checkScalePotential class.
Check valve (non-return valve) that prevents reverse flow.
ChemEq class.
ChemicalEquilibrium class.
ChemicalEquilibrium class.
ChemicalReaction class.
ChemicalReactionFactory class.
ChemicalReactionList class.
ChemicalReactionOperations class.
ChungConductivityMethod class extending conductivity for gases.
ChungFunction class.
ChungViscosityMethod class.
Action to fully close a valve (0% opening).
CMEFunction class.
CMG (Computer Modelling Group) reservoir simulator EOS/PVT exporter.
Configuration for CMG export.
CMG Simulator target.
Simple Writer implementation that writes to a StringBuilder.
Unit system for CMG export.
Reference thermal conductivity correlation for pure carbon dioxide.
Electrochemical reactor converting CO₂ rich feeds to value added products.
CO2RemovalModule class.
Reference viscosity correlation for pure carbon dioxide.
CO2water class.
CO2waterPhysicalProperties class.
CombustionEmissionsCalculator class.
CommonPhysicalPropertyMethod class.
Abstract Component class.
Component implementation for the ammonia reference equation of state.
Component class for the Burgoyne–Nielsen–Stanko PR correlation.
ComponentBWRS class.
ComponentCPAInterface interface.
ComponentCSPsrk class.
ComponentDesmukhMather class.
ComponentElectrolyteCPA class.
ComponentElectrolyteCPAOld class.
ComponentElectrolyteCPAstatoil class.
Abstract ComponentEos class.
Component implementation for EOS-CG mirroring the GERG-2008 component behaviour.
ComponentEosInterface interface.
Abstract class ComponentGE.
ComponentGeDuanSun class.
ComponentGEInterface interface.
ComponentGeNRTL class.
ComponentGENRTLmodifiedHV class.
ComponentGENRTLmodifiedWS class.
Component class for the Pitzer model.
ComponentGERG2004 class.
ComponentGERG2008 class.
ComponentGEUnifac class.
ComponentGEUnifacPSRK class.
ComponentGEUnifacUMRPRU class.
ComponentGEUniquac class.
Abstract class ComponentGEUniquacmodifiedHV.
ComponentGEWilson class.
ComponentHydrate class.
ComponentHydrateBallard class.
ComponentHydrateGF class.
ComponentHydrateKluda class.
ComponentHydratePVTsim class.
ComponentHydrateStatoil class.
Component implementation for the ideal gas model.
ComponentInterface interface.
ComponentKentEisenberg class.
ComponentLeachman class.
ComponentModifiedFurstElectrolyteEos class.
ComponentModifiedFurstElectrolyteEosMod2004 class.
ComponentPCSAFT class.
ComponentPCSAFTa class.
ComponentPR class.
Abstract class ComponentPrCPA.
ComponentPRvolcor class.
ComponentRK class.
ComponentSolid class.
ComponentSoreideWhitson for Søreide-Whitson Peng-Robinson EoS with modified alpha.
Component class for the Span-Wagner reference equation for CO2.
Splitter class.
ComponentSplitterResponse class provides basic reporting for a component splitter unit.
ComponentSrk class.
ComponentSrkCPA class.
Component class for the Maribo-Mogensen electrolyte CPA (e-CPA) model.
ComponentSrkCPAs class.
ComponentSrkPeneloux class.
ComponentSrkvolcor class.
ComponentTST class.
ComponentSrkCPA class.
ComponentVega class.
Component class for the IAPWS-IF97 water model.
ComponentWax class.
ComponentWaxWilson class.
ComponentWonWax class.
CompositionEstimation class.
Compressor class.
Builder class for constructing Compressor instances with a fluent API.
RL agent for compressor control with anti-surge protection.
CompressorChart class.
CompressorChartAlternativeMapLookup class.
CompressorChartAlternativeMapLookupExtrapolate class.
Compressor chart generator.
CompressorChartInterface interface.
CompressorChartKhader2015 is a class that implements the compressor chart calculations based on
the Kader 2015 method.
Simple POJO to hold corrected (dimensionless) compressor curve data for a given speed.
Simple POJO to hold real (physical units) compressor curve data for a given speed.
Compressor chart with multiple performance maps at different molecular weights.
Internal class to hold interpolation indices and fraction.
CompressorChartReader class.
CompressorCostEstimate class.
CompressorCurve class.
Utility class providing correction factors for centrifugal compressor performance curves.
Template class for storing normalized compressor curve data.
CompressorDesignStandard class.
Models the driver (motor, turbine, engine) for a compressor.
Listener interface for compressor events in dynamic simulations.
CompressorInterface interface.
Mechanical design calculations for centrifugal compressors.
Casing type enumeration per API 617.
Response class for compressor mechanical design JSON export.
Models mechanical losses and seal gas consumption for centrifugal compressors.
Bearing type enumeration.
Seal type enumeration.
CompressorMonitor class.
Records and tracks compressor operating history for analysis and trending.
Inner class representing a single operating point.
CompressorPropertyProfile class.
CompressorResponse class.
Enumeration representing the operating states of a compressor in dynamic simulations.
Main orchestrator for field development concept evaluation.
Key Performance Indicators from concept evaluation.
Builder for ConceptKPIs.
Links field development concepts to detailed process models.
Fidelity level for process model generation.
Process template type.
Condenser class.
Executes an action conditionally based on a runtime condition.
ConditionMonitor class.
ConditionMonitorSpecifications interface.
Abstract class for Conductivity.
Abstract class Conductivity for gases.
Conductivity class for liquids.
Conductivity class for solids.
ConductivityInterface interface.
Example demonstrating how to create process logic from external configuration without any
pre-compilation - logic is loaded from text/JSON-like format at runtime.
Factory class for creating logic from configurations.
Configuration container for parsed logic.
Abstract constantDutyFlash class.
ConstantDutyFlashInterface interface.
constantDutyPressureFlash class.
constantDutyTemperatureFlash class.
ConstantMassExpansion class.
ConstantVolumeDepletion class.
Represents a physical or operational constraint for process equipment.
Constraint category for grouping.
Constraint type enumeration.
Unified constraint management for process equipment.
Listener interface for constraint violation events.
ContractInterface interface.
ContractSpecification class.
Represents a controlled variable (CV) in an MPC formulation.
Interface for simple control policies that can be used to test RL environments from Java.
Provides a real-time data exchange interface between NeqSim MPC and external control systems.
Container for controller output data.
Execution status.
Quality status flags.
Discrete PID controller implementation providing common features for process control in NeqSim.
General contract for feedback controllers operating on measurement devices in
NeqSim.
Available tuning rules for step-response based auto-tuning.
Event log entry capturing controller state at a particular simulation time.
Generic interface for multi-loop control structures coordinating one or more regulators.
Control valve for process flow control.
Provides methods for sizing control valves for liquids and gases according to standard equations.
ControlValveSizing_IEC_60534 class.
Provides a full implementation of the IEC 60534 standard for control valve sizing.
Provides simplified methods for sizing production chokes and control valves.
ControlValveSizingInterface interface.
Cooler class.
CorrespondingStatesDiffusivity class.
Costald Density Calculation class for liquids.
CostEstimateBaseClass class.
CPAContribution provides utility methods for CPA (Cubic Plus Association) calculations that are
common across different cubic EOS implementations (SRK-CPA, PR-CPA, UMR-CPA, etc.).
CPAMixingRules class.
CPAMixingRulesInterface interface.
Types of CPAMixingRule, relating to different kind of mixing rules relevant for CPA type phases.
cricondebarFlash class.
CricondenbarAnalyser class.
CricondenBarFlash class.
cricondenBarTemp class.
cricondenBarTemp1 class.
CricondenThermFlash class.
CriticalPointFlash class.
Loads mechanical design limits from a CSV file.
CSV-based data source for loading Technical Requirements Documents (TORG).
Data point for Constant Volume Depletion (CVD) experiment.
CVDFunction class.
Reads mechanical design limits from the NeqSim process design database.
Database-based data source for loading Technical Requirements Documents (TORG).
Helper class for legacy data loading.
DataHandling class.
DataObject class.
DataObjectInterface interface.
DataReader class.
DataReaderInterface interface.
DataSmoothor class.
De Boer plot-based screening for asphaltene precipitation risk.
Risk level enumeration based on De Boer plot regions.
Decommissioning cost estimation for offshore oil and gas facilities.
Cost breakdown item.
Facility type enumeration.
Pipeline decommissioning strategy.
DefaultPhysicalProperties class.
Density class for gases.
Density class foir liquids.
Density class for solids.
DensityFunction class.
DensityInterface interface.
DensitySim class.
Enumeration of design cases for process equipment sizing.
Immutable mechanical design limits for a unit of equipment.
Builder for
DesignLimitData.Enumeration of field development design phases with associated accuracy requirements.
DesignStandard class.
Represents validation results from design calculations.
Severity levels for validation messages.
Represents a single validation message.
DETAIL class.
Detailed emissions calculator for oil and gas facilities.
Combustion source configuration.
Combustion source types.
Detailed emissions report.
Represents a fire or gas detector in a Safety Instrumented System.
Alarm level enumeration.
Detector type enumeration.
Decision support tool for ranking and scoring development options.
Decision criteria for ranking.
A development option with scores for each criterion.
Result of ranking analysis.
dewPointPressureFlash class.
dewPointTemperatureFlash class.
dewPointTemperatureFlashDer class.
Bridge between DEXPI XML data exchange and PFD visualization.
Shared constants describing the recommended DEXPI metadata handled by the reader and writer.
Shared constants describing the recommended DEXPI metadata handled by the reader and writer.
Lightweight placeholder for equipment imported from a DEXPI XML file.
Lightweight placeholder for equipment imported from a DEXPI XML file.
Describes validation profiles for round-tripping DEXPI data through NeqSim.
Describes validation profiles for round-tripping DEXPI data through NeqSim.
Profile validation result.
Profile validation result.
Stream created from DEXPI piping segments while preserving key metadata.
Stream created from DEXPI piping segments while preserving key metadata.
Utility for reading DEXPI XML files and converting them into NeqSim process models.
Utility for reading DEXPI XML files and converting them into NeqSim process models.
Exception thrown when there is an error reading a DEXPI XML file.
Exception thrown when there is an error reading a DEXPI XML file.
Utility for exporting
ProcessSystems created from DEXPI data back into a lightweight
DEXPI XML representation.Utility for exporting
ProcessSystems created from DEXPI data back into a lightweight
DEXPI XML representation.Defines the level of detail to include in process flow diagrams.
Defines the visual style for process flow diagrams.
Computes gradients of flash calculation results using the implicit function theorem.
DifferentialLiberation class.
Utility for calculating mass flow rates from differential pressure devices using NeqSim
thermodynamic properties.
Result container for the differential pressure flow calculation.
Diffusivity class.
Diffusivity class for gas phase diffusion coefficient calculations.
Diffusivity class.
Diffusivity class.
DiffusivityInterface interface.
Automatic diffusivity model selector for liquid phases.
Diffusivity model types.
Result of evaluating a disposal network for a single load case.
Aggregates loads from multiple relief sources into disposal units and evaluates performance for
each simultaneous load case.
Summary of disposal network evaluation across all analysed load cases.
Models a tray based distillation column with optional condenser and reboiler.
Builder class for creating DistillationColumn instances with a fluent API.
Feed stream configuration holder.
Available solving strategies for the column.
A matrix-based solver for DistillationColumn using the Inside-Out algorithm approach.
PumpResponse class.
DistillationInterface interface.
DistillationTraySection class.
Represents a disturbance variable (DV) in an MPC formulation.
Data point for Differential Liberation Expansion (DLE) experiment.
DoubleCloneable class.
DPCUModule class.
Draft_GERG2004 class.
Draft_ISO18453 class.
Drift-flux model for two-phase pipe flow.
Drift-flux parameters for a pipe section.
Energy equation result containing temperature change and heat transfer components.
Enum representing different types of compressor drivers.
DropletFlowNode class.
dTPflash class.
DuanSun class.
Example demonstrating how to create process logic completely dynamically at runtime without any
pre-compiled logic sequences.
Minimal ECLIPSE deck importer to build a Black-Oil fluid.
Eclipse reservoir simulator EOS/PVT keyword exporter.
Configuration for Eclipse export.
Simple Writer implementation that writes to a StringBuilder.
Unit system for Eclipse export.
EclipseFluidReadWrite class.
Economics estimator for concept-level CAPEX/OPEX screening in field development.
Immutable report containing economics screening results.
Builder for constructing
EconomicsEstimator.EconomicsReport instances.Ejector class represents an ejector in a process simulation.
Immutable container for mechanical design results of an ejector.
Mechanical design container for ejector sizing results.
EjectorResponse class for JSON serialization of Ejector equipment.
ElectrolyteMixingRulesInterface interface.
Electrolyzer unit converting water to hydrogen and oxygen using electrical energy.
Element class.
Emissions tracker for concept-level CO2 intensity estimation.
Tracks CO2 equivalent emissions and energy consumption for a ProcessSystem.
Categories of emissions sources.
Emissions report from screening.
Complete emissions report for a process system.
Builder for EmissionsReport.
Time-series snapshot of emissions.
Emissions from a single piece of equipment.
Action to energize an ESD valve and open it to a specified position.
Energy efficiency calculator for oil and gas facilities.
Driver types for power generation.
Energy efficiency report.
Facility types for benchmarking.
Energy improvement recommendation.
EnergyStream class.
EnergyUnit class for converting between different energy units.
EnhancementFactor class.
EnhancementFactorAlg class.
EnhancementFactorInterface interface.
EnhancementFactorNumeric class.
Ensemble Kalman Filter (EnKF) estimator for online calibration of process parameters.
Result of an EnKF update step.
Specification for a measured variable.
Specification for a tunable parameter.
Entrainment and deposition model for droplet exchange between phases.
Model for deposition rate calculation.
Model for entrainment rate calculation.
Result container for entrainment/deposition calculations.
Environmental KPI reporter for field development.
Environmental report result container.
Power supply type for emission calculations.
Standalone EOS-CG correlation adapter.
EOS-CG correlation wrapper implemented using the EOSCGModel (based on GERG-2008 functional form).
GERG2008 class.
EosMixingRuleHandler class.
EosMixingRulesInterface interface.
Types of EosMixingRule, relating to different kind of mixing rules relevant for EOS type phases.
Runner for testing RL environments with simple controllers from Java.
Statistics from multiple episode runs.
Result of running an episode.
Represents a valve with an equal percentage flow characteristic.
EquilibriumFluidBoundary class.
EquilibriumStream class.
EquipmentEnum class.
Factory for creating process equipment.
Classifies process equipment by its functional role in the process.
Adapter for extracting StateVectors from process equipment.
Validators for process equipment (Separator, DistillationColumn, Heater, Cooler, etc.).
Defines visual styling for process equipment in PFD diagrams.
Example demonstrating Emergency Shutdown (ESD) system with Control Valve, ESD Valve, Blowdown
Valve and Push Button.
Simplified ESD (Emergency Shutdown) logic implementation.
Internal class to store an action with its delay.
Marker interface for actions that can be reset.
Example demonstrating ESD Logic Framework - coordinated shutdown sequence.
Emergency Shutdown (ESD) Valve / Isolation Valve (XV) for process safety systems.
Example demonstrating ESD (Emergency Shutdown) Valve functionality.
Electric Submersible Pump (ESP) simulation model for multiphase flow.
Test harness for validating parameter estimation systems before deployment.
Measurement specification.
Monte Carlo validation report.
Parameter specification with ground truth.
Test report containing results and metrics.
ExcludeFromJacocoGeneratedReport class.
Expander class.
ExpanderInterface interface.
Mechanical design calculations for turboexpanders per API 617.
Expander type classification.
Load type for power recovery.
ExpanderOld class.
ExperimentalEquipmentData class.
Enumeration of PVT experiment types supported by the regression framework.
Fluent builder for assembling facility configurations from modular blocks.
Extended facility capacity analysis for field development planning.
Complete facility capacity assessment result.
Capacity assessment period for time-varying analysis.
Debottleneck option with cost-benefit analysis.
Immutable configuration for a complete facility.
Utility class for extracting ML features from NeqSim process streams.
Feed-forward control structure combining a feedback controller with a feed-forward contribution
based on a measured disturbance.
Main field concept definition for rapid field development screening.
Builder for FieldConcept.
Orchestrator for field development design workflows.
Represents results for a single design case.
Represents a single workflow step.
Unified field development workflow orchestrator.
Fidelity level for the workflow.
Study phase in field development lifecycle.
Orchestrates field-level production scheduling and forecasting.
Complete production schedule result.
Reservoir record containing reservoir reference and metadata.
Single time step in a production schedule.
FileSystemSettings interface.
Filter class.
FilterResponse class for JSON serialization of Filter equipment.
Fire Detector instrument for fire detection and alarm systems.
Example demonstrating Safety Instrumented System (SIS) for fire and gas detection.
Utility methods for estimating fire heat loads for blowdown and relief calculations.
Calculates metal wall temperatures for wetted and unwetted zones during fire exposure.
Result container for surface temperature calculations.
FirozabadiRamleyInterfaceTension class.
Data class holding all fiscal parameters for a specific country or region.
Builder for FiscalParameters.
Depreciation method.
Type of fiscal system.
Ring-fence level (FIELD, LICENSE, COMPANY).
Fittings class.
Flare unit operation for combustion of a process stream.
Result object containing utilization against the configured design capacities.
DTO describing utilization of a flare against its configured design capacities.
DTO describing surrogate parameters used for dispersion screening of flare releases.
DTO encapsulating emission, radiation, dispersion and capacity responses for a flare.
FlareResponse class for JSON serialization of Flare equipment.
FlareStack: Combusts relief gas and computes heat release, emissions, radiation and tip
backpressure.
Abstract base class for all flash classes.
Container for gradients of flash calculation results with respect to input parameters.
Example: Generate training data for a flash calculation surrogate model.
Pre-computed flash property table for fast interpolation.
Detailed results from flow assurance screening.
Builder for FlowAssuranceReport.
Result classification for flow assurance screening.
Flow assurance screener for rapid envelope-based assessment.
FlowInducedVibrationAnalyser class.
Abstract FlowLeg class.
FlowLegInterface interface.
Abstract FlowNode class.
FlowNodeInterface interface.
FlowNodeSelector class.
FlowNodeVisualization class.
FlowNodeVisualizationInterface interface.
Enumeration of two-phase flow patterns in pipes.
Utility class for detecting flow patterns in two-phase pipe flow.
Enumeration of flow pattern prediction models for two-phase pipe flow.
Adjuster class.
FlowRegimeDetector class.
Mechanistic flow regime detector based on Taitel-Dukler and Barnea models.
Flow regime detection method.
Flow regime enumeration.
FlowSetter class.
Abstract FlowSolver class.
FlowSolverInterface interface.
Abstract FlowSystem class.
FlowSystemInterface interface.
FlowSystemVisualization class.
FlowSystemVisualizationInterface interface.
Fluid class.
Abstract FluidBoundary class.
FluidBoundaryInterface interface.
FluidBoundaryNode class.
FluidBoundaryNodeInterface interface.
FluidBoundaryNodeNonReactive class.
FluidBoundaryNodeReactive class.
FluidBoundaryReactiveSolver class.
FluidBoundarySolver class.
FluidBoundarySolverInterface interface.
FluidBoundarySystem class.
FluidBoundarySystemInterface interface.
FluidBoundarySystemNonReactive class.
FluidBoundarySystemReactive class.
Utility class for classifying reservoir fluids based on phase behavior characteristics.
Fluid class.
Used to generate fluids of type SystemInterface.
fluidMech class.
Fluid class.
FluidSevereSlug class.
Flux limiter functions for TVD (Total Variation Diminishing) advection schemes.
Example demonstrating a production network with four wells routing to HP/LP manifolds.
FreezeOut class.
freezingPointTemperatureFlash class.
freezingPointTemperatureFlashOld class.
freezingPointTemperatureFlashTR class.
Utility class for calculating friction factors in pipe flow.
Implementation of the friction-theory viscosity model of Quiñones-Cisneros and
Firoozabadi for mixtures.
FuelCell class representing a simple hydrogen fuel cell.
Container for Jacobian matrix of fugacity coefficients.
FugTestConstP class.
FunctionInterface interface.
FunctionJohanSverderup class.
FurnaceBurner mixes a fuel gas stream with combustion air and evaluates combustion using the
GibbsReactor.Burner design options controlling how the energy balance is handled.
FurnaceBurnerResponse class.
FurstElectrolyteConstants class.
GasChromotograpyhBase class.
Gas Detector instrument for detecting combustible or toxic gases.
Enumeration of gas detector types.
Gas lift design and optimization calculator.
Gas lift calculation result.
Performance curve point.
Gas lift valve position.
Multi-well gas lift optimization for optimal gas allocation.
Complete optimization result.
Optimization method.
Well performance curve representation.
Allocation result for a single well.
Well data for optimization.
GasPhysicalProperties class.
GasPhysicalPropertyMethod class.
GasScrubber class.
GasScrubberDesignStandard class.
GasScrubberMechanicalDesign class.
GasScrubberSimple class.
GasTurbine class.
Generic tax model implementation driven by FiscalParameters.
Geometry calculations for stratified two-phase flow in circular pipes.
Result container for stratified flow geometry calculations.
Abstract GeometryDefinition class.
GeometryDefinitionInterface interface.
GERG2004EOS class.
GERG2008 class.
GERG-2008-H2 class.
Enumeration of GERG-2008 model variants.
Gibbs reactor for chemical equilibrium calculations using Gibbs free energy minimization.
Reactor energy mode: isothermal (constant temperature) or adiabatic (no heat exchange).
A specialized Gibbs reactor for CO2/acid gas equilibrium calculations.
GlycolDehydrationlModule class.
GlycolPhysicalProperties class.
GOR class.
GORfitter class.
graph2b class.
GTSurfaceTension class.
GTSurfaceTensionFullGT class.
GTSurfaceTensionODE class.
GTSurfaceTensionSimple class.
GTSurfaceTensionUtils class.
Gymnasium (OpenAI Gym) compatible environment interface for NeqSim.
Reset result matching Gymnasium API.
Step result matching Gymnasium API.
Hayduk-Minhas diffusivity model for liquid hydrocarbon systems.
Solvent type enumeration.
HCdewPointPressureFlash class.
Heater class.
HeaterInterface interface.
HeaterResponse class.
HeatExchanger class.
Builder class for constructing HeatExchanger instances with a fluent API.
HeatExchangerInterface interface.
Mechanical design for a generic heat exchanger.
Ranking metric for automatic exchanger-type selection.
Response class for heat exchanger mechanical design JSON export.
Result structure capturing calculated geometry and performance indicators for a candidate heat
exchanger type.
Builder for
HeatExchangerSizingResult.Catalogue of supported heat-exchanger configurations and their typical design data.
Utility class for calculating heat transfer coefficients in two-phase pipe flow.
High-pressure corrected diffusivity model for liquid systems.
Example demonstrating HIPPS (High Integrity Pressure Protection System) implementation.
High Integrity Pressure Protection System (HIPPS) Logic.
High Integrity Pressure Protection System (HIPPS) Valve.
Voting logic options for redundant pressure transmitters.
Example demonstrating HIPPS (High Integrity Pressure Protection System) with ESD escalation.
Represents an existing host facility with available capacity for tie-backs.
Builder for HostFacility.
Type of host facility.
HPTphaseEnvelope class.
Utility class for common humid air calculations.
HVmixingRuleInterface interface.
HXResponse class.
Adapter for integrating external ML models with NeqSim hybrid physics simulations.
Strategy for combining physics and ML predictions.
HydrateEquilibriumLine class.
HydrateEquilibriumTemperatureAnalyser class.
HydrateFormationPressureFlash class.
HydrateFormationTemperatureFlash class.
HydrateInhibitorConcentrationFlash class.
HydrateInhibitorwtFlash class.
WaterDewPointAnalyser class.
Hydrocyclone class.
Hydrocyclone for produced water treatment.
Utility class implementing a compact version of the full IAPWS IF97 steam tables.
ImprovedVUflashQfunc class with enhanced numerical stability.
IncompressiblePipeFlow class.
Exports MPC models and configurations in formats compatible with industrial control systems.
Infrastructure and distances input for field concept definition.
Builder for InfrastructureInput.
Export type.
Power supply option.
Processing location type.
Enumeration of initiating events for safety scenarios.
Injection strategy for reservoir pressure maintenance.
Result container for injection calculations.
Strategy types.
Injection well performance model for water and gas injection.
Pattern class for configuring multiple injection wells.
Pattern type.
Injection well types.
Injection well calculation result.
Comprehensive example demonstrating integrated safety systems including:
Emergency Shutdown (ESD) System with SIL-2 implementation
High Integrity Pressure Protection System (HIPPS) with SIL-3
Pressure Safety Valve (PSV) as final protection layer
Blowdown system with flow control
Flare system with heat radiation monitoring
Multiple pressure and temperature transmitters
Fire detection system
Various process scenarios (normal, overpressure, fire, HIPPS activation)
ESD controller implementing SIL-2 logic.
Fire detection system.
HIPPS controller implementing SIL-3 logic.
Advanced example demonstrating integrated safety systems using the NeqSim process logic framework
and scenario simulation capabilities.
Custom action to close a throttling valve.
Custom HIPPS logic implementing SIL-3 with 2oo2 voting.
Scenario runner with process logic integration.
Custom action to set separator mode.
InterfaceProperties class.
Utility class for calculating interfacial area per unit volume in two-phase flow.
Enum for selecting interfacial area models in two-phase pipe flow simulations.
Enumeration of interfacial area calculation models for two-phase flow.
Interfacial friction correlations for two-fluid multiphase pipe flow.
Result container for interfacial friction calculations.
InterphaseAnnularFlow class for annular two-phase pipe flow.
InterphaseDropletFlow class for droplet/mist and bubble flow regimes.
InterphaseOnePhase class.
InterphasePackedBed class.
InterphasePipeFlow class.
InterphasePropertiesInterface interface.
InterphaseReactorFlow class.
InterphaseSlugFlow class.
InterphaseStirredCellFlow class.
InterphaseStratifiedFlow class for stratified two-phase pipe flow.
InterphaseTransportCoefficientBaseClass class.
InterphaseTransportCoefficientInterface interface.
InterphaseTwoPhase class.
InterphaseTwoPhasePipeFlow class.
InvalidInputException class.
InvalidOutputException class.
Ion parameters from the Maribo-Mogensen PhD thesis (Tables 6.6, 6.11).
Data class to hold ion parameters (for water as default solvent).
Data class to hold solvent-specific ion interaction parameters.
IronIonSaturationStream class.
IsNaNException class.
JointEfficiencyPipelineStandard class.
JointEfficiencyPlateStandard class.
Kinetics class.
Dashboard for comparing KPIs across multiple scenarios.
KrishnaStandartFilmModel class.
KTAViscosityMethod class.
KTAViscosityMethodMod class.
LBCViscosityMethod class.
The Leachman class provides methods to calculate the density, pressure, and various thermodynamic
properties of hydrogen using the Leachman method.
Calculates source terms for leak and rupture release scenarios.
Builder for LeakModel.
Lee-Gonzalez-Eakin gas viscosity correlation (1966).
LengthUnit class.
Level control valve (LCV) for automatic level regulation in vessels.
Control action enumeration.
LevelTransmitter class.
LevenbergMarquardt class.
LevenbergMarquardtAbsDev class.
LevenbergMarquardtBiasDev class.
LevenbergMarquardtFunction class.
LGTSurfaceTension class.
Represents a valve with a linear flow characteristic.
Result of a linearization operation containing the gain matrix and metadata.
LinearProgrammingChemicalEquilibrium class.
Tracks liquid accumulation in low points and riser bases.
Represents a liquid accumulation zone.
Slug characteristics for terrain-induced slugs.
LiquidPhysicalProperties class.
LiquidPhysicalPropertyMethod class.
LNGship class.
Represents an action that can be executed as part of process logic.
Interface for defining conditions that must be met for logic to proceed.
Represents the execution state of process logic.
LumpingModel class.
LumpingModelInterface interface.
Manifold class.
ManifoldResponse class provides basic reporting for a manifold unit.
Represents a manipulated variable (MV) in an MPC formulation.
ManwaySection class.
Utility class for calculating mass transfer coefficients in two-phase pipe flow.
Enum for selecting mass transfer models in two-phase pipe flow simulations.
Represents a single material layer in a pipe wall or vessel wall.
MaterialPipeDesignStandard class.
MaterialPlateDesignStandard class.
Base implementation for measurement devices supplying values to controllers
and process equipment.
MeasurementDeviceInterface interface.
MechanicalDesign class.
Data source used to supply mechanical design limits for process equipment.
Result object describing operating margins relative to design limits.
Generates comprehensive mechanical design reports for a process system.
Response class for mechanical design JSON export.
Summary of individual equipment for system-level reports.
MechManwaySection class.
MechNozzleSection class.
MechVaneSection class.
MecMeshSection class.
MEGReclaimerModule class.
Simple membrane separation unit with one inlet stream and two outlet streams (retentate and
permeate).
MeshSection class.
methaneBWR32 class.
MethaneViscosityMethod class.
Mixer class.
MixerGasProcessingModule class.
Interface for processEquipment with multiple inlet streams and a single outlet stream.
MixerResponse class provides basic reporting for a mixer unit.
Abstract MixingRuleHandler class.
MixingRulesInterface interface.
Dummy Interface to allow Phase object to keep either CPA or EosMixingRuleType.
Interface for integrating machine learning corrections with physics-based models.
Minimum Miscibility Pressure (MMP) Calculator.
Method for MMP calculation.
Miscibility mechanism type.
Metadata for tracking the lifecycle of a process model (digital twin).
Calibration status of the model.
Lifecycle phases for a process model.
Record of a model modification.
Record of a validation event.
General-purpose model predictive controller (MPC) for NeqSim process equipment.
Configuration options for the MPC auto-tuning routine.
Builder for
ModelPredictiveController.AutoTuneConfiguration objects.Result produced by the auto-tuning routine.
Result from the moving horizon estimation routine.
Representation of a quality constraint handled by the MPC.
Builder for
ModelPredictiveController.QualityConstraint instances.Represents a valve with a modified parabolic (or parabolic) flow characteristic.
Base interface for module contracts.
ModuleInterface interface.
MolarMassAnalyser class.
MoleFractionControllerUtil class.
Monte Carlo simulation runner for uncertainty quantification in field development.
Probability distribution types supported by the Monte Carlo runner.
Results from a single Monte Carlo iteration.
Definition of an uncertain variable.
MonteCarloSimulation class.
Base class for MPC variables (manipulated, controlled, or disturbance).
Enumeration of MPC variable types.
GORfitter class.
MPMResponse class.
Multi-agent environment for coordinated process control.
Coordination mode for multi-agent systems.
Step result for multi-agent environment.
Integrates field development with multiphase pipeline hydraulics.
Flow regime classification.
Pipeline hydraulics result.
Abstract MultiPhaseFlowNode class.
MultiPhaseMeter class.
Multi-stage separator test simulation for PVT analysis.
Result of separator optimization.
Separator stage definition.
Results from a single separator stage.
MultiStreamHeatExchanger class.
MultiStreamHeatExchanger2 class.
HXResponse class.
MultiStreamHeatExchangerInterface interface.
HeaterResponse class.
MUSCL (Monotone Upstream-centered Schemes for Conservation Laws) reconstruction.
Reconstructed values at a cell interface.
Available slope limiter types.
MuznyModViscosityMethod class.
MuznyViscosityMethod implements the viscosity calculation for pure hydrogen using the model
proposed by Muzny et al.
Abstract class for named objects.
NamedInterface interface.
NaturalGasPhysicalProperties class.
NeqGasScrubber class.
NeqHeater class.
NeqSimAGA8Detail class.
NeqSimBlobDatabase class.
NeqSimProcessDesignDataBase class.
NeqSimDataBase class.
Wrapper for calling the EOS-CG multi-fluid model using the GERG-2008 API.
NeqSimExperimentDatabase class.
NeqSimFluidDataBase class.
NeqSimGERG2008 class.
NeqSimLeachman class.
NeqSimLogging class.
NeqSimProcessDesignDataBase class.
Utility class implementing the Span–Wagner reference equation of state for carbon dioxide.
Holder for Helmholtz energy derivatives.
A global thread pool for NeqSim concurrent operations.
NeqSimUnit class.
NeqSimUnitSet class.
NeqSimVega class.
NeqSimXtream class for serializing and deserializing NeqSim objects.
NeqStream class.
Result container for network solver.
Production network solver for multi-well gathering systems.
Solution mode for the network.
Well node in the network.
newtonRhapson class.
NewtonSolveAB class.
NewtonSolveABCD class.
NewtonSolveCDplus class.
NMVOCAnalyser class.
Abstract NonEquilibriumFluidBoundary class.
Performs multi-step ahead prediction using full NeqSim nonlinear simulation.
Represents a trajectory of MV values over time.
Result of a prediction containing CV and MV trajectories.
Norwegian Continental Shelf petroleum tax model.
Immutable result of a tax calculation.
NotImplementedException class.
NotInitializedException class.
NozzleSection class.
NumericalDerivative class.
NumericalDerivative class.
NumericalIntegration class.
Utility for characterising an oil system from assay information.
OilLevelTransmitter class for measuring oil level in three-phase separators.
OLGApropertyTableGenerator class.
OLGApropertyTableGeneratorKeywordFormat class.
OLGApropertyTableGeneratorWater class.
OLGApropertyTableGeneratorWaterEven class.
OLGApropertyTableGeneratorWaterKeywordFormat class.
OLGApropertyTableGeneratorWaterStudents class.
OLGApropertyTableGeneratorWaterStudentsPH class.
OnePhaseFixedStaggeredGrid class.
Abstract onePhaseFlowNode class.
OnePhaseFlowNodeVisualization class.
Abstract OnePhaseFlowSolver class.
Abstract OnePhaseFlowSystem class.
OnePhaseFlowVisualization class.
onePhasePipeFlowNode class.
OnePhasePipeFlowNodeVisualization class.
OnePhasePipeFlowSolver class.
One-phase pipeline with compositional tracking support.
Online calibrator for continuously updating model parameters based on real-time data.
Represents a data point for calibration.
OnlineSignal class.
Action to fully open a valve (100% opening).
OperationInterface interface.
OptimizedVUflash class with enhanced performance for transient separator simulations.
Orifice class for flow restriction and measurement using ISO 5167 orifice plate calculations.
PackedSection class.
Packing class.
PackingInterface interface.
PallRingPacking class.
ParachorFunction class.
ParachorSurfaceTension class.
Executes multiple actions in parallel and tracks completion.
Pedersen's method for asphaltene precipitation using classical cubic equation of state.
PedersenPlusModelSolver class.
PFCTConductivityMethodMod86 class extending conductivity for commonphase.
PFCTViscosityMethod class.
PFCTViscosityMethodHeavyOil class.
PFCTViscosityMethodMod86 class.
Layout intelligence layer for generating professional oil & gas PFDs.
Vertical phase zone for gravity-based positioning.
Horizontal process position for left-to-right flow convention.
Separator outlet type for proper positioning.
Stream phase classification based on vapor/liquid fraction.
Abstract Phase class.
Phase implementation for the Ammonia2023 reference equation of state based on a multiparameter
Helmholtz energy formulation.
Phase implementation using the Burgoyne–Nielsen–Stanko PR correlation.
PhaseBWRSEos class.
PhaseCPAInterface interface.
PhaseCSPsrkEos class.
PhaseDefault class.
PhaseDesmukhMather class.
PhaseDuanSun class.
PhaseElectrolyteCPA class.
Electrolyte CPA (e-CPA) phase class implementing the Maribo-Mogensen model.
Dielectric constant mixing rule options for mixed solvents.
PhaseElectrolyteCPAOld class.
PhaseElectrolyteCPAstatoil class.
Abstract class PhaseEos.
Phase implementation using the EOS-CG mixture model.
PhaseEosInterface interface.
Abstract class PhaseGE.
PhaseGEInterface interface.
PhaseGENRTL class.
PhaseGENRTLmodifiedHV class.
PhaseGENRTLmodifiedWS class.
PhaseGERG2004Eos class.
PhaseGERG2008Eos class.
PhaseGEUnifac class.
PhaseGEUnifacPSRK class.
PhaseGEUnifacUMRPRU class.
PhaseGEUniquac class.
PhaseGEUniquacmodifiedHV class.
PhaseGEWilson class.
PhaseHydrate class.
Phase model for an ideal gas.
PhaseInterface interface.
PhaseKentEisenberg class.
PhaseLeachmanEos class.
PhaseModifiedFurstElectrolyteEos class.
Enum for selecting dielectric constant mixing rules for mixed solvents.
PhaseModifiedFurstElectrolyteEosMod2004 class.
PhasePCSAFT class.
PhasePCSAFTa class.
PhasePCSAFTRahmat class.
Phase implementation for the Pitzer activity coefficient model.
PhasePrCPA class.
PhasePrEos class.
PhasePrEosvolcor class.
PhasePureComponentSolid class.
PhaseRK class.
Abstract PhaseSolid class.
PhaseSolidComplex class.
PhaseSoreideWhitson implements the Søreide-Whitson Peng-Robinson EoS with modified alpha and
mixing rule.
Phase implementation using the Span-Wagner reference equation for CO2.
PhaseSrkCPA class.
PhaseSrkCPAs class.
PhaseSrkEos class.
PhasePrEosvolcor class.
PhaseSrkPenelouxEos class.
PhaseTSTEos class.
Types of phases.
PhaseSrkCPA class.
PhaseVegaEos class.
Phase implementation using the IAPWS-IF97 reference equations for pure water.
PhaseWax class.
PHflash class.
PHflashGERG2008 class.
PHflashLeachman class.
PHflashSingleComp class.
PHflashVega class.
pHProbe class.
PHsolidFlash class.
Abstract PhysicalProperties class.
PhysicalPropertyHandler class.
Abstract PhysicalPropertyMethod class.
PhysicalPropertyMethodInterface interface.
PhysicalPropertyMixingRule class.
PhysicalPropertyMixingRuleInterface interface.
Types of PhysicalPropertyModel, relating to different kind of phaseTypes.
Types of PhysicalProperties, e.g. mass density, dynamic viscosity, thermal conductivity.
Validates AI-proposed actions against physics constraints.
Base interface for constraints.
Internal result of checking a single constraint.
Details of a constraint violation.
Constraint on specific equipment.
Constraint on physical bounds (e.g., positive temperature).
Result of a validation check.
PID controller for setpoint tracking with integral and derivative action.
Pipe class.
Pipeline simulation using Beggs and Brill empirical correlations for multiphase flow.
Calculation modes for pipeline simulation.
Flow regimes available in Beggs and Brill correlations.
Heat transfer calculation modes for pipeline thermal modeling.
PumpResponse class.
Represents the geometry data for a pipe including diameter, wall structure, and surroundings.
PipeDesign class.
A simple holder for arrays describing a pipe schedule: nps, inner diameters, outer diameters,
thicknesses.
Holds the arrays for a particular wire schedule.
Network of pipelines connected through manifolds using compositional PipeFlowSystem.
Represents a manifold node in the network.
Represents a pipeline segment in the network.
Container class for two-phase pipe flow simulation results.
Builder class for creating PipeFlowResult instances.
PipeFlowSystem class.
PipeFlowVisualization class.
PipeLeg class.
Pipeline class.
PipelineDesignStandard class.
PipeLineInterface interface.
PipelineMechanicalDesign class.
PipelineResponse class for JSON serialization of Pipeline equipment.
Enumeration of common pipe wall materials with their thermal properties.
Represents the state of a single section/cell in the multiphase pipe.
Flow regimes for two-phase pipe flow.
Represents the surrounding environment of a pipe including special cases like buried pipes.
Environment types for pipe surroundings.
Represents a cylindrical pipe wall with multiple material layers.
Builder class for creating common pipe wall configurations.
PipingDesignStandard class.
pLoadingCurve class.
pLoadingCurve2 class.
PlusCharacterize class.
PlusFractionModel class.
PlusFractionModelInterface interface.
Multi-field portfolio optimizer for capital-constrained investment decisions.
Optimization strategy.
Portfolio optimization result.
Single project in the portfolio.
Project type classification.
PotentialTheoryAdsorption class.
PowerUnit class for converting between different power units.
Represents the result of a look-ahead prediction for advisory systems.
A predicted constraint violation.
Severity levels for violations.
A predicted value with uncertainty bounds.
Status of the prediction calculation.
Condition that checks if pressure meets a specified criteria.
Process logic for automatic pressure control via valve throttling.
Pressure control valve (PCV) for automatic pressure regulation.
Control mode enumeration.
PressureDrop class.
PressureTransmitter class.
PressureUnit class.
PressureVesselDesignStandard class.
Base class for process equipment control agents.
Coordinates alarm evaluation across all measurement devices in a process system.
Implementation of StreamingDataInterface for publishing process simulation data.
Represents the difference between two process snapshots.
Efficient derivative calculator for NeqSim process simulations.
Derivative calculation methods.
Result container for derivative calculations with error estimates.
Specification for an input or output variable.
Variable types for optimal step size calculation.
Exports ProcessSystem as professional oil & gas style process flow diagrams.
Represents a directed edge in the process flowsheet graph.
Edge types representing different connection types in process flowsheets.
Abstract ProcessEquipmentBaseClass class.
ProcessEquipmentInterface interface.
Represents an event in the process simulation.
Event types.
Event severity levels.
Event bus for publishing and subscribing to process events.
Listener interface for process events.
Represents a process flowsheet as an explicit directed graph (DAG with potential cycles).
Result of cycle detection analysis.
Result of parallel execution partitioning.
Result of strongly connected component analysis.
Result of sensitivity analysis for tear stream selection.
Result of tear stream selection analysis.
Builder class for constructing a
ProcessGraph from a ProcessSystem.Estimates interconnecting piping weight and material for a process system.
Represents a pipe segment between two equipment items.
Computes linearized process models from NeqSim ProcessSystem using finite differences.
Bridge class that auto-configures and links MPC to a ProcessSystem.
The ProcessLoader class is responsible for loading process configurations from a YAML file and
initializing the process system with the specified units and their properties.
Base interface for all process logic implementations.
Complete integrated example demonstrating alarm-triggered process logic.
Container for instrumentation setup.
Container for process logic setup.
Enhanced integrated safety system example using the complete NeqSim process logic framework.
Example: Custom logic class for gradual pressure reduction.
Container for instrumentation setup.
Container for process logic setup.
ProcessModel class.
Represents a hierarchical process model as a graph of graphs.
Represents a connection between two sub-systems.
Represents a partition of sub-systems into levels for parallel execution.
Represents a sub-system (ProcessSystem) within the model.
Builder class for constructing a
ProcessModelGraph from a ProcessModule.Represents a serializable state snapshot of a ProcessModel containing multiple ProcessSystems.
Execution configuration for ProcessModel.
Instant type adapter for Gson.
Represents a connection between two ProcessSystems.
Validation result for ProcessModelState.
A class representing a process module class that can contain unit operations and other modules.
Abstract ProcessModuleBaseClass class.
Represents a node in the process flowsheet graph.
Summary of a
ProcessSafetyScenario evaluation.Snapshot of key KPIs for a unit.
High level helper coordinating load case evaluation for disposal networks.
Describes a simultaneous relief load case generated by the process safety analyser.
Relief load contribution for a source into the disposal network.
Immutable value object containing all information gathered by the
ProcessSafetyReportBuilder.Represents a single condition monitoring finding.
Summary of a relief valve evaluation.
Captures the pressure margin for an equipment item.
Snapshot of aggregated system KPIs.
Builder that collects safety information for a
ProcessSystem.Optional persistence contract for safety analysis results.
Immutable description of a process safety scenario.
Builder for
ProcessSafetyScenario.Configuration object containing threshold values that drive severity grading for safety
reporting.
Utility class for running process scenarios with integrated logic execution.
Comprehensive sensitivity analyzer for process simulations.
Specification of a variable (equipment + property).
Objective function that bridges process simulation with the Levenberg-Marquardt optimizer.
Represents a snapshot of a process system state at a point in time.
Represents a process system containing unit operations.
Inner class to hold mass balance results.
Contract for process systems (flowsheets).
Helper responsible for exporting
ProcessSystem connectivity to Graphviz.Builder for
ProcessSystemGraphvizExporter.GraphvizExportOptions.Placement of the optional stream property table.
Represents a serializable state snapshot of a ProcessSystem for lifecycle management.
Represents a connection between two pieces of equipment.
Represents the state of a single piece of equipment.
Represents the thermodynamic state of a fluid.
Gson adapter for Instant serialization.
Result of state validation.
Accessor for reading and writing process variables by path.
Produced water treatment train for offshore oil and gas facilities.
Treatment stage type enumeration.
Water treatment stage model.
Production allocation and metering calculations.
Metering technology types with typical uncertainties.
Production source with metering information.
Loader for lightweight YAML/JSON optimization specs that map onto scenarios.
Constraint representation inside the spec.
Objective representation inside the spec.
Scenario configuration from YAML.
Spec root.
Variable representation for manipulating streams.
Utility class for production optimization based on capacity utilization and configurable
constraints.
Function to compute capacity duty/limit for a specific equipment.
Range container to support percentile-based capacity evaluations.
Pair of capacity duty/max providers.
Direction of a constraint comparison.
Severity classification for constraints.
Outcome for a single constraint evaluation.
Constraint template applied to each matching equipment.
Metric to evaluate per-equipment constraints.
Result of a single iteration.
Snapshot of each iteration to support diagnostics and plotting.
Definition of a manipulated decision variable.
Objective optimization direction.
Builder-style configuration for the optimizer.
Simple container for constraint configuration.
Simple container for objective configuration.
Result container for a completed optimization attempt.
Lightweight summary of an optimization run intended for quick-consumption APIs.
Per-scenario KPI values and deltas versus the baseline scenario.
Definition of a KPI to report alongside scenario comparisons.
Scenario definition to enable side-by-side optimization comparisons.
Optimization result paired with a scenario name to aid reporting/comparison.
Supported search algorithms.
Holds the utilization status for an equipment item.
Series-friendly representation of utilization across iterations for plotting/reporting.
Models production decline curves and plateau rates for field development planning.
Container for decline curve parameters.
Decline curve model types based on Arps equations.
Complete production forecast with plateau and decline phases.
Production forecast result at a single time point.
Generates production decline profiles using Arps decline curve analysis.
Decline curve type enumeration.
PropaneCoolingModule class.
PropertyGenerator class.
Container for gradients of a scalar thermodynamic property with respect to state variables.
Proportional (P) controller for single setpoint tracking.
Process Shutdown (PSD) Valve that automatically closes on High-High Alarm (PAHH).
Utility class for combining and re-characterizing fluids containing pseudo components.
PSFlash class.
PSFlashGERG2008 class.
PSFlashLeachman class.
PSflashSingleComp class.
PSFlashVega class.
pTphaseEnvelope class.
pTphaseEnvelope1 class.
pTphaseEnvelopeMay class.
pTphaseEnvelopeNew class.
pTphaseEnvelopeNew2 class.
PTphaseEnvelopeNew3 class.
PUflash class.
Centrifugal pump simulation model for process systems.
Pump performance curve handler for centrifugal pump simulation.
CompressorChartAlternativeMapLookupExtrapolate class.
PumpChartInterface interface.
PumpCurve class.
PumpInterface interface.
Mechanical design calculations for centrifugal pumps per API 610.
Pump type classification per API 610.
Seal type classification.
Response class for pump mechanical design JSON export.
PumpResponse class.
Push Button instrument for manual activation of equipment (e.g., ESD blowdown valves) and process
logic sequences.
Pressure-Volume (PV) flash calculation.
PVrefluxflash class.
PVT Regression Framework for automatic EOS model tuning.
Objective function for PVT regression using Levenberg-Marquardt optimization.
PVT Report Generator for creating industry-standard PVT reports.
Lab data point for comparison.
QfuncFlash class.
Represents a valve with a quick opening flow characteristic.
RachfordRice classes.
RachigRingPacking class.
Random controller for baseline comparison.
RateUnit class.
Ratio control structure adjusting a controller set-point such that the controlled variable
maintains a specified ratio to a reference measurement.
Abstract ReactiveFluidBoundary class.
ReactiveKrishnaStandartFilmModel class.
ReactorData class.
Reboiler class.
ReBoiler class.
Recombine class.
Recycle class for handling tear streams in process simulations.
RecycleController class for managing multiple recycle streams in process simulations.
RecycleResponse class provides basic reporting for a recycle unit.
ReferencePotComparator class.
Regional cost adjustment factors for field development economics.
Enumeration of regression parameters for PVT model tuning.
Configuration for a regression parameter including bounds and initial guess.
Result of a PVT regression optimization.
Enumeration of release orientations for leak and rupture scenarios.
Dynamic relief valve (PSV) sizing for fire scenarios per API 521.
Result container for PSV sizing calculations.
Report class.
Configuration options for JSON reporting.
Level of detail to include in reports.
RepulsiveTermInterface interface.
Exports time-series data for reservoir simulator coupling (E300/ECLIPSE).
Export format type.
Schedule keyword entry.
VFP table data structure.
ReservoirCVDsim class.
ReservoirDiffLibsim class.
Enumeration of reservoir fluid types based on Whitson classification.
Reservoir fluid and conditions input for field concept definition.
Builder for ReservoirInput.
Common fluid type classifications.
ReservoirTPsim class.
Represents a risk event for probabilistic safety analysis.
Builder class for RiskEvent.
Consequence severity categories per industry standards.
Probabilistic risk model for process safety analysis.
Builder class for RiskModel.
Container for probabilistic risk analysis results.
Results for a single risk event.
Reinforcement Learning environment wrapper for NeqSim process systems.
Additional info from a step.
Result of a simulation step.
RuptureDisk class - represents a rupture disk (bursting disc) safety device.
Spline based representation of the stone wall curve with safe extrapolation.
Spline based implementation of the surge curve with safe extrapolation.
Container for safety envelope data points.
Types of safety envelopes.
Calculator for generating safety envelopes from fluid properties.
Safety Instrumented Function (SIF) implementing fire and gas detection with voting logic.
Safety/Relief Valve built on top of ThrottlingValve.
Results from safety screening.
Builder for SafetyReport.
Safety classification levels.
Safety screener for rapid assessment of safety-related design requirements.
SafetyValve class.
Supported fluid service categories used for selecting the sizing strategy.
Immutable description of a relieving scenario.
Builder for
SafetyValve.RelievingScenario.Available sizing standards for the relieving calculations.
Mechanical design for safety valves based on API 520 gas sizing.
Lightweight reporting view for consumption by analysis tools.
Detailed sizing outcome for a single scenario.
Container holding data shared with the sizing strategies.
WaterPhysicalProperties class.
SampleCreator class.
SampleSet class.
SampleValue class.
A dummy data source for an XY plot.
SaturateWithWater class.
SaturationPressure class.
Saturation pressure (bubble point) correlations per Whitson wiki methodology.
SaturationPressureFunction class.
SaturationPressure class.
ScalePotentialCheckStream class.
Scenario analyzer for production scheduling and what-if analysis.
Parameters for a scenario.
Result from a single scenario run.
Summary of scenario execution results.
Result of a logic sequence execution.
Key Performance Indicators for scenario execution.
Builder for ScenarioKPI.
Utility class for running and managing multiple test scenarios with automatic KPI collection.
Internal configuration class for batch scenario execution.
Example demonstrating selective logic execution in ProcessScenarioRunner.
Monte Carlo sensitivity analysis for field development uncertainty quantification.
Probability distribution types for uncertain parameters.
Complete Monte Carlo analysis result.
Configuration for sensitivity analysis.
Spider plot data point.
Single Monte Carlo trial result.
Uncertain parameter definition.
Sensitivity and uncertainty analysis for field development economics.
Result of breakeven analysis.
Result of Monte Carlo analysis.
Functional interface for setting parameters.
Result of scenario analysis.
Single item in tornado analysis.
Result of tornado (sensitivity) analysis.
Represents a sensitivity matrix for uncertainty propagation in process simulations.
Container for sensitivity analysis results.
SeparationTrainModule class.
SeparationTrainModuleSimple class.
Separator class.
Builder class for constructing Separator instances with a fluent API.
RL agent for separator level and pressure control.
Multi-agent example: Separator + Compressor train.
Contract for separator equipment.
SeparatorCostEstimate class.
Data point for separator test experiment.
SeparatorDesignStandard class.
Example combining separator depressurization to a flare with fire heat load and integrity checks.
Convenience wrapper that wires separator geometry and process conditions into the fire
calculators so they can be used directly from NeqSim process simulations.
Result bundle that exposes all fire-related calculations for a separator timestep.
Fire scenario configuration with sensible defaults so callers only override what they need.
Gymnasium-compatible separator control environment.
Example demonstrating separator heat input capabilities with flare integration.
SeparatorInterface interface.
Example RL environment for separator level control.
SeparatorMechanicalDesign class.
Response class for separator mechanical design JSON export.
SeparatorResponse class.
SeparatorSection class.
Separator sizing calculator aligned with TPG4230 course material.
Design standard to apply.
Result container for separator sizing calculations.
Separator orientation type.
SeparatorTest class.
SepDesignSection class.
SerializationManager class.
SetPoint class.
Action to set separator calculation mode (steady-state vs transient).
Action to set splitter split factors.
Setter class.
Action to set valve opening percentage.
SevereSlugAnalyser class.
Represents the severity level of a deviation detected in a safety report.
Shutdown logic with controlled ramp-down of equipment.
Internal class to store an action with its delay.
Defines a shutdown profile for compressor shutdown sequences.
Inner class representing a point in the shutdown profile.
Enum for shutdown types.
SiddiqiLucasMethod class.
SimpleAbsorber class.
SimpleAdsorber class.
SimpleFlowLine class.
SimpleReservoir class.
SimpleTEGAbsorber class.
SimpleTPoutPipeline class.
SimpleTray class.
Base class for process simulation objects.
Interface for simulation objects.
SimulationInterface interface.
AI-friendly validation helper for NeqSim simulations.
SlimTubeSim class.
SlugFlowNode class.
Tracks individual slugs through the pipeline.
Represents a single slug unit (liquid slug + Taylor bubble).
Soft sensor for calculating derived properties from primary measurements and thermodynamic
models.
Types of properties that can be estimated.
Exports soft-sensor and estimator configurations for integration with external calculation
engines.
Soft-sensor types.
Definition of a soft-sensor.
Simple solar panel model converting solar irradiance to electrical power.
SolidComplexTemperatureCalc class.
SolidFlash class.
SolidFlash1 class.
SolidFlash12 class.
SolidPhysicalProperties class.
SolidPhysicalPropertyMethod class.
SolutionGasWaterRatio class.
Calculation method for Rsw.
Container for time-series release source term data.
Splitter class.
SplitterInterface interface.
SplitterResponse class provides basic reporting for a splitter unit.
Abstract Standard class.
Standard_ASTM_D6377 class.
Standard_ISO15403 class.
Standard_ISO6578 class.
Standard_ISO6974 class.
Standard_ISO6976 class.
Standard_ISO6976_2016 class.
Loads mechanical design limits from CSV files with support for international standards.
Column index mapper.
Internal data structure for parsed rows.
StandardInterface interface.
Registry and factory for creating design standards based on international standards.
Enumeration of supported international and industry design standards for mechanical design.
Startup logic with permissive checks and sequential action execution.
Internal class to store an action with its delay.
Defines a startup profile for compressor startup sequences.
Inner class representing a point in the startup profile.
States of matter, a way of relating the PhaseTypes to classical states of matter.
Exports process models in state-space form for use with external MPC solvers.
Represents a discrete-time state-space model.
Represents a state variable (SVR) in a nonlinear MPC system.
Standardized state vector for physics-grounded world models and RL integration.
Interface for process equipment that can export standardized state vectors.
StaticMixer class.
StaticNeqMixer class.
StaticPhaseMixer class.
Abstract StatisticsBaseClass class.
StatisticsInterface interface.
Heater for process streams using condensing steam as heating medium.
Represents a step response from a single input to a single output.
Generates step response models by running NeqSim simulations.
Matrix container for step responses from all MV-CV pairs.
StirredCell class.
StirredCellNode class.
StirredCellSolver class.
StirredCellSystem class.
StoneWallCurve defines the compressor stone wall (choke) limit.
StratifiedFlowNode class.
Stream class.
Contract for process streams.
Interface for high-frequency real-time data streaming.
StreamInterface interface.
Abstract MeasurementDeviceBaseClass class.
StreamResponse class.
StreamSaturatorUtil class.
StreamTransition class.
Validators for process streams (StreamInterface).
Exports NeqSim process models in SubrModl format for nonlinear MPC integration.
Model parameter definition.
State variable (SVR) definition.
SubrXvr definition for variable linking.
Unified subsea production system for field development workflow integration.
Subsea architecture configuration.
Result container for subsea production system analysis.
SubseaWell class.
SulfurSpecificationMethod class.
SurfaceTension class.
SurfaceTensionInterface interface.
SurgeCurve defines the compressor surge limit.
Registry for managing trained surrogate (machine learning) models.
Metadata for a surrogate model.
Interface for surrogate model implementations.
Internal entry combining model and metadata.
SurroundingEnvironment interface.
SurroundingEnvironmentBaseClass class.
SwellingTest class.
sysNewtonRhapson class.
sysNewtonRhapsonPhaseEnvelope class.
sysNewtonRhapsonPhaseEnvelope2 class.
sysNewtonRhapsonPHflash class.
sysNewtonRhapsonTPflash class.
sysNewtonRhapsonTPflashNew class.
Thermodynamic system using a simplified ammonia reference equation of state.
Lightweight Black-Oil "system/stream" with standard totals and P/T.
Thermodynamic system implementing the Burgoyne–Nielsen–Stanko PR correlation.
This class defines a thermodynamic system using the BWRS equation of state.
This class defines a thermodynamic system using the CSP SRK equation of state.
This class defines a thermodynamic system using the Desmukh Mather thermodynamic model.
This class defines a thermodynamic system using the Duan Sun method used for CO2.
This class defines a thermodynamic system using the Electrolyte CPA EoS of Equinor.
Thermodynamic system class using the Maribo-Mogensen electrolyte CPA (e-CPA) equation of state.
This class defines a thermodynamic system using the electrolyte CPA EoS
Statoil model.
Base class for system with EOS.
Thermodynamic system using the EOS-CG equation of state.
This class defines a thermodynamic system using the electrolyte the Furst Electrolyte Eos.
This class defines a thermodynamic system using the electrolyte the Modified Furst Electrolyte
Eos.
This class defines a thermodynamic system using the GERG2004 equation of state.
This class defines a thermodynamic system using the GERG2008Eos equation of state.
This class defines a thermodynamic system using the GERG water equation of state.
This class defines a thermodynamic system using the Wilson GE model.
Simple thermodynamic system using an ideal gas equation of state.
SystemInterface interface.
This class defines a thermodynamic system using the Kent Eisenberg model.
This class defines a thermodynamic system using the LeachmanEos equation of state.
Provides whole-process mechanical design aggregation and reporting.
Summary of key design data for a single equipment item.
This class defines a thermodynamic system using the SRK EoS for gas and NRTL for liquids.
This class defines a thermodynamic system using the PC-SAFT EoS equation of state.
This class defines a thermodynamic system using the PC-SAFT with association equation of state.
Thermodynamic system using the Pitzer GE model.
This class defines a thermodynamic system using the PR-CPA equation of state.
This class defines a thermodynamic system using the PR Danesh equation of state.
This class defines a thermodynamic system using the Peng–Robinson equation of state
(PR‑EoS).
This class defines a thermodynamic system using the Peng Robinson v. 1978 equation of state
This class defines a thermodynamic system using the PR EoS version of Delft (1998) equation of
state.
This class defines a thermodynamic system using the Peng-Robinson equation of state with volume
correction (Pénéloux shift).
This class defines a thermodynamic system using the PR Gassem equation of state.
This class defines a thermodynamic system using the PR Mathias Copeman equation of state.
Class to get physical properties of system and its phases.
This class defines a thermodynamic system using the Predictive SRK-EoS equation of state.
This class defines a thermodynamic system using the RK equation of state.
This class defines a thermodynamic system using the Søreide-Whitson Peng-Robinson EoS (modified
alpha and mixing rule).
Thermodynamic system using the Span-Wagner reference equation for CO2.
This class defines a thermodynamic system using the CPA EoS equation of state.
This class defines a thermodynamic system using the sCPA-EOS equation of state.
This class defines a thermodynamic system using the CPA-EOS of Equinor equation of state.
This class defines a thermodynamic system using the SRK equation of state.
This class defines a thermodynamic system using the Peng-Robinson equation of state with volume
correction (Pénéloux shift).
This class defines a thermodynamic system using the SRK with Mathias Copeman equation of state.
This class defines a thermodynamic system using the SRK Peneloux equation of state.
This class defines a thermodynamic system using the SRK Schwartzentruber equation of state.
This class defines a thermodynamic system using the SRK Two Coon equation of state.
This class defines a thermodynamic system using the SRK Two Coon Param equation of state.
This class defines a thermodynamic system using the SRK Two Coon model of Statoil equation of
state.
This is the base class of the System classes.
This class defines a thermodynamic system using the TST equation of state.
This class defines a thermodynamic system using the UMR CPA equation of state.
This class defines a thermodynamic system using the UMR-PRU equation of state.
This class defines a thermodynamic system using the UMR-PRU with MC parameters equation of state.
This class defines a thermodynamic system using the UMR-PRU with MC paramters equation of state.
This class defines a thermodynamic system using the Unifac for liquids with SRK equation of state
for gas.
This class defines a thermodynamic system using the UNIFAC for liquid and PSRK EoS for gas.
This class defines a thermodynamic system using the VegaEos equation of state.
Thermodynamic system using the IAPWS-IF97 reference model for water.
A utility class for pretty printing a 2D string table.
Tank class.
Mechanical design calculations for storage tanks per API 650/620.
Roof type for fixed roof tanks.
Tank type classification.
TankResponse class provides a simple example of how to report information from a tank unit
operation.
Interface for country-specific tax model calculations.
Result of a tax calculation.
Registry of tax model parameters for different countries and regions.
TBPCharacterize class.
TBP (True Boiling Point) Fraction Model for petroleum characterization.
TBPModelInterface interface.
TDMAsolve class.
Represents a Technical Requirements Document (TORG) that specifies design standards and methods
to be used in process design for a project.
Builder for TechnicalRequirementsDocument.
Environmental design conditions.
Material specifications.
Safety factors for design calculations.
Condition that checks if temperature meets a specified criteria.
TemperatureTransmitter class.
TemperatureUnit class.
TestChungFit class.
TestFitToOilFieldFluid class.
TestParachorFit class.
TestSaturationPresFunction class.
TestViscosityFit class.
TestWaxTuning class.
TextFile class.
ThermodynamicConstantsInterface interface.
Thermodynamic coupling for the two-fluid transient pipe model.
Result container for thermodynamic property update.
ThermodynamicModelSettings interface.
ThermodynamicModelTest class.
ThermodynamicOperations class.
Definitions of flash types.
Contract for thermodynamic systems.
ThermoException class.
Validators for thermodynamic systems (SystemInterface implementations).
Temperature-Enthalpy (TH) flash calculation.
Conservation equations for three-fluid (gas-oil-water) pipe flow model.
Result container for three-fluid RHS calculation.
Extended section state for three-phase (gas-oil-water) pipe flow.
ThreePhaseSeparator class.
ThreePhaseSeparatorResponse class.
ThrottlingValve class.
Analyzes tie-back options for connecting satellite fields to host facilities.
Screening result for quick tieback evaluation.
Represents a specific tie-back option evaluated by the TiebackAnalyzer.
Report containing tieback analysis results for a discovery.
Time integration methods for the two-fluid transient pipe model.
Integration method type.
Interface for the right-hand side function (spatial discretization).
Condition that becomes true after a specified time delay.
TimeSeries class for managing time-varying boundary conditions in transient pipe flow
simulations.
Enum for outlet boundary condition types.
Exports process simulation data as time series for external ML/AI platforms.
Represents a single time series data point.
Represents a value with an associated timestamp for real-time data streaming.
Quality indicator for the measurement value.
TimeUnit class.
TooManyIterationsException class.
Interface for loading Technical Requirements Documents (TORG) from various data sources.
Manager class for applying Technical Requirements Documents (TORG) to process systems.
TPflash class.
TPflash_benchmark class.
TPflash_benchmark_fullcomp class.
TPflash_benchmark_UMR class.
TPgradientFlash class handles thermodynamic calculations with temperature and pressure gradients.
TPHydrateFlash performs a TP flash that includes hydrate phase equilibrium calculation.
TPmultiflash class.
TPmultiflashWAX class.
Training data collector for surrogate model development.
Feature definition for inputs/outputs.
Running statistics calculator.
Transient multiphase pipe model using drift-flux formulation.
Boundary condition types for inlet and outlet.
Example demonstrating transient heat transfer in PipeBeggsAndBrills.
Transient 1-D heat conduction through vessel walls.
Transient well model with time-dependent IPR.
Boundary type for late-time effects.
Result of buildup calculation.
Result of drawdown calculation.
Transient pressure profile point.
Rate change event for superposition.
Well type.
TrayInterface interface.
Action to trip (de-energize) an ESD valve, causing fail-safe closure.
TSFlash class.
Tubing Performance model for vertical lift performance (VLP) calculations.
TubingPerformance class - Vertical Lift Performance (VLP) model for wellbore tubing.
VLP correlation types.
Available multiphase pressure-drop correlations.
Temperature profile models.
Temperature profile models for wellbore heat transfer.
Temperature-Internal Energy (TU) flash calculation.
TuneToSaturation class.
TuningInterface interface.
TurboExpanderCompressor models a coupled expander and compressor system with design and
performance parameters, polynomial curve fits for efficiency and head, and Newton-Raphson
iteration for speed matching.
TurboExpanderCompressorResponse class.
TVflash class.
TVflash class.
Two-fluid conservation equations for transient multiphase pipe flow.
Two-fluid transient multiphase pipe model.
Boundary condition type.
Insulation type presets with typical U-values.
Extended pipe section state for the two-fluid model.
TwoPhaseFixedStaggeredGridSolver class.
Mass transfer mode for non-equilibrium calculations.
Solver type enum controlling which equations are solved.
Abstract TwoPhaseFlowNode class.
TwoPhaseFlowNodeVisualization class.
Abstract TwoPhaseFlowSystem class.
TwoPhaseFlowVisualization class.
TwoPhasePackedBedFlowNode class.
TwoPhasePipeFlowSolver class.
Non-equilibrium two-phase pipe flow simulation system.
Builder class for creating TwoPhasePipeFlowSystem instances with a fluent API.
TwoPhasePipeFlowSystemReac class.
TwoPhasePipeFlowVisualization class.
TwoPhasePipeLine class.
TwoPhaseReactorFlowSystem class.
TwoPhaseSeparator class.
TwoPhaseTrayTowerFlowNode class.
Abstract class defining ProcessEquipment with one inlet and one outlet.
Interface for processEquipment with a single inlet stream and a single outlet stream.
UKspecifications_ICF_SI class.
Uncertainty analysis results for PVT regression.
Performs uncertainty propagation analysis for process simulations.
Configuration for input variable uncertainty.
Represents uncertainty bounds for a measured or calculated value.
Result of an uncertainty propagation analysis for a process simulation.
UNIFACgroup class.
Unit interface.
UnitCostEstimateBaseClass class.
Units class.
Specification object describing the utility side of a single-stream heater or cooler.
Core framework for validating NeqSim simulations before execution.
Standard error messages for common validation failures.
Composite validation for multiple validatable objects.
Interface for validatable objects (systems, streams, equipment).
Utility for custom validation rules.
Context for validation, allowing cross-object checks.
Validation error with severity and remediation advice.
Result of validation, containing errors, warnings, and readiness status.
Validation warning for potentially problematic but non-blocking issues.
Common validation result container for NeqSim components.
Severity level for validation issues.
A single validation issue.
Unit class nested within Units.
An interface for defining the flow characteristic of a valve.
ValveCostEstimate class.
ValveDesignStandard class.
ValveInterface interface.
ValveMechanicalDesign class provides mechanical design calculations for control valves.
Response class for valve mechanical design JSON export.
Condition that checks valve position/opening percentage.
StreamResponse class.
ValveSection class.
Enumerates the available dynamic travel models that can be applied to valves.
VaneSection class.
Vega class.
VesselDepressurization models dynamic filling and depressurization of pressure vessels.
Calculation type for vessel thermodynamics.
Flow direction.
Heat transfer type for energy balance calculations.
Preset liner materials for Type III/IV composite vessels.
Result object containing simulation history data.
Preset material properties for common vessel constructions.
Vessel orientation.
Calculates internal heat transfer coefficients for vessel filling and depressurization.
Container for complete heat transfer calculation results.
Implements a Scandpower-style thin-wall rupture check using von Mises stress.
Result from a Virtual Flow Meter calculation.
Builder for VFMResult.
Quality indicator for VFM result.
VHflash class.
VHflashQfunc class.
Virtual Flow Meter for calculating multiphase flow rates from pressure and temperature
measurements.
Well test data for VFM calibration.
VirtualStream class.
Abstract class for Viscosity property.
Abstract class for Viscosity property.
Viscosity class.
Viscosity class.
ViscosityFunction class.
ViscosityFunction class.
ViscosityInterface interface.
ViscositySim class.
ViscosityWaxOilSim class.
VLSolidTray class.
VolumeFlowTransmitter class.
Generic voting logic evaluator for redundant sensors or conditions.
Internal class to store voting input with fault status.
Represents a voting logic pattern for Safety Instrumented Systems (SIS).
Standard voting patterns for redundant sensors or conditions.
VSflash class.
VUflash class.
VUflashQfunc class.
VUflashSingleComp class.
Represents a wall with multiple material layers for heat transfer calculations.
Wall friction correlations for two-fluid multiphase pipe flow.
Result container for wall friction calculations.
Enum for selecting wall heat transfer models in two-phase pipe flow simulations.
Enumeration of wall heat transfer models for pipe flow.
WallInterface interface.
WATcalc class.
Water Density Calculation class for aqueous salt solutions using Labiberte/Cooper partial
specific volumes.
Salt-water viscosity using Laliberté (2007) with erratum coefficients.
Water class.
WaterContentAnalyser class.
Cooler for water streams using the water property package.
WaterDewPointAnalyser class.
WaterDewPointEquilibriumLine class.
waterDewPointTemperatureFlash class.
waterDewPointTemperatureMultiphaseFlash class.
Water hammer transient pipe model using Method of Characteristics (MOC).
Boundary condition types.
WaterLevelTransmitter class for measuring water level in three-phase separators.
WaterPhysicalProperties class.
WaterStripperColumn class.
WaxCharacterise class.
WaxDepositionFlowNode class.
WaxFractionSim class.
WaxFunction class.
WaxModelInterface interface.
Well class.
WellAllocator class.
WellAllocatorResponse class.
WellFlow class - Inflow Performance Relationship (IPR) model for
reservoir-to-wellbore flow.
Inflow performance models supported by the well.
Represents a single reservoir layer for commingled well production.
Network wrapper that links
WellFlow inflow models with PipeBeggsAndBrills
hydraulics and gathers the outlets into configurable manifolds.A branch represents one well + flowline path to a manifold.
Represents a manifold that mixes incoming branches (and optional upstream pipeline) before
optionally sending flow further downstream through a connecting pipeline.
WellFluidModule class.
Allocates commingled production back to individual wells.
Allocation methods.
Data for a single well.
Complete example demonstrating multi-well heat transfer coefficient estimation using the
EnKFParameterEstimator with dynamic routing for improved observability.
Schedules well interventions, workovers, and tracks well availability.
Scheduled intervention record.
Builder for creating Intervention instances.
Types of well interventions.
Schedule optimization result.
Well record for availability and production tracking.
Well operational status.
Well configuration input for field concept definition.
Builder for WellsInput.
Completion type.
Well type classification.
WellSystem class - Integrated well model combining IPR (Inflow Performance Relationship) and VLP
(Vertical Lift Performance) for complete well modeling.
IPR model types supported by WellSystem.
Represents a single reservoir layer for commingled wells.
VLP solver modes for different accuracy/speed trade-offs.
WettedWallColumnData class.
WettedWallColumnDataObject class.
WettedWallColumnSampleCreator class.
WettedWallDataReader class.
Whitson PVT parameter file reader.
Internal class to hold component data.
WilkeLeeDiffusivity class.
Simple wind turbine model based on actuator disk theory.
Result container for field development workflow execution.
Utility class for XML parsing and writing.