Class ExampleCatalog

java.lang.Object
neqsim.mcp.catalog.ExampleCatalog
public final class ExampleCatalog extends Object
Catalog of example JSON inputs for each MCP runner.

Provides ready-to-use example JSON strings for flash calculations, process simulations, component queries, and validation. These examples serve a dual purpose:

  • MCP Resources — served via neqsim://example/{category}/{name} URIs so that language models can read them and learn the input format
  • Test fixtures — used by unit tests to verify runners work correctly

All methods are static and return JSON strings that can be passed directly to the corresponding runner's run(String) method.

Version:
1.0
Author:
Even Solbraa

  • Field Details

    • GSON

      private static final com.google.gson.Gson GSON

  • Constructor Details

    • ExampleCatalog

      private ExampleCatalog()
      Private constructor — all methods are static.

  • Method Details

    • flashTPSimpleGas

      public static String flashTPSimpleGas()
      Returns a simple TP flash of a natural gas.
      Returns:
      JSON string for FlashRunner.run()

    • flashTPTwoPhase

      public static String flashTPTwoPhase()
      Returns a two-phase TP flash example.
      Returns:
      JSON string for FlashRunner.run()

    • flashDewPointT

      public static String flashDewPointT()
      Returns a dew point temperature flash example.
      Returns:
      JSON string for FlashRunner.run()

    • flashBubblePointP

      public static String flashBubblePointP()
      Returns a bubble point pressure flash example.
      Returns:
      JSON string for FlashRunner.run()

    • flashCPAWithWater

      public static String flashCPAWithWater()
      Returns a CPA model flash with water for hydrate-forming systems.
      Returns:
      JSON string for FlashRunner.run()

    • processSimpleSeparation

      public static String processSimpleSeparation()
      Returns a minimal stream + separator process.
      Returns:
      JSON string for ProcessRunner.run()

    • processCompressionWithCooling

      public static String processCompressionWithCooling()
      Returns a compression process with cooling.
      Returns:
      JSON string for ProcessRunner.run()

    • batchTemperatureSweep

      public static String batchTemperatureSweep()
      Returns a batch temperature sweep example with 3 cases.
      Returns:
      JSON string for BatchRunner.run()

    • batchPressureSweep

      public static String batchPressureSweep()
      Returns a batch pressure sweep example with 4 cases.
      Returns:
      JSON string for BatchRunner.run()

    • propertyTableTemperatureSweep

      public static String propertyTableTemperatureSweep()
      Returns a property table temperature sweep example.
      Returns:
      JSON string for PropertyTableRunner.run()

    • propertyTablePressureSweep

      public static String propertyTablePressureSweep()
      Returns a property table pressure sweep example.
      Returns:
      JSON string for PropertyTableRunner.run()

    • phaseEnvelopeNaturalGas

      public static String phaseEnvelopeNaturalGas()
      Returns a phase envelope example for a natural gas.
      Returns:
      JSON string for PhaseEnvelopeRunner.run()

    • validationErrorFlash

      public static String validationErrorFlash()
      Returns a flash input with known validation errors (unknown component, invalid model).
      Returns:
      JSON string for Validator.validate()

    • pvtCME

      public static String pvtCME()
      Returns a CME experiment example.
      Returns:
      JSON string for PVTRunner.run()

    • pvtSaturationPressure

      public static String pvtSaturationPressure()
      Returns a saturation pressure experiment example.
      Returns:
      JSON string for PVTRunner.run()

    • flowAssuranceHydrate

      public static String flowAssuranceHydrate()
      Returns a hydrate risk map analysis example.
      Returns:
      JSON string for FlowAssuranceRunner.run()

    • standardISO6976

      public static String standardISO6976()
      Returns an ISO 6976 standard calculation example.
      Returns:
      JSON string for StandardsRunner.run()

    • pipelineMultiphase

      public static String pipelineMultiphase()
      Returns a pipeline simulation example.
      Returns:
      JSON string for PipelineRunner.run()

    • reservoirDepletion

      public static String reservoirDepletion()
      Returns a simple reservoir depletion example.
      Returns:
      JSON string for ReservoirRunner.run()

    • economicsNorwegianNCS

      public static String economicsNorwegianNCS()
      Returns a Norwegian NCS cash flow example.
      Returns:
      JSON string for FieldDevelopmentRunner.run()

    • economicsDeclineCurve

      public static String economicsDeclineCurve()
      Returns a production profile generation example.
      Returns:
      JSON string for FieldDevelopmentRunner.run()

    • bioprocessAnaerobicDigestion

      public static String bioprocessAnaerobicDigestion()
      Returns an anaerobic digestion example.
      Returns:
      JSON string for BioprocessRunner.run()

    • bioprocessGasification

      public static String bioprocessGasification()
      Returns a biomass gasification example.
      Returns:
      JSON string for BioprocessRunner.run()

    • sessionCreate

      public static String sessionCreate()
      Returns a session creation example.
      Returns:
      JSON string for SessionRunner.run()

    • sessionAddEquipment

      public static String sessionAddEquipment()
      Returns a session add-equipment example (requires a valid sessionId).
      Returns:
      JSON string for SessionRunner.run()

    • visualizationPhaseEnvelope

      public static String visualizationPhaseEnvelope()
      Returns a phase envelope visualization example.
      Returns:
      JSON string for VisualizationRunner.run()

    • visualizationBarChart

      public static String visualizationBarChart()
      Returns a bar chart visualization example.
      Returns:
      JSON string for VisualizationRunner.run()

    • visualizationFlowsheet

      public static String visualizationFlowsheet()
      Returns a flowsheet diagram visualization example.
      Returns:
      JSON string for VisualizationRunner.run()

    • sizingSeparator

      public static String sizingSeparator()
      Returns a separator sizing example.
      Returns:
      JSON string for EquipmentSizingRunner.run()

    • sizingCompressor

      public static String sizingCompressor()
      Returns a compressor sizing example.
      Returns:
      JSON string for EquipmentSizingRunner.run()

    • comparisonTwoCases

      public static String comparisonTwoCases()
      Returns a process comparison example with two cases.
      Returns:
      JSON string for ProcessComparisonRunner.run()

    • getCategories

      public static List<String> getCategories()
      Returns a list of all available example categories.
      Returns:
      unmodifiable list of category names

    • getExampleNames

      public static List<String> getExampleNames(String category)
      Returns the example names within a category.
      Parameters:
      category - the category name
      Returns:
      list of example names in that category

    • getExample

      public static String getExample(String category, String name)
      Returns an example JSON by category and name.
      Parameters:
      category - the category (flash, process, validation)
      name - the example name within that category
      Returns:
      the example JSON string, or null if not found

    • getCatalogJson

      public static String getCatalogJson()
      Returns a full catalog listing with all categories, names, and descriptions as JSON.
      Returns:
      JSON string listing all available examples