All Classes and Interfaces
Class
Description
Cost estimation class for absorbers.
AbsorberInterface interface.
AbsorberMechanicalDesign class.
AbsorptionColumnDesignStandard class.
Abstract base class for adsorption models.
Enumeration of convergence acceleration methods for recycle calculations.
Standardized action vector for RL control integration.
Action to activate a blowdown valve.
addIonToScaleSaturation class.
Single-phase adiabatic pipe model.
AdiabaticTwoPhasePipe class.
Adjuster class.
AdsorberMechanicalDesign class.
Adsorption bed unit operation supporting both steady-state and transient simulation.
Controller for adsorption/desorption cycle scheduling.
Enumeration of the possible phases in an adsorption/desorption cycle.
Defines a single phase within a cycle schedule.
AdsorptionDehydrationDesignStandard class.
AdsorptionDehydrationlModule class.
Interface for adsorption isotherm models.
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.
Defines and evaluates standardized engineering benchmark problems for agent performance
measurement.
A single benchmark problem with expected reference solution.
Aggregate report for the full benchmark suite evaluation.
Difficulty level of the benchmark problem.
Category of engineering benchmark problem.
Result of evaluating a single benchmark problem.
Collects and aggregates feedback metrics from agent sessions for continuous improvement.
Record of a discovered API gap.
Failure category for classification of session failures.
Summary of a recorded session (lightweight copy for storage).
Tracks an AI agent workflow session from start to completion.
Final outcome of the agent session.
Workflow phase in the task-solving lifecycle.
Record of a single workflow phase with timing.
Record of a simulation run.
Record of a tool invocation.
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-cooled heat exchanger (fin-fan cooler) model.
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.
Auto-generates alarm and trip setpoints from process design envelopes.
Alarm priority classification.
Represents a single alarm or trip setpoint entry.
Service type classification.
Result of well production allocation.
AmineDiffusivity class.
Calculates the heat of absorption for CO2 and H2S in aqueous amine solutions.
Supported amine types for heat of absorption calculation.
AminePhysicalProperties class.
Convenience wrapper for creating and configuring amine thermodynamic systems.
Supported amine types.
Calculates the viscosity of aqueous amine solutions (MEA, DEA, MDEA, aMDEA).
Enum representing supported amine types for viscosity calculation.
Utility class implementing the Ammonia2023 reference equation of state.
Container for ideal Helmholtz derivatives.
Container for residual Helmholtz derivatives.
Ammonia compatibility assessment for materials in ammonia service.
Ammonia synthesis reactor modeling the Haber-Bosch process.
Anaerobic digester for biogas production from organic substrates.
Substrate type enumeration.
Temperature regime enumeration.
AnnularFlow class.
Models fluid leakage through compromised well cement or micro-annulus between zones.
Leakage mechanism type.
AntiSurge class for compressor surge protection in dynamic simulations.
Enum for anti-surge control strategies.
Standard API envelope for all MCP runner responses.
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.
Comprehensive multi-method asphaltene prediction benchmark.
Represents a published literature case for asphaltene onset validation.
Container for results from a single method.
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.
Alternative alpha function for the Peng-Robinson EOS using a Soave-form m-factor.
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.
Provides self-diagnosis, fuzzy matching, and error-recovery capabilities for the
ProcessAutomation API.A diagnostic result returned when an operation fails, containing the error analysis, closest
suggestions, and auto-correction attempt.
Classification of automation errors for structured remediation.
Tracks a single automation operation for learning.
Represents physical bounds for a property value.
Helper for sorting names by match score.
Stateless automation and lifecycle runner for MCP integration.
Interface for process equipment that can be automatically sized based on design criteria.
Cost estimation for brazed aluminium plate-fin heat exchangers (BAHX).
Mechanical design for brazed aluminium plate-fin heat exchangers (BAHX).
Bang-bang (on-off) controller with hysteresis.
Solid solution model for the (Ba,Sr)SO4 system.
Represents a single well barrier element per NORSOK D-010 Section 4.
Well barrier element types per NORSOK D-010 Figure 3 and Tables 20/36/37.
Functional status of the barrier element.
Represents a well barrier envelope per NORSOK D-010 Section 5.
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.
Stateless batch calculation runner for MCP integration.
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.
Bell-Delaware method for shell-side heat transfer and pressure drop in shell and tube heat
exchangers.
Benchmark trust metadata for each MCP tool.
Tool maturity level.
BerlSaddlePacking class.
BestPracticeHydrocarbonDewPoint class.
BET (Brunauer-Emmett-Teller) adsorption isotherm implementation.
Parameter adapter for fitting one binary interaction parameter on a thermodynamic system.
Pre-built biorefinery module for biogas-to-grid injection.
Biogas upgrader for producing biomethane from raw biogas.
Upgrading technology enumeration.
Characterizes biomass feedstocks for use in NeqSim thermochemical process simulations.
Biomass gasifier reactor for thermochemical conversion of solid biomass to syngas.
Gasification agent type.
Gasifier type enumeration.
Stateless bioprocessing runner for MCP integration.
Techno-economic analysis (TEA) cost estimator for biorefinery plants.
Biorefinery equipment types with base cost data for capacity-based scaling.
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.
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).
Boiling heat transfer correlations for nucleate and forced-convective boiling.
Bottleneck identification and debottlenecking analysis for process facilities.
Bottleneck analysis result.
Constraint type enumeration.
Debottlenecking option.
Equipment type enumeration.
Result class containing information about the bottleneck equipment and constraint.
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.
Bow-Tie Analyzer for process safety risk assessment.
Consequence template from library.
Threat template from library.
Bow-Tie Model representing hazard, threats, consequences, and barriers.
Barrier (prevention or mitigation).
Barrier type enumeration.
Consequence of hazard realization.
Threat (cause) leading to hazard.
Exports BowTie models to SVG format for visualization.
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.
Capabilities discovery runner for MCP integration.
Represents a validation alert indicating that a disposal unit is overloaded in a load case.
Allocation policy used when host capacity is insufficient for base and satellite production.
Interface for process equipment that has capacity constraints.
Represents a capacity constraint for process equipment.
Enum defining the severity level of constraint violations.
Enum defining the type of capacity constraint.
Adapts equipment-level
CapacityConstraint instances to the unified
ProcessConstraint interface.Capillary condensation model for mesoporous materials.
Enumeration of pore types.
Computes the capillary dew point temperature for multicomponent gas mixtures.
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.
Catalyst bed properties for packed bed and plug flow reactors.
Data point for Constant Composition Expansion (CCE) experiment.
Classical Density Functional Theory (cDFT) for interfacial tension calculation.
Cement degradation model for CO2 injection wells.
Cement type classification.
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.
Chloride stress corrosion cracking (Cl-SCC) assessment for austenitic and duplex stainless
steels.
ChungConductivityMethod class for dilute-gas thermal conductivity using the Chung et al.
correlation (1984, 1988).
Full Chung et al. (1988) thermal conductivity method including both dilute-gas and dense-fluid
contributions.
ChungFunction class.
ChungViscosityMethod class.
General-purpose Classical Nucleation Theory (CNT) model for predicting particle formation from
supersaturated vapors.
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.
Template for creating amine-based CO2 capture systems.
Amine type enumeration.
Reference thermal conductivity correlation for pure carbon dioxide.
Coupled CO2 corrosion analyzer using electrolyte CPA EOS for rigorous pH prediction and de
Waard-Milliams model for corrosion rate estimation.
CRA (Corrosion Resistant Alloy) material selection for CO2-containing service.
Electrochemical reactor converting CO₂ rich feeds to value added products.
CO2-specific correction factors for two-phase flow correlations.
High-level safety analysis module for CO2 injection wells.
CO2RemovalModule class.
Reference viscosity correlation for pure carbon dioxide.
CO2water class.
CO2waterPhysicalProperties class.
Cost estimation class for distillation and absorption columns.
Column internals designer for distillation columns.
Equation groups used in the distillation column MESH residual vector.
Immutable residual vector for distillation column MESH diagnostics.
Evaluates scaled MESH residuals for a distillation column state.
Builder for residual vectors and metadata.
Snapshot of tray variables used by distillation MESH residual diagnostics.
Internal strategy interface for distillation column solvers.
Immutable summary of a distillation column solve.
Factory for the built-in distillation column solver strategies.
Damped substitution adapter.
Direct substitution adapter.
Inside-out adapter.
MESH residual-monitored adapter.
Sum-rates adapter.
Temperature-Newton adapter.
Wegstein adapter.
Represents a column specification (degree of freedom) for a distillation column.
Indicates which end of the column this specification refers to.
Types of column specifications.
Combined-cycle power system integrating a gas turbine, HRSG, and steam turbine.
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.
Wax component model based on the Coutinho predictive UNIQUAC approach.
ComponentCPAInterface interface.
ComponentCSPsrk class.
ComponentDesmukhMather class.
ComponentElectrolyteCPA class.
Component class for the e-CPA-Advanced electrolyte equation of state.
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.
Queries the NeqSim component database for MCP and API integration.
ComponentRK class.
Component class for the SAFT-VR Mie equation of state.
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.
Multi-server composition layer that enables NeqSim MCP to coordinate with external MCP servers
for cross-domain engineering workflows.
Represents an external MCP server.
A single step in a workflow.
A workflow template.
Compressor class.
Builder class for constructing Compressor instances with a fluent API.
RL agent for compressor control with anti-surge protection.
Capacity strategy for compressor equipment.
Calculator for compressor casing mechanical design per API 617 and ASME Section VIII.
CompressorChart class.
CompressorChartAlternativeMapLookup class.
CompressorChartAlternativeMapLookupExtrapolate class.
Compressor chart generator.
CompressorChartInterface interface.
Reader for compressor chart data from JSON files.
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.
Configuration class for compressor operational constraints.
Cost estimation class for compressors.
CompressorCurve class.
Utility class providing correction factors for centrifugal compressor performance curves.
Template class for storing normalized compressor curve data.
Comprehensive feasibility report for centrifugal gas compressor design.
A single feasibility issue or observation.
Severity levels for feasibility issues.
Data class for a compressor supplier/manufacturer match.
CompressorDesignStandard class.
Models the driver (motor, turbine, engine) for a compressor.
Electrical design for compressors.
Listener interface for compressor events in dynamic simulations.
Instrument design for compressors.
CompressorInterface interface.
Mechanical design calculations for centrifugal compressors.
Casing type enumeration per API 617.
Inner class to hold validation results.
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.
Helper class for compressor-specific production optimization.
Container for compressor operating bounds extracted from performance charts.
Result of two-stage optimization containing final flow, splits, and per-train
data.
CompressorPropertyProfile class.
CompressorResponse class.
Enumeration representing the operating states of a compressor in dynamic simulations.
Composite equipment representing a single compressor stage (train).
Models compressor washing (online and offline) for performance recovery.
Fouling type affecting compressor.
Record of a wash event.
Compressor washing method types.
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.
Condition-Based Reliability Model.
Condition indicator for equipment health monitoring.
Degradation model types.
Health record for historical tracking.
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.
Collection of conformity check results for a separator or scrubber.
Result of a single conformity check against a design standard.
Direction of the limit check.
Status of a conformity check.
Defines conformity rules for a specific design standard.
Equinor TR3500 conformity rules for gas scrubbers.
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.
Reusable penalty calculator for constrained process optimization.
Snapshot of a single constraint evaluation.
Unified severity level for all constraint types in the optimization framework.
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.
Operating modes for a feedback controller.
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.
Valve sizing implementation using multiphase choke flow models.
Provides simplified methods for sizing production chokes and control valves.
ControlValveSizingInterface interface.
Diagnoses convergence issues in process systems with recycle loops and adjusters.
Status of a single Adjuster unit.
Complete diagnostic report for a process system.
Status of a single Recycle unit.
Cooler class.
Cooling water system designer for process plant utility sizing.
Represents a single cooling requirement from a process cooler.
CorrespondingStatesDiffusivity class.
COSTALD (Corresponding States Liquid Density) calculation for liquids.
CostEstimateBaseClass class.
Cost estimation calculator for process equipment.
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.
Direct cricondenbar calculation using the Michelsen simultaneous Newton method.
cricondenBarTemp class.
cricondenBarTemp1 class.
Direct cricondentherm calculation using the Michelsen simultaneous Newton method.
CriticalPointFlash class.
Cross-validation runner that compares the same process model under different thermodynamic models
(equations of state) to quantify model-selection risk.
Cryogenic separator model with solid formation and freeze-out safety checks.
Crystallizer for producing solid crystals from solution.
Loads mechanical design limits from a CSV file.
CSV-based data source for loading Technical Requirements Documents (TORG).
Corrosion Under Insulation (CUI) risk assessment per API 581 / NORSOK M-501.
CUI risk level enumeration.
Insulation types and their CUI susceptibility.
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.
Read-only data catalog runner that exposes NeqSim databases as browsable resources.
DataHandling class.
DataObject class.
DataObjectInterface interface.
DataReader class.
DataReaderInterface interface.
Data reconciliation engine using weighted least squares (WLS) with linear constraints.
DataSmoothor class.
Discounted Cash Flow (DCF) calculator for field development economics.
De Boer plot-based screening for asphaltene precipitation risk.
Risk level enumeration based on De Boer plot regions.
Systematically identifies and ranks equipment bottlenecks in a process system.
Status report for a single piece of equipment.
Simple debottleneck investment decision derived from a tie-in capacity study.
Decline Curve Analysis (DCA) for production forecasting.
Decommissioning cost estimation for offshore oil and gas facilities.
Cost breakdown item.
Facility type enumeration.
Pipeline decommissioning strategy.
DefaultPhysicalProperties class.
Optimizer for finding optimal operating conditions during degraded operation.
Operating mode options during degraded operation.
Recovery action for the recovery plan.
Recovery phase.
Recovery plan for restoring normal operation.
Result of degraded operation optimization.
Template for creating TEG (Triethylene Glycol) gas dehydration systems.
Base class for demisting internals used in separators and gas scrubbers.
A demisting internal with a drainage section below the main demisting pad.
Dense-phase CO2 corrosion assessment for CCS transport pipelines.
Density class for gases.
Density class foir liquids.
Density class for solids.
DensityFunction class.
DensityInterface interface.
DensitySim class.
Analyzes dependencies between equipment and their impact on each other.
Represents a dependency between equipment on different installations.
Result of a dependency analysis.
Enumeration of design cases for process equipment sizing.
Immutable mechanical design limits for a unit of equipment.
Builder for
DesignLimitData.Integrated design-to-optimization workflow manager.
Objective types for optimization.
Enumeration of field development design phases with associated accuracy requirements.
Result container for design optimization.
Status of a single constraint.
Builder class for standardized equipment design specification.
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.
Standardized field-development case template for concept comparison.
Probabilistic assumption bundle for a development-case template.
Builder for uncertainty bundles.
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.
CO2 corrosion rate prediction using the de Waard-Milliams (1975/1991) model.
dewPointPressureFlash class.
dewPointTemperatureFlash class.
dewPointTemperatureFlashDer class.
Bridge between DEXPI XML data exchange and PFD visualization.
Factory that converts
DexpiProcessUnit placeholders into runnable NeqSim process
equipment by matching the EquipmentEnum type and applying sizing
attributes from DEXPI GenericAttributes.Holds metadata for an instrument parsed from a DEXPI XML file.
Configuration class for DEXPI layout parameters.
Computes auto-layout positions for DEXPI XML export.
Holds computed position data for a single equipment item.
Holds stream data for a single column in the stream data table.
Loads DEXPI-to-NeqSim equipment and piping component mappings from properties files on the
classpath.
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.
Generates the DEXPI
<ShapeCatalogue> section with ISO 10628:2012 standard P&ID
symbols for process equipment.High-level builder that converts a DEXPI P&ID XML file into a runnable NeqSim
ProcessSystem.Stream created from DEXPI piping segments while preserving key metadata.
Stream created from DEXPI piping segments while preserving key metadata.
Shared utilities for resolving outlet streams from NeqSim process equipment.
Resolves the topology (stream connectivity) of a DEXPI P&ID XML document.
The resolved topology of a DEXPI document, containing equipment IDs in topological order and
the edges (connections) between them.
Represents a directed edge between two DEXPI elements in the process topology.
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.Simple connection descriptor linking an outlet nozzle to an inlet nozzle.
A diagnostic issue found during validation or simulation.
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.
DIIS (Direct Inversion in the Iterative Subspace) accelerator for fixed-point iterations.
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.
Fluent builder for
DistillationColumn.Simplified K-value model for the inside-out inner loop.
Available solving strategies for the column.
Capacity strategy for distillation column equipment.
A matrix-based solver for DistillationColumn using the Inside-Out algorithm approach.
Mechanical design class for distillation columns.
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.
Interface for compressor and pump driver performance curves.
Abstract base class for driver curve implementations.
Enum representing different types of compressor drivers.
DropletFlowNode class.
Calculates terminal settling velocity for droplets/bubbles using the Schiller-Naumann drag
correlation, which covers the full range from Stokes (creeping) flow through the intermediate
regime to the Newton (turbulent) regime.
Holds the result of an API 12J compliance check for a separator design.
Represents a droplet (or bubble) size distribution for separator internals calculations.
Enumeration of supported distribution types.
Dryer for removing moisture from wet solids or liquid streams.
High-level analysis module for dry gas seal condensation risk assessment in centrifugal
compressors.
dTPflash class.
Compares thermodynamic property predictions between two equations of state.
Holds comparison results for a single T-P condition.
DuanSun class.
Example demonstrating how to create process logic completely dynamically at runtime without any
pre-compiled logic sequences.
Helper that converts a sized steady-state
ProcessSystem into a dynamic simulation by
auto-creating transmitters and PID controllers with sensible defaults.Result from dynamic risk simulation including transient effects.
Enhanced Monte Carlo simulator with dynamic simulation for transient effects.
Internal class to track iteration state.
Internal class to track equipment state during simulation.
Ramp profile types for production transitions.
Stateless dynamic simulation runner for MCP integration.
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.
Eclipse VFP (Vertical Flow Performance) table exporter.
VFP scenario configuration.
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.
Capacity strategy for ejector equipment.
Cost estimation class for ejectors.
Immutable container for mechanical design results of an ejector.
Mechanical design container for ejector sizing results.
EjectorResponse class for JSON serialization of Ejector equipment.
Model of an electrical power cable for process equipment.
Base class for electrical design of process equipment.
Response class for electrical design JSON export.
Electrical load list aggregation for a process system.
Model of an electric motor for process equipment.
Electric motor driver model with VFD support.
ElectrolyteMixingRulesInterface interface.
Electrolyzer unit converting water to hydrogen and oxygen using electrical energy.
Capacity strategy for electrolyzer equipment.
Mechanical design for water electrolyzers (PEM and alkaline).
Element class.
Utility class for calculating greenhouse gas emissions from process streams.
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.
Emulsion viscosity and phase inversion prediction for oil-water systems.
End flash drum model for LNG production.
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.
Generates the full engineering deliverables package for a field development study.
Status of a single deliverable generation.
Engineering validation layer that checks simulation results against industry design rules,
physical constraints, and best-practice ranges.
Severity levels for validation findings.
A single validation finding.
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.
One contiguous branch of a PT phase envelope.
Which side of the envelope this segment belongs to.
Environmental KPI reporter for field development.
Environmental report result container.
Power supply type for emission calculations.
Enzyme treatment reactor for bio-processing.
Standalone EOS-CG correlation adapter.
EOS-CG correlation wrapper implemented using the EOSCGModel (based on GERG-2008 functional form).
GERG2008 class.
Side-by-side comparison of thermodynamic properties across multiple EOS models.
Comparative results across all EOS models.
Results for a single EOS evaluation.
Supported equation of state types.
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.
Strategy interface for equipment-specific capacity evaluation.
Registry for equipment capacity strategies.
Registry for default equipment capacity constraints.
Template class for constraint metadata.
Generates structured equipment datasheets from mechanical design data.
Generates a combined equipment design report covering mechanical, electrical, and motor design.
EquipmentEnum class.
Factory for creating process equipment.
Represents a failure mode for process equipment.
Builder for EquipmentFailureMode.
Types of equipment failure.
Classifies process equipment by its functional role in the process.
Quick equipment sizing runner for MCP integration.
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.
Erosion rate prediction for oil and gas production systems.
Default sand production assumptions by well completion type and flow phase.
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.
Catalog of example JSON inputs for each MCP runner.
ExcludeFromJacocoGeneratedReport class.
Structured result of an exergy analysis over a
ProcessSystem or ProcessModel.One row of an exergy analysis: the exergy balance for a single unit operation or process area.
Expander class.
Capacity strategy for expander equipment.
Cost estimation class for turboexpanders.
ExpanderInterface interface.
Mechanical design calculations for turboexpanders per API 617.
Expander type classification.
Load type for power recovery.
ExpanderOld class.
Downloads experimental data files into a local cache for reproducible fitting studies.
Immutable experimental data point with measured value, uncertainty and independent variables.
Reader utilities for metadata-rich experimental parameter fitting data sets.
CSV mapping options for experimental data loading.
Metadata-aware collection of experimental data points for parameter fitting.
ExperimentalEquipmentData class.
Enumeration of PVT experiment types supported by the regression framework.
Experimental data category used by parameter fitting studies and reports.
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.
Fermentation reactor with Monod and Contois kinetics for bio-chemical conversion.
Kinetic model type enumeration.
Operation mode enumeration.
Fermenter / bioreactor for biological conversion processes.
Main field concept definition for rapid field development screening.
Builder for FieldConcept.
Integrates process mechanical design and cost estimation into field development workflows.
Development concept type affecting cost factors.
Equipment cost item for detailed breakdown.
Fidelity level for cost estimation.
Cost report for field development.
Orchestrator for field development design workflows.
Represents results for a single design case.
Represents a single workflow step.
Exports standard field-development comparison tables for books and reports.
Stateless field development economics runner for MCP integration.
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.
Liquid thermal conductivity using temperature-dependent pure component correlations with the
Filippov (1955) mixing rule and an optional Missenard (1965) pressure correction.
Filter class.
Capacity strategy for filter and adsorber equipment.
General mechanical design for filter vessels per ASME VIII Div 1.
FilterResponse class for JSON serialization of Filter equipment.
Fire Detector instrument for fire detection and alarm systems.
Duty-controlled fired heater with thermal efficiency modeling.
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.
Fire protection design utilities per NORSOK S-001 and API 2510 / API 521.
Holds results from a comprehensive fire scenario assessment.
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).
Definition of one fitted model parameter including bounds, transform and prior metadata.
Collection of pipe fittings for equivalent length pressure drop calculations.
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.
Mechanical design for flare systems per API 521/537.
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.
Typed request model for flash calculations.
Typed result model for flash calculations.
Stateless flash calculation runner for MCP integration.
Example: Generate training data for a flash calculation surrogate model.
Pre-computed flash property table for fast interpolation.
Flexible Pipe equipment class.
Application type.
Flexible pipe construction type.
Riser configuration.
Service fluid type.
Mechanical design class for Flexible Pipe equipment.
Floating substructure model for offshore wind turbines and oil/gas platforms.
Floating concept types.
Flory-Huggins regular solution model for asphaltene precipitation prediction.
Detailed results from flow assurance screening.
Builder for FlowAssuranceReport.
Result classification for flow assurance screening.
Stateless flow assurance runner for MCP integration.
Flow assurance screener for rapid envelope-based assessment.
FlowInducedVibrationAnalyser class.
Abstract FlowLeg class.
FlowLegInterface interface.
Computes mineral scale saturation indices along a flowline given a T/P profile and water
chemistry.
Result at a single pipeline segment.
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.
Result of a flow rate optimization for pressure-constrained process simulation.
Details of a constraint violation.
Status of the optimization result.
Optimizer for finding flow rate given inlet and outlet pressure constraints.
Simple data class representing compressor operating state within a ProcessSystem.
Contains equipment utilization data for reporting.
Configuration class for professional lift curve generation.
Result container for professional lift curve generation.
Mode of operation for the optimizer.
Represents a 2D capacity table showing maximum flow rates at different pressure boundary
conditions.
Process lift curve table for reservoir simulator integration.
Represents a complete process operating point with all equipment data.
Performance table for a process system at different flow rates.
Callback interface for monitoring optimization progress.
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.
Fluent builder for creating pre-configured thermodynamic fluid systems.
Internal holder for component name and mole fraction.
Supported equation of state types.
Internal holder for TBP fraction data.
Utility class for classifying reservoir fluids based on phase behavior characteristics.
Fluid class.
Used to generate fluids of type SystemInterface.
Reference fluid input from FluidMagic/Eclipse E300 for multi-scenario optimization.
Builder class for FluidMagicInput.
GOR spacing options for scenario generation.
fluidMech class.
Utility class for estimating fluid properties needed by adsorption models.
Fluid class.
FluidSevereSlug class.
Flux limiter functions for TVD (Total Variation Diminishing) advection schemes.
Formula matrix (A) for the modified RAND method.
Dynamic fouling model for heat exchangers based on the Ebert-Panchal (1997) threshold fouling
correlation.
Fouling model type selection.
Example demonstrating a production network with four wells routing to HP/LP manifolds.
FreezeOut class.
freezingPointTemperatureFlash class.
freezingPointTemperatureFlashOld class.
freezingPointTemperatureFlashTR class.
Freundlich adsorption isotherm implementation.
Utility class for calculating friction factors in pipe flow.
Friction theory (f-theory) thermal conductivity method for both gas and liquid phases.
Implementation of the friction-theory viscosity model of Quiñones-Cisneros and
Firoozabadi for mixtures.
FuelCell class representing a simple hydrogen fuel cell.
Models fuel gas systems for process facilities.
Fuel gas consumer type with specific requirements.
Fuel gas consumer (equipment using fuel gas).
Container for Jacobian matrix of fugacity coefficients.
FugTestConstP class.
Fuller-Schettler-Giddings method for gas-phase binary diffusion coefficients.
Represents a functional location tag following STID/ISO 14224 conventions.
Builder class for FunctionalLocation.
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.
Template for creating multi-stage gas compression systems.
Gas Detector instrument for detecting combustible or toxic gases.
Enumeration of gas detector types.
Gas flotation unit for produced water treatment.
Pre-built biorefinery module for biomass gasification and Fischer-Tropsch synthesis.
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.
Gas pseudocritical property correlations for natural gas mixtures.
Gas pseudopressure (real gas potential) calculator.
GasScrubber class.
GasScrubberDesignStandard class.
GasScrubberMechanicalDesign class.
GasScrubberSimple class.
Gas turbine model with integrated air compression, combustion, and expansion.
Gas turbine driver model with ambient derating.
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.
GERG-2008-NH3 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.
Gilbert (1954) empirical correlation for two-phase critical choke flow.
Correlation type for identifying which variant is used.
GlycolDehydrationlModule class.
GlycolPhysicalProperties class.
GOR class.
GORfitter class.
Grade efficiency curves for separator internals (mist eliminators, inlet devices, gravity
sections).
Types of separator internals with published grade efficiency correlations.
graph2b class.
Factory for standardized field-development concept templates.
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.
H2S Scavenger unit operation for removing hydrogen sulfide from gas streams.
Response class for JSON serialization.
Enum representing types of H2S scavengers available.
Hayduk-Minhas diffusivity model for liquid hydrocarbon systems.
Solvent type enumeration.
Model for hazardous area classification of process equipment locations.
HCdewPointPressureFlash class.
Heater class.
HeaterInterface interface.
HeaterResponse class.
HeatExchanger class.
Builder class for constructing HeatExchanger instances with a fluent API.
Design mode for the heat exchanger.
Capacity strategy for heat exchanger equipment.
Cost estimation class for heat exchangers.
Design feasibility report for heat exchangers.
A single feasibility issue or observation.
Severity levels for feasibility issues.
Data class for a heat exchanger supplier match.
Electrical design for heat exchangers (heaters, coolers, and heat exchangers).
Type of heat exchanger for electrical sizing.
Instrument design for heat exchangers.
Heat exchanger type enumeration.
HeatExchangerInterface interface.
Mechanical design for a generic heat exchanger.
Inner class to hold validation results.
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.
Geometry model for plate-fin / brazed aluminium heat exchangers (BAHX).
Generates industry-standard Heat and Material Balance (HMB) reports from a ProcessSystem.
Represents a single process stream for heat integration (pinch) analysis.
Stream type enumeration.
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.
Policy for handling satellite production that cannot pass through the host in a period.
Represents an existing host facility with available capacity for tie-backs.
Builder for HostFacility.
Type of host facility.
Report from host capacity assessment.
Mapping between production-profile rates and an attached host process model stream.
HPTphaseEnvelope class.
Heat Recovery Steam Generator (HRSG) for combined-cycle power plants.
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.
Maps hydrate formation risk along a pipeline pressure-temperature profile.
A point along the pipeline profile.
Hydrate risk classification levels.
Risk assessment at a single pipeline point.
Complete hydrate risk profile along the pipeline.
WaterDewPointAnalyser class.
Hydrocyclone class.
De-oiling hydrocyclone for produced water treatment.
Mechanical design for de-oiling hydrocyclone packages.
Thermal conductivity of normal hydrogen (n-H2) using polynomial correlations fitted to NIST
reference data.
Comprehensive hydrogen material compatibility assessment.
Hydrogen pipeline mechanical design per ASME B31.12 and DNV-ST-F101.
Utility class implementing a compact version of the full IAPWS IF97 steam tables.
IEC 81346-2 letter codes for classification of objects in industrial plants.
ImprovedVUflashQfunc class with enhanced numerical stability.
Phase-partitioned composition tracking device for monitoring impurity concentrations across gas,
liquid, and aqueous phases.
Incompressible pipe flow model for liquid flow with fittings.
Incremental zone-by-zone thermal analysis for heat exchangers.
Represents a single incremental zone in the heat exchanger.
Phase regime within a zone.
Exports MPC models and configurations in formats compatible with industrial control systems.
Industrial deployment profiles for the NeqSim MCP server.
Deployment mode for the MCP server.
Tool classification by risk level.
Explicit trust tier for each tool.
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 conformance monitor for diagnosing out-of-zone injection.
Conformance diagnosis result.
Single injection data record.
Zone injection profile data point.
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.
Represents an injection zone in a multi-zone injection well.
Result for a single injection zone.
Multi-zone injection calculation result.
Inlet cyclone device for primary separation in a separator vessel.
Models inlet device performance for separator and scrubber design.
Types of separator inlet devices.
Inlet vane device for primary separation in a separator vessel.
Inlet vane with downstream mesh pad for enhanced primary separation.
Base class for instrument design of process equipment.
Response class for instrument design JSON export.
Collection of instrument specifications for a piece of process equipment.
Generates an instrument schedule (instrument index) from a process simulation and optionally
registers live measurement devices on the
ProcessSystem.Represents a single instrument in the instrument schedule.
Measurement variable classification per ISA-5.1.
SIL rating classification per IEC 61508 / IEC 61511.
Specification for a single instrument in a process plant.
Defines the role of a measurement device when used in a digital-twin or field-data integration
context.
Thermal insulation design per NORSOK R-004 and CINI Manual.
Insulation material type with thermal conductivity correlations.
Insulation purpose.
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-specific parameters for the e-CPA-Advanced electrolyte equation of state.
Data class holding ion-specific advanced parameters.
Data class for ion-pair formation parameters.
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.
Enumeration of supported adsorption isotherm models.
JointEfficiencyPipelineStandard class.
JointEfficiencyPlateStandard class.
Read and write NeqSim fluids in a JSON format that provides full EOS-level fidelity equivalent to
Eclipse E300 fluid files.
Internal data holder for a parsed component.
Builds a
ProcessSystem from a JSON definition string.Exports a
ProcessSystem to the JSON schema consumed by JsonProcessBuilder.General kinetic reaction model for plug flow and stirred tank reactors.
Rate basis for heterogeneous vs homogeneous reactions.
Rate expression type.
Kinetics class.
Dashboard for comparing KPIs across multiple scenarios.
KrishnaStandartFilmModel class.
KTAViscosityMethod class.
KTAViscosityMethodMod class.
OLGA-style Lagrangian slug tracking model.
Represents a single slug-bubble unit in Lagrangian tracking.
Source of slug generation.
Langmuir adsorption isotherm implementation.
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.
Immutable result from a Levenberg-Marquardt parameter fitting run.
Reason why the optimizer stopped.
LGTSurfaceTension class.
Time-series emissions profile for a development concept.
One annual lifecycle-emissions record.
Generates lift curves (VLP tables) for reservoir simulator integration.
Represents a lift curve table for reservoir simulator integration.
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.
Liquid-liquid extractor for separation of components between two immiscible
liquid phases.
LiquidPhysicalProperties class.
LiquidPhysicalPropertyMethod class.
LMTD correction factor (F_t) calculations for multi-pass heat exchangers.
Snapshot of LNG ageing KPIs at a single time step.
Top-level orchestrator for LNG ageing simulations.
Represents an operational event during an LNG voyage or storage period.
Event type enumeration.
Models the BOG handling network on an LNG carrier or terminal.
BOG disposition breakdown across handling modes.
BOG handling mode.
LNG cryogenic multi-stream heat exchanger model (plate-fin / brazed aluminium).
BAHX core geometry for sizing results (P8).
Plate-fin geometry for offset-strip, wavy, plain, or perforated fins.
Snapshot of a single time step in a cool-down transient (P7).
Manages LNG heel retention, cooldown, and mixing operations.
Detects rollover risk in stratified LNG tanks.
Result of a rollover assessment.
Risk level enumeration for rollover assessment.
LNGship class.
Multi-tank LNG ship model that orchestrates parallel ageing of all cargo tanks.
Aggregate ship-level result for a single time step.
Models sloshing-induced mixing enhancement in LNG cargo tanks.
LNG storage tank model with boil-off gas (BOG) generation.
Insulation type enumeration.
Represents a single horizontal layer in a stratified LNG tank.
Multi-layer LNG tank model with stratification support.
Models the vapor space above the LNG liquid in a cargo tank.
Defines the environmental and operational profile for an LNG voyage.
Environmental conditions at a specific point in the voyage.
A single segment of the voyage with constant environmental conditions.
Represents a single electrical load item in a load list.
Represents an action that can be executed as part of process logic.
Logic operator block for control system simulation in dynamic mode.
Chained input from another LogicBlock.
Comparison operators used to convert a continuous signal to a boolean.
Fixed boolean input for testing or permanent interlocks.
Input definition based on a measurement device and threshold comparison.
Logical operators supported by this block.
Interface for defining conditions that must be met for logic to proceed.
Represents the execution state of process logic.
Detects independent loops in a pipeline network using graph theory algorithms.
Represents an edge in the network graph.
Pipeline network supporting looped topologies with Hardy Cross solver.
Artificial lift type for wells.
IPR model type for well inflow performance.
Network element type for generalized resistance elements.
Represents a node in the pipe network.
Represents a pipe in the network.
Node type in the network.
Pipe flow model type.
Attached reservoir info: maps a network source node to a SimpleReservoir and well within it.
Solver type for network analysis.
Layer of Protection Analysis (LOPA) result.
Individual protection layer in LOPA.
Builder class for configuring lumping models with a fluent API.
LumpingModel class.
LumpingModelInterface interface.
Result class containing lumping quality metrics and configuration details.
Builder for LumpingResult.
Manifold class.
Mechanical design class for manifolds.
Calculator for manifold mechanical design based on industry standards.
Manifold location enumeration.
Manifold type enumeration.
Data source for manifold mechanical design parameters from database.
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.
Configuration class for mass transfer calculations 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.
Plugin interface for extending the MCP server with custom runners.
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.
Mechanical design for membrane separation modules.
Simple membrane separation unit with one inlet stream and two outlet streams
(retentate and
permeate).
Fixed-bed mercury removal unit operation using chemisorption (e.g.
Cost estimation for mercury removal guard beds.
Mechanical design class for mercury removal guard beds.
MeshSection class.
methaneBWR32 class.
Methane Number calculator based on EN 16726 and MWM methods.
Calculation method enumeration.
MethaneViscosityMethod class.
Mixer class.
Capacity strategy for mixer equipment.
Cost estimation class for mixers.
MixerGasProcessingModule class.
Interface for processEquipment with multiple inlet streams and a single outlet stream.
Mechanical design class for mixing equipment.
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.
Examples and templates for integrating external ML frameworks with the risk system.
Base adapter class with common functionality.
Interface for ML model adapters.
Adapter for ONNX Runtime models.
Adapter for REST API-based model serving.
Adapter for TensorFlow SavedModel format.
Simple threshold-based model for testing and fallback.
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.
Core solver for the Modified RAND method for simultaneous chemical and phase equilibrium.
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.
Monte Carlo uncertainty analysis for process simulations.
Results of a Monte Carlo simulation.
Functional interface for applying a parameter value to a process system.
A tornado sensitivity entry.
An uncertain input parameter.
Mooring system design for floating offshore structures.
Anchor types.
Mooring line material types.
Mechanical design of electric motors per IEC 60034, IEEE 841, and NORSOK E-001.
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.
Multi-compartment reservoir model for tracking pressure evolution across connected zones.
Represents a single reservoir compartment.
Represents a transmissibility connection between two compartments.
Multicomponent nucleation model for predicting droplet formation from supersaturated
multicomponent gas mixtures.
Enumeration of multicomponent nucleation approaches.
Multi-effect evaporator for concentration of solutions.
Multi-layer radial heat transfer calculator for pipeline thermal analysis.
Multi-objective optimizer for process systems.
Result container for multi-objective optimization.
Progress callback interface.
Abstract base class for multiphase choke flow calculations.
Flow regime: CRITICAL or SUBCRITICAL.
Factory class for creating multiphase choke flow models.
Available choke flow model types.
Integrates field development with multiphase pipeline hydraulics.
Flow regime classification.
Pipeline hydraulics result.
Abstract MultiPhaseFlowNode class.
Predicts multiphase flow regime from pipe flow conditions and generates the corresponding inlet
droplet size distribution for separator design.
Enumeration of two-phase gas-liquid flow regimes.
MultiPhaseMeter class.
Multiphase pipe flow simulation model using non-equilibrium two-phase flow.
Abstract base class for process equipment with multiple inlet and/or outlet streams.
Generates Eclipse VFP tables (VFPPROD/VFPEXP format) with GOR and water cut dimensions.
Result of a single VFP point calculation.
VFP table containing all calculated points.
Task for calculating a single VFP point.
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.
Multi-variable adjuster for simultaneous convergence of coupled process specifications.
Definition of a single adjusted (manipulated) variable.
Definition of a single target specification.
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.
Nelson curve assessment for high-temperature hydrogen attack (HTHA) per API 941.
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.
Mapper that skips ThreadLocal fields during serialization.
Mapper that silently ignores unknown elements during deserialization.
NeqStream class.
Sparse and dense linear system solvers for pipeline network equations.
Represents an independent loop in a pipeline network.
Represents a pipeline member of a loop with its traversal direction.
Formal NLP and multi-objective optimizer for pipeline network production allocation.
Optimizer algorithm selection.
Objective type for single-objective optimization.
Result container for network optimization.
Result container for network solver.
Production network solver for multi-well gathering systems.
Solution mode for the network.
Well node in the network.
Validation benchmark cases for pipeline network solvers.
Benchmark result container.
Single metric result within a benchmark.
newtonRhapson class.
NewtonSolveAB class.
NewtonSolveABCD class.
NewtonSolveCDplus class.
NMVOCAnalyser class.
Equipment noise prediction per NORSOK S-002 and IEC 61672.
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.
Material selection helper per NORSOK M-001 "Materials selection".
CO2 corrosion rate prediction model per NORSOK M-506 (2005/2017).
Norwegian Continental Shelf petroleum tax model.
Immutable result of a tax calculation.
NotImplementedException class.
NotInitializedException class.
NozzleSection class.
NumericalDerivative class.
NumericalDerivative class.
NumericalIntegration class.
Interface representing an optimization objective for multi-objective optimization.
Direction of optimization.
Objective function type used by high-level parameter fitting studies.
Offshore energy system integrating multiple power sources with dispatch logic.
Utility for characterising an oil system from assay information.
Oil and Gas Process Simulation and Optimization Example.
Result class for maximum production optimization.
Data class to hold process input parameters.
Data class to hold process output results.
OilLevelTransmitter class for measuring oil level in three-phase separators.
Oil-water flow regime detector for three-phase pipe flow.
Oil-water flow regime enumeration.
Result of oil-water flow regime detection.
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).
Operating envelope for compressor performance tracking.
Result of an operational risk Monte Carlo simulation.
Monte Carlo simulator for operational risk and production availability analysis.
Equipment reliability data holder.
Single point in a production forecast.
Production forecast with time-series data.
OperationInterface interface.
Base class for all optimization results in the NeqSim optimization framework.
Represents a constraint violation.
Status of the optimization run.
OptimizedVUflash class with enhanced performance for transient separator simulations.
Imports equipment reliability data from OREDA-format CSV files.
Reliability record from OREDA data.
Orifice class for flow restriction and measurement using ISO 5167 orifice plate calculations.
Override (selector) control structure that selects the output of one of two controllers using a
HIGH-select or LOW-select strategy.
Selection strategy for the override structure.
Oxygen corrosion assessment for injection water, utility water, and process systems.
Packed column (contactor/absorber/stripper) using packing internals with HETP-based staging.
PackedSection class.
Packing class.
Packing hydraulics calculator for packed distillation columns.
PackingInterface interface.
Immutable packed-column packing data used by hydraulic and rate-based column models.
Registry for packed-column packing specifications.
PallRingPacking class.
ParachorFunction class.
ParachorSurfaceTension class.
Executes multiple actions in parallel and tracks completion.
Lightweight serializable report for a completed parameter fitting study.
Serializable specification for a complete experimental parameter fitting study.
High-level workflow for fitting model parameters to experimental data sets.
Metrics calculated for one data set.
Result from a parameter fitting study.
Optimizer-space wrapper that maps transformed parameters back to the physical function.
Parameter-space transform used by parameter fitting specifications.
Applies fitted physical parameter values to a NeqSim model or fitting function.
Parametric study runner for sensitivity analysis and optimization sweeps.
Collection of Pareto-optimal solutions forming the Pareto front.
Represents a single solution on the Pareto front.
Builder for creating ParetoSolution instances.
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.
Phase class for the e-CPA-Advanced electrolyte equation of state.
Electrolyte CPA (e-CPA) phase class implementing the Maribo-Mogensen model.
Dielectric constant mixing rule options for mixed solvents.
PhaseElectrolyteCPAOld class.
PhaseElectrolyteCPAstatoil class.
Stateless phase envelope runner for MCP integration.
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.
Phase class for the SAFT-VR Mie equation of state following Lafitte et al. (2013).
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.
Anderson-accelerated nested CPA phase solver.
Anderson-accelerated nested CPA phase solver with site symmetry reduction.
Broyden quasi-Newton implicit CPA phase solver.
Fully implicit CPA phase implementation based on Igben et al. (2026).
Fully implicit CPA phase with site type reduction.
CPA phase class with site symmetry reduction and Broyden quasi-Newton acceleration.
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.
Physics-based risk monitor that directly integrates with NeqSim process simulation.
Risk assessment result derived from physics-based calculations.
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.
Pinch analysis engine for heat integration of process streams.
Performs pinch analysis (heat integration) on a process system.
Represents a suggested heat exchanger match.
Represents a heat stream (hot or cold) in the process.
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.
Capacity strategy for pipe and pipeline equipment.
Cost estimation class for pipelines and piping systems.
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.
Pipeline simulation using Hagedorn and Brown empirical correlation for multiphase vertical flow.
PipeLeg class.
Base class for pipeline simulation models.
Calculates pipeline thermal cooldown from initial operating temperature to ambient.
PipelineDesignStandard class.
Electrical design for pipelines.
Instrument design for pipelines.
Common interface for all pipeline simulation models.
Mechanical design class for pipelines.
Data source for loading pipeline mechanical design parameters from the NeqSim database.
Pipeline design factors holder.
Pipeline material data holder.
PipelineResponse class for JSON serialization of Pipeline equipment.
Stateless pipeline simulation runner for MCP integration.
Enumeration of common pipe wall materials with their thermal properties.
Calculator for pipeline mechanical design based on industry standards.
Pipeline simulation using the Mukherjee and Brill (1985) correlation for multiphase flow.
Flow pattern classification per Mukherjee-Brill.
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.
Builds a serial route-level piping hydraulics model from structured line-list data.
One K-value minor loss attached to a route segment.
One route segment from a line-list table.
Piping stress analysis utilities per ASME B31.3 (Process Piping).
Pipeline End Manifold (PLEM) equipment class.
PLEM configuration type.
Mechanical design class for PLEM (Pipeline End Manifold) equipment.
Pipeline End Termination (PLET) equipment class.
Connection type for PLET interfaces.
PLET structure type.
Mechanical design class for PLET (Pipeline End Termination) equipment.
pLoadingCurve class.
pLoadingCurve2 class.
Plug flow reactor (PFR) for rigorous kinetic modeling of chemical reactions.
Energy balance mode.
ODE integration method.
Registry for MCP runner plugins.
PlusCharacterize class.
PlusFractionModel class.
PlusFractionModelInterface interface.
Population Balance Model (PBM) for tracking the evolution of particle size distributions over
time.
Multi-field portfolio optimizer for capital-constrained investment decisions.
Optimization strategy.
Portfolio optimization result.
Single project in the portfolio.
Project type classification.
Portfolio Risk Analyzer for multi-asset analysis.
Asset in the portfolio.
Common cause scenario affecting multiple assets.
Results from Portfolio Risk Analysis.
Asset-level result.
PotentialTheoryAdsorption class.
Capacity strategy for power generation equipment.
Mechanical design for power generation equipment (gas turbines and waste heat recovery units).
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.
Optimizer for finding maximum flow rate given inlet and outlet pressure boundary conditions.
Lift curve table containing maximum flow rates for pressure combinations.
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.
Pressure filter for bio-processing solid-liquid separation.
PressureTransmitter class.
PressureUnit class.
PressureVesselDesignStandard class.
Base class for primary separation inlet devices in a separator vessel.
Base class for process equipment control agents.
Coordinates alarm evaluation across all measurement devices in a process system.
Provides a stable, string-addressable automation API for interacting with a running NeqSim
ProcessSystem or ProcessModel.Holds a resolved unit and its address prefix for variable naming.
Class representing process basis (design basis) for a process template.
Builder class for ProcessBasis.
Specification for a product stream.
Compares two or more process configurations side by side.
Represents an explicit connection between two process elements identified by name and port.
Connection types in a process model.
Unified constraint interface for process optimization.
Composite constraint evaluator for process-wide constraint evaluation.
Public cached constraints class for external use and testing.
Internal cached constraint data for an equipment.
Result of constraint evaluation.
Summary of constraints for a single equipment.
System-level cost estimation for an entire process.
Summary of cost data for a single equipment item.
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.
Process design standard providing design margins and safety factors for process equipment sizing.
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.
Marker interface that unifies all elements within a
ProcessSystem: equipment
(ProcessEquipmentInterface), measurement devices
(MeasurementDeviceInterface), and controllers
(ControllerDeviceInterface).
Abstract ProcessEquipmentBaseClass class.
ProcessEquipmentInterface interface.
Physics-based equipment monitor that directly integrates with NeqSim process equipment.
A recorded reading from the monitor.
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.
Exports a
ProcessSystem topology to Graphviz DOT format for PFD generation.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.
Validates JSON process definitions before building/running simulations.
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.
Interface for monitoring ProcessModel execution progress.
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.
Represents the difference between two ProcessModelState instances.
Options controlling JSON serialization of ProcessModelState.
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.
Unified process optimization engine.
Constraint report for entire process.
Constraint status for single equipment.
Lift curve data container.
Single point on a lift curve.
Result of an optimization run.
Search algorithm options.
Sensitivity analysis result.
Typed result model for process simulations.
Physics-grounded reward functions for reinforcement learning process optimization.
Abstract base class for reward components.
Stateless process simulation runner for MCP integration.
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).
Black-box evaluator for external optimization algorithms.
Definition of a constraint for external optimizer integration.
Constraint type.
Result of a single evaluation.
Definition of an objective function.
Optimization direction.
Definition of a decision variable (parameter) for optimization.
Objective function that bridges process simulation with the Levenberg-Marquardt optimizer.
Session-scoped ProcessSystem manager for multi-user online simulation.
Internal session entry tracking creation time and last access.
Represents a snapshot of a process system state at a point in time.
Represents a process system containing unit operations.
Available integration methods for transient simulation.
Inner class to hold mass balance results.
Fluent builder for process optimization.
Interface for monitoring simulation progress during execution.
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.
Represents the state of a process stream with key thermodynamic properties.
Result of state validation.
Interface for process templates that define standard configurations.
Analyzes the topology (graph structure) of a process system.
Node in the process graph representing an equipment unit.
Edge in the process graph representing a stream connection.
Validates a process system for mass balance closure, energy balance closure, and operating limit
violations.
Severity level for a validation issue.
Represents a single validation issue found during process validation.
Accessor for reading and writing process variables by path.
High-level model for produced water degassing systems with emissions calculation.
Factory class for creating produced water thermodynamic systems with the Electrolyte-CPA EOS.
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.
Analyzer for assessing production impact of equipment failures.
Result of a production impact analysis for equipment failure scenarios.
Recommended operating mode after equipment failure.
Immutable production load for one planning period in a host tie-in study.
Loader for YAML/JSON optimization specification files.
Constraint specification in the YAML/JSON file.
Objective specification in the YAML/JSON file.
Individual scenario configuration from YAML/JSON.
Root element of the specification file.
Variable specification for multi-variable optimization.
Production optimization utility for process simulation models.
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 for multi-variable optimization.
Objective optimization direction.
Builder-style configuration for the production optimizer.
Constraint on a process-level metric such as total power, pressure, or temperature.
Container for optimization objective configuration.
Result container for a completed optimization attempt.
Lightweight summary of an optimization run intended for quick-consumption APIs.
A single point on the Pareto front representing a non-dominated solution.
Result of a multi-objective Pareto optimization containing the Pareto front.
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.
Represents a production profile during an equipment failure event.
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.
Time point in production profile.
Generates production decline profiles using Arps decline curve analysis.
Decline curve type enumeration.
Fitted decline case from production history.
Ordered production profile for host base production or satellite production.
Progress tracking for long-running MCP simulations.
A milestone event.
Progress state for a single operation.
PropaneCoolingModule class.
PropertyGenerator class.
Container for gradients of a scalar thermodynamic property with respect to state variables.
Stateless property table runner for MCP integration.
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.
Unified PT phase envelope calculation using the Michelsen continuation method.
PTphaseEnvelopeNew3 class.
PUflash class.
Centrifugal pump simulation model for process systems.
Capacity strategy for pump equipment.
Pump performance curve handler for centrifugal pump simulation.
Alternative pump chart implementation extending the compressor chart with map lookup and
extrapolation, adding pump-specific features: NPSH curves, density correction, viscosity
correction (HI method), BEP identification, specific speed, and operating status monitoring.
PumpChartInterface interface.
Cost estimation class for pumps.
PumpCurve class.
Electrical design for pumps.
PumpInterface interface.
Mechanical design calculations for centrifugal pumps per API 610.
Pump type classification per API 610.
Inner class to hold validation results.
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-Vapor Fraction (PVF) flash calculation.
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.
Stateless PVT simulation runner for MCP integration.
Pyrolysis reactor for thermal decomposition of biomass in the absence of oxygen.
Pyrolysis mode enumeration.
QfuncFlash class.
Represents a valve with a quick opening flow characteristic.
RachfordRice classes.
RachigRingPacking class.
Spencer-Danner modified Rackett equation for saturated liquid density.
Represents a radial thermal layer for multi-layer heat transfer calculations in pipelines.
Predefined layer material types with default properties.
Random controller for baseline comparison.
Rate-based packed column absorber using the two-film model with mass transfer coefficients.
Enhancement factor model for chemical absorption.
Mass transfer correlation model.
Stage-by-stage calculation result container.
Counter-current rate-based packed column for non-reactive absorption and stripping.
JSON report DTO.
Internal residual evaluation container for the equation-oriented column solver.
Column-level profile solver options.
Internal column state reconstructed from equation-oriented unknowns.
Internal counter-current solution container.
Film-model options for component transfer across the gas-liquid interface.
Heat-transfer options for gas-liquid heat exchange in the packed section.
Interface equilibrium data for one segment.
Mass-transfer correlation options for the packed-column film coefficients.
Internal segment computation container.
Internal residual evaluation container for the simultaneous segment solver.
Segment result data for a rate-based packed column.
Segment-level coupling options.
Internal sparse Jacobian assembled by the equation-oriented column solver.
Internal transport-property snapshot.
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.
Reactive multiphase PH flash: simultaneous chemical equilibrium, phase equilibrium, and enthalpy
balance.
Multiphase TP flash with simultaneous chemical and phase equilibrium using the modified RAND
method.
Reactive stability analysis for simultaneous chemical and phase equilibrium.
A distillation tray that performs reactive equilibrium (simultaneous chemical equilibrium + phase
equilibrium) instead of standard VLE.
Container for axial profiles from plug flow reactor simulation.
Capacity strategy for reactor equipment.
ReactorData class.
Mechanical design for reactor vessels per ASME VIII Div 1.
Real-time Risk Assessment Result.
Process variable deviation status.
Safety system status summary.
Real-time Risk Monitor for Digital Twin Integration.
Interface for alert listeners.
Alert thresholds configuration.
Equipment-specific risk status.
Risk alert generated by monitor.
Reboiler class.
ReBoiler class.
Generates feed fluids at different GOR by recombining gas and oil phases.
Recombine class.
Result of a data reconciliation run.
A measured process variable participating in data reconciliation.
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.
Represents an IEC 81346 reference designation for a process element.
Generates IEC 81346 reference designations for all elements in a
ProcessSystem or
ProcessModel.Represents a single generated IEC 81346 designation entry.
ReferencePotComparator class.
Refractive index-based approach for asphaltene stability screening.
Stability classification based on RI difference.
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.
Relative permeability table generator supporting Corey and LET models.
Enumeration of release orientations for leak and rupture scenarios.
Data source for equipment reliability data (MTBF, MTTR, failure modes).
Failure mode data holder.
Equipment reliability data holder.
Dynamic relief valve (PSV) sizing for fire scenarios per API 521.
Result container for liquid PSV sizing calculations per API 520 Section 5.8.
Result container for PSV sizing calculations.
Enumeration of relative permeability model families.
Enumeration of relative permeability table types for reservoir simulation.
Report class.
Configuration options for JSON reporting.
Level of detail to include in reports.
Report generator that transforms simulation results into structured engineering 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.
Stateless reservoir simulation runner for MCP integration.
ReservoirTPsim class.
Provenance metadata for every MCP calculation result.
Rhone-Poulenc maximum velocity calculation for gas pipes.
Service type for Rhone-Poulenc velocity calculation.
Riser equipment class for subsea and offshore applications.
Types of risers with different geometry profiles and mechanical characteristics.
Configuration factory for creating risers with standard geometry profiles.
Types of risers with different geometry profiles.
Mechanical design class for risers.
Calculator for riser-specific mechanical design.
Data source for loading riser mechanical design parameters from the NeqSim database.
Riser design parameters holder.
Represents a risk event for probabilistic safety analysis.
Builder class for RiskEvent.
Consequence severity categories per industry standards.
Quick-start examples for the NeqSim Advanced Risk Framework.
Risk Matrix for equipment failure analysis.
Consequence categories (1-5).
Probability categories (1-5).
Risk assessment for a single equipment.
Risk level categories.
Machine Learning Integration Interface for Risk Assessment.
Feature extractor for process data.
Machine learning model wrapper.
ML prediction result.
Functional interface for ML model prediction.
Model performance metrics.
Prediction record for history tracking.
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.
Rotary vacuum filter for bio-processing solid-liquid separation.
RuptureDisk class - represents a rupture disk (bursting disc) safety device.
Sachdeva et al. (1986) mechanistic model for two-phase choke flow.
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.
Represents a Safety Instrumented Function (SIF) for risk reduction calculation.
Builder for SafetyInstrumentedFunction.
SIF categories.
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.
Calculates the mass of mineral scale that would precipitate from a supersaturated brine.
Inner class to hold scale mass results for a single mineral.
ScalePotentialCheckStream class.
Scale tendency prediction for common oilfield mineral scales.
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.
Catalog of JSON schemas for MCP tool input and output declarations.
Screw press for bio-processing dewatering.
LNG scrub column model for heavy hydrocarbon removal prior to liquefaction.
Security and multi-tenancy layer for the NeqSim MCP server.
An audit log entry.
Rate limiting state for a user.
User context associated with an API key.
Example demonstrating selective logic execution in ProcessScenarioRunner.
Monte Carlo sensitivity analysis for field development uncertainty quantification.
One-dimensional parameter sensitivity analysis for process simulations.
Probability distribution types for uncertain parameters.
Complete Monte Carlo analysis result.
Configuration for sensitivity analysis.
Results of a sensitivity analysis sweep.
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.
Types of sensor faults that can be injected into a measurement device for dynamic simulation
testing.
SeparationTrainModule class.
SeparationTrainModuleSimple class.
Separator class.
Builder class for constructing Separator instances with a fluent API.
RL agent for separator level and pressure control.
Capacity strategy for separator equipment.
Multi-agent example: Separator + Compressor train.
Contract for separator equipment.
Cost estimation class for separators.
Data point for separator test experiment.
SeparatorDesignStandard class.
Electrical design for separators.
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.
Precise separator geometry calculations for horizontal and vertical vessels.
Gymnasium-compatible separator control environment.
Example demonstrating separator heat input capabilities with flare integration.
Instrument design for separators.
SeparatorInterface interface.
Database of separator internals and inlet device performance data.
Data record for an inlet device specification.
Data record for a separator internals specification.
Data record for a vendor-certified grade efficiency curve from factory acceptance testing (FAT).
Example RL environment for separator level control.
SeparatorMechanicalDesign class.
Inner class to hold validation results.
Response class for separator mechanical design JSON export.
Calculates detailed separation performance for a separator or scrubber using droplet size
distributions and grade efficiency curves.
Summary for batch calibration against multiple cases.
One field/vendor calibration case with modeled and measured entrainment fractions.
Result object for one-point calibration of entrainment factors.
SeparatorResponse class.
Performance metrics for separator rating studies.
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.
Sequential Function Chart (SFC) implementation following the IEC 61131-3 standard concept.
A step in the Sequential Function Chart.
A transition between two steps in the SFC.
SerializationManager class.
Stateful session runner that maintains live ProcessSystem instances across multiple MCP calls.
Internal session state holder.
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.
Shah condensation heat transfer correlation for in-tube and shell-side condensation.
Shell and tube heat exchanger design calculator per TEMA standards.
Short-cut distillation column using the Fenske-Underwood-Gilliland (FUG) method.
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.
SIL Verification Result.
Component contribution to overall PFD.
Verification issue found during analysis.
SimpleAbsorber class.
SimpleAdsorber class.
Simple amine absorber model for acid gas removal (CO2 and H2S).
Result of a single design check.
SimpleFlowLine class.
SimpleReservoir class.
SimpleTEGAbsorber class.
Simple pipeline model with specified outlet temperature and pressure.
SimpleTray class.
Base class for process simulation objects.
Interface for simulation objects.
SimulationInterface interface.
Automated quality gate for simulation results validation.
Represents a single quality gate issue.
Issue severity levels.
Structured result of a simulation build or execution.
Detailed error information for a specific issue.
Status of the simulation result.
AI-friendly validation helper for NeqSim simulations.
Describes a single variable exposed by a unit operation in a process simulation.
Variable access type.
Sips (Langmuir-Freundlich) adsorption isotherm implementation.
Risk model integrated with Safety Instrumented Systems (SIS).
Consequence types for risk criteria.
Independent Protection Layer (IPL) for LOPA.
IPL types.
Risk tolerance criteria for SIL determination.
Result from SIS-integrated risk analysis.
Result for a single event's mitigation.
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.
Solids centrifuge for bio-processing solid-liquid separation.
Solids separator for bio-processing applications.
SolutionGasWaterRatio class.
Calculation method for Rsw.
Container for time-series release source term data.
Sour service material assessment per NACE MR0175 / ISO 15156.
Generates a recommended spare parts inventory from a
ProcessSystem.A single spare part entry.
Template for a spare part associated with an equipment type.
Detects spinodal decomposition conditions in thermodynamic systems.
Enumeration of thermodynamic stability states.
Split-range control structure where a single controller drives two or more final control elements
(e.g. valves).
Splitter class.
Capacity strategy for splitter equipment.
Cost estimation class for splitters.
SplitterInterface interface.
Mechanical design class for splitter equipment.
SplitterResponse class provides basic reporting for a splitter unit.
Inline spreadsheet / calculator block for embedding custom calculations directly in a flowsheet.
Base interface for cell definitions.
Cell with a constant value.
Internal record for export targets.
Functional interface for writing a computed value to process equipment.
Cell computed by a formula referencing other cells.
Cell that reads from process equipment.
Cell that reads from a stream.
Sequential Quadratic Programming (SQP) optimizer for constrained process optimization.
Functional interface for constraint functions.
Functional interface for the objective function.
Optimization result container.
Abstract Standard class.
Implementation of AGA Report No. 3 (API 14.3 / ISO 5167) - Orifice Metering of Natural Gas and
Other Related Hydrocarbon Fluids.
Implementation of AGA Report No. 7 / ISO 12242 - Measurement of gas flow in closed conduits -
Ultrasonic meters for gas.
ASTM D2500 - Standard Test Method for Cloud Point of Petroleum Products and Liquid Fuels.
ASTM D4052 / ISO 12185 - Standard Test Method for Density, Relative Density, and API Gravity of
Liquids.
ASTM D4294 / ISO 8754 - Standard Test Method for Sulfur in Petroleum Products.
ASTM D445 - Standard Test Method for Kinematic Viscosity of Transparent and Opaque Liquids.
Standard_ASTM_D6377 class.
ASTM D86 - Standard Test Method for Distillation of Petroleum Products and Liquid Fuels at
Atmospheric Pressure.
ASTM D97 - Standard Test Method for Pour Point of Petroleum Products.
BS&W - Basic Sediment and Water determination for crude oil.
Implementation of EN 16723 - Natural gas and biomethane for use in transport and biomethane for
injection in the natural gas network.
Implementation of EN 16726 - Gas infrastructure - Quality of gas - Group H.
Implementation of GPA 2145 - Table of Physical Constants of Paraffin Hydrocarbons and Other
Components of Natural Gas.
Implementation of GPA 2172 - Calculation of Gross Heating Value, Relative Density,
Compressibility and Theoretical Hydrocarbon Liquid Content for Natural Gas Mixtures for Custody
Transfer.
Implementation of ISO 12213 - Natural gas - Calculation of compression factor.
Implementation of ISO 13443 - Natural gas - Standard reference conditions.
Implementation of ISO 14687 - Hydrogen fuel quality - Product specification.
Implementation of ISO 15112 - Natural gas - Energy determination.
Standard_ISO15403 class.
Implementation of ISO 18453 - Natural gas - Correlation between water content and water dew
point.
Implementation of ISO 23874 - Natural gas - Gas chromatographic requirements for hydrocarbon dew
point calculation.
Standard_ISO6578 class.
Implementation of ISO 6974 - Natural gas - Determination of composition and associated
uncertainty by gas chromatography.
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.
Standard constraint types commonly used across process equipment.
StandardInterface interface.
Standard optimization objectives commonly used in process optimization.
Registry and factory for creating design standards based on international standards.
Stateless standards calculation runner for MCP integration.
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.
Simulation state persistence for the NeqSim MCP server.
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.
Steady-State Detector (SSD) for process variables.
Result of a steady-state detection evaluation.
A monitored process variable for steady-state detection.
Heater for process streams using condensing steam as heating medium.
Steam turbine for power generation from a high-pressure steam stream.
Steam turbine driver model.
Turbine type enumeration.
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.
Stirred tank reactor (CSTR) for bio-processing and chemical operations.
Simple stoichiometric reaction model for bio-processing.
StoneWallCurve defines the compressor stone wall (choke) limit.
StratifiedFlowNode class.
Stream class.
Contract for process streams.
Interface for high-frequency real-time data streaming.
Streaming simulation runner that executes long-running operations asynchronously and provides
incremental result polling.
Internal state for a streaming operation.
StreamInterface interface.
Abstract MeasurementDeviceBaseClass class.
StreamResponse class.
StreamSaturatorUtil class.
StreamTransition class.
Validators for process streams (StreamInterface).
Study classification for engineering deliverables.
Enumeration of engineering deliverable types.
Exports NeqSim process models in SubrModl format for nonlinear MPC integration.
Model parameter definition.
State variable (SVR) definition.
SubrXvr definition for variable linking.
Subsea Booster equipment class.
Booster type.
Compressor type for gas service.
Drive type.
Pump type for liquid and multiphase service.
Mechanical design class for Subsea Booster equipment.
Cost estimation calculator for subsea SURF equipment.
Cost currency.
Region for cost adjustment.
Capacity strategy for subsea equipment.
Subsea Jumper equipment class.
Connection hub type.
Jumper type configurations.
Mechanical design class for Subsea Jumper equipment.
Subsea Production Manifold equipment class.
Manifold type configuration.
Valve skid configuration for each slot.
Mechanical design class for Subsea Manifold equipment.
Subsea power cable model for offshore wind farm export and inter-array connections.
Cable insulation type.
Unified subsea production system for field development workflow integration.
Subsea architecture configuration.
Result container for subsea production system analysis.
Subsea Tree (Christmas Tree) equipment class.
Pressure rating class per API 17D.
Subsea tree type configurations.
Mechanical design class for Subsea Tree (Christmas Tree) equipment.
Subsea well equipment class.
Completion type.
Rig type used for drilling.
Well type classification.
Analyser for elemental sulfur formation, deposition, and corrosion in natural gas systems.
Sulfur filter for removing solid elemental sulfur (S8) from gas streams.
Mechanical design for sulfur filter vessels per ASME VIII Div 1.
SulfurSpecificationMethod class.
SurfaceTension class.
SurfaceTensionInterface interface.
SURF (Subsea, Umbilicals, Risers, Flowlines) CAPEX estimator for field development.
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.
Sustainability and life-cycle metrics tracker for biorefinery processes.
Internal emission entry record.
Emission source type for itemised tracking.
SwellingTest class.
Model of switchgear / motor control center (MCC) bucket for process electrical systems.
sysNewtonRhapson class.
sysNewtonRhapsonPhaseEnvelope class.
sysNewtonRhapsonPHflash class.
Newton-Raphson solver for two-phase TP flash using Michelsen's u-variable formulation.
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.
Plant-wide electrical design summary and power distribution analysis.
This class defines a thermodynamic system using the Electrolyte CPA EoS of Equinor.
Thermodynamic system using the e-CPA-Advanced electrolyte equation of state.
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.
Plant-wide instrument design summary.
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 for the aqueous phase and SRK EOS for gas and
optional oil phases.
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.
Thermodynamic system combining the Peng-Robinson EOS with the Lee-Kesler BWR method for
enthalpy/entropy/Cp departures (PR-LK).
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.
Thermodynamic system using the SAFT-VR Mie equation of state (Lafitte et al. 2013).
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.
Thermodynamic system using the Anderson-accelerated nested CPA-EOS algorithm.
Thermodynamic system using the Anderson-accelerated nested CPA-EOS with site symmetry reduction.
Thermodynamic system using the Broyden quasi-Newton implicit CPA-EOS algorithm.
Thermodynamic system using the fully implicit CPA-EOS algorithm.
Thermodynamic system using the fully implicit CPA-EOS with site type reduction.
Thermodynamic system using the reduced-dimension CPA-EOS solver with Broyden acceleration.
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.
Capacity strategy for tank equipment.
Cost estimation class for storage tanks.
Defines the physical geometry of an LNG cargo tank.
Tank containment type enumeration.
Multi-zone heat transfer model for LNG cargo tanks.
A single heat transfer zone with its own U-value, area, and boundary condition.
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.
Validates task results.json files against the expected schema for NeqSim task-solving workflows.
Report of validation results for a results.json file.
A single validation issue.
Task solver and multi-domain composition runner.
A step in an execution plan.
Result of executing a step.
Bridges MCP tool outputs to the task_solve results.json format used by the NeqSim engineering
task-solving workflow.
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.
TEMA (Tubular Exchanger Manufacturers Association) standard designations for shell and tube heat
exchangers.
Baffle types per TEMA.
TEMA front head types (stationary head).
TEMA rear head types.
TEMA shell types.
Standard tube sizes per TEMA.
TEMA class for construction standards.
Represents a complete TEMA configuration.
Standard tube pitches per TEMA.
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.
Thermal-hydraulic design calculator for shell and tube heat exchangers.
Shell-side analysis method selection.
Defines a thermal zone for zone-by-zone analysis.
Results for a single thermal zone.
Aggregates thermal utility requirements across a process system.
Represents a single utility consumer (equipment with its utility type and flow).
ThermodynamicConstantsInterface interface.
Thermodynamic coupling for the two-fluid transient pipe model.
Result container for thermodynamic property update.
ThermodynamicModelSettings interface.
Mutable per-thread flag holder.
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.
Template for creating a three-stage separation train.
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.
Describes a multi-segment subsea tieback route for screening studies.
Builder for tieback route networks.
One route-network segment with screening-level geometry and thermal data.
Segment type used to classify route-network parts.
Time-series host tie-in planner for capacity allocation, satellite holdback, process-model
checks, and debottleneck recommendations.
Nameplate allocation result.
Process-adjusted allocation result.
Process-model capacity outcome.
Aggregated result from a host tie-in capacity and holdback study.
Capacity, holdback, and bottleneck result for one host tie-in planning period.
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.
Topside piping equipment class for offshore platforms and onshore facilities.
Insulation type for topside piping.
Pipe schedule for wall thickness selection.
Service types for topside piping with different design requirements.
Mechanical design class for topside (offshore platform and onshore facility) piping.
Calculator for topside piping mechanical design based on industry standards.
Data source for topside piping mechanical design parameters.
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.
TP flash for SAFT-VR Mie equation of state.
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.
Transfer function block for representing control dynamics in dynamic simulation.
Transfer function types supported by this block.
Model of a power transformer for process electrical systems.
Statistics for transient production losses.
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 wellbore model for simulating shutdown cooling and depressurization.
A snapshot of the wellbore state at a single time step.
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.
Tray hydraulics calculator for distillation column internals sizing.
TrayInterface interface.
Action to trip (de-energize) an ESD valve, causing fail-safe closure.
TSFlash class.
Enhanced tube insert models for heat exchanger performance improvement.
Type of tube insert enhancement device.
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.
Temperature-Volume flash calculation.
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.
OLGA model type for holdup and flow regime calculations.
Slug tracking mode.
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.
Two-phase pressure drop correlations for heat exchanger design.
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.
Tyn-Calus method for liquid-phase binary diffusion coefficients at infinite dilution.
UKspecifications_ICF_SI class.
Subsea Umbilical equipment class.
Umbilical cross-section configuration.
Functional element in umbilical.
Umbilical construction type.
Mechanical design class for Umbilical equipment.
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.
Stores a P10/P50/P90 range for a field-development assumption.
Result of an uncertainty propagation analysis for a process simulation.
UNIFACgroup class.
Generic UniSim calculation block used when importing UniSim operations that carry process stream
topology but do not have a one-to-one physical NeqSim equivalent.
Unit interface.
Base class for equipment cost estimation.
Units class.
Models utility air systems for offshore and onshore facilities.
Air consumer (equipment or system using compressed air).
ISO 8573-1 Air Quality Classes.
Air compressor type.
Air dryer type.
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.
Domain-specific validation profiles for engineering simulations.
Common validation result container for NeqSim components.
Severity level for validation issues.
A single validation issue.
Pre-flight validator for NeqSim JSON inputs (flash or process definitions).
Represents a single validation issue.
Unit class nested within Units.
A numeric value with its associated unit.
Capacity strategy for valve equipment.
An interface for defining the flow characteristic of a valve.
Cost estimation class for valves.
ValveDesignStandard class.
Instrument design for control and safety valves.
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.
Model of a Variable Frequency Drive (VFD) for motor speed control.
Vega class.
VesselDepressurization models dynamic filling and depressurization of pressure vessels.
Calculation type for vessel thermodynamics.
Fire model type for external fire heat transfer.
Preset fire type configurations per industry standards.
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.
Flow-induced vibration analysis for shell and tube heat exchangers.
Results of vibration screening analysis.
Vibration assessment for piping and equipment per Energy Institute guidelines and API 618.
Likelihood of failure from Energy Institute main-line screening.
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.
Experimental viscosity data point for PVT regression.
ViscosityFunction class.
ViscosityFunction class.
ViscosityInterface interface.
ViscositySim class.
ViscosityWaxOilSim class.
Generates inline visual content (SVG charts, Mermaid diagrams, HTML tables) that can be rendered
directly in chat interfaces supporting rich content.
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.
Pre-built biorefinery module for waste-to-energy combined heat and power (CHP).
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.
Screens two water sources for compatibility by evaluating mineral scale risk at different mixing
ratios.
Result at a single mixing ratio.
Thermal conductivity of pure water and steam using polynomial correlations fitted to NIST WebBook
reference data.
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.
Water and brine property correlations for reservoir engineering.
WaterStripperColumn class.
WaxCharacterise class.
Calculator for wax fraction curves with monotonicity enforcement.
WaxDepositionFlowNode class.
WaxFractionSim class.
WaxFunction class.
WaxModelInterface interface.
Well class.
WellAllocator class.
WellAllocatorResponse class.
Well barrier schematic per NORSOK D-010 Section 5.
Cost estimation calculator for subsea wells.
Calculator for well casing and tubing mechanical design.
WellFlow class - Inflow Performance Relationship (IPR) model for reservoir-to-wellbore flow.
Flow direction mode for the well.
Inflow performance models supported by the well.
Represents a single reservoir layer for commingled well production or injection.
Capacity strategy for well flow equipment.
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.
Mechanical design class for subsea wells.
Loads well design parameters from CSV standards databases.
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.
Wilke-Chang method for liquid-phase binary diffusion coefficients at infinite dilution.
WilkeLeeDiffusivity class.
Offshore/onshore wind farm model aggregating multiple turbines with power curves and wake losses.
Simple wind turbine model based on actuator disk theory.
Result container for field development workflow execution.
Utility class for XML parsing and writing.
Standalone Z-factor (gas compressibility factor) correlations.