neqsim-api-patterns

NeqSim API Patterns

Copy-paste reference for common NeqSim operations. All Java code must be Java 8 compatible.

MCP Runtime Capability Routing

When a calculation is not exposed by a curated MCP domain tool, use the generic runtime index before proposing a new tool:

1. Search with runCapability({"action":"search","query":"<domain method>"}).
2. Inspect the selected class with inspectApi to pin the deployed signature.
3. Follow the returned route:
   • static-json: invoke through runCapability with exact className, methodName, parameterTypes, and ordered JSON arguments.
   • process-json: build the stateful equipment through runProcess.
   • inspect-only: use a curated tool or add an explicit, reviewed adapter.

Discovery is broader than execution by design. runCapability only invokes public static methods in approved domain packages with scalar, enum, or bounded-array JSON types; MCP runners, raw generic containers, oversized payloads, arbitrary objects, and instance methods are excluded. Its timeout uses cooperative Java interruption, so route long-running calculations through a curated runner or runProcess. Treat runtime presence as capability evidence, then check tests, benchmark trust, and standards before using the result for engineering decisions.

EOS Selection Guide

Fluid Type	Java Class	Mixing Rule
Dry/lean gas, simple HC	SystemSrkEos	"classic"
General hydrocarbons, oil	SystemPrEos	"classic"
Matched to commercial simulator PR-LK	SystemPrLeeKeslerEos	"classic"
Water, MEG, methanol, polar	SystemSrkCPAstatoil	10 (numeric)
Custody transfer, fiscal metering	SystemGERG2008Eos	(none needed)
Electrolyte systems, hydrate with salt brine	SystemElectrolyteCPAstatoil	10
Volume-corrected SRK	SystemSrkEosvolcor	"classic"

PR-LK vs PR78: SystemPrLeeKeslerEos uses PR76 alpha for ALL ω: m = 0.37464 + 1.54226ω − 0.26992ω². Standard SystemPrEos1978 uses a modified cubic for ω > 0.49. Use PR-LK when matching commercial simulator models that use this EOS label.