Class SimulationValidator

java.lang.Object
neqsim.util.validation.SimulationValidator
public final class SimulationValidator extends Object
AI-friendly validation helper for NeqSim simulations.

Provides a unified interface for validating NeqSim objects. AI agents can use this class to validate setup before execution and get actionable remediation advice.

Usage:


// Validate before running
ValidationResult result = SimulationValidator.validate(system);
if (!result.isValid()) {
  // Parse result.getReport() for fixes
  System.out.println(result.getReport());
}

// Validate after running
stream.run();
ValidationResult postResult = SimulationValidator.validateOutput(stream);
Version:
1.0
Author:
NeqSim

  • Constructor Details

    • SimulationValidator

      private SimulationValidator()

  • Method Details

    • validate

      public static ValidationResult validate(Object obj)
      Validate any NeqSim object before execution.

      Automatically detects the object type and applies appropriate validation.

      Parameters:
      obj - object to validate (SystemInterface, StreamInterface, ProcessSystem, etc.)
      Returns:
      validation result with errors/warnings and remediation hints

    • validateOutput

      public static ValidationResult validateOutput(Object obj)
      Validate object output after execution.

      Checks postconditions to ensure the calculation produced valid results.

      Parameters:
      obj - object to validate (after run() has been called)
      Returns:
      validation result with any output issues

    • validateAndRun

      public static ValidationResult validateAndRun(ProcessEquipmentInterface equipment)
      Validate and run if valid.

      Convenience method that validates preconditions, runs if valid, then validates output.

      Parameters:
      equipment - process equipment to validate and run
      Returns:
      combined validation result (pre + post)

    • validateAndRun

      public static ValidationResult validateAndRun(ProcessSystem processSystem)
      Validate and run a process system.
      Parameters:
      processSystem - process system to validate and run
      Returns:
      validation result

    • getExceptionRemediation

      private static String getExceptionRemediation(Exception e)
      Get remediation advice for an exception.
      Parameters:
      e - the exception
      Returns:
      remediation string

    • isReady

      public static boolean isReady(Object obj)
      Quick check if an object is ready for simulation.
      Parameters:
      obj - object to check
      Returns:
      true if valid, false otherwise

    • getValidationReport

      public static String getValidationReport(Object... objects)
      Get a summary report for multiple objects.
      Parameters:
      objects - objects to validate
      Returns:
      combined report