Class ThermodynamicSystemContract

java.lang.Object

neqsim.util.validation.contracts.ThermodynamicSystemContract

All Implemented Interfaces:

ModuleContract<SystemInterface>

public class ThermodynamicSystemContract
extends Object
implements ModuleContract<SystemInterface>

Contract for thermodynamic systems.

Defines requirements and guarantees for SystemInterface implementations. AI agents can use this contract to validate fluid setup before running simulations.

Preconditions (what the system needs):

• At least one component defined
• Temperature > 0 K
• Pressure > 0 bar
• Mixing rule set for multi-component systems
• Total moles > 0

Postconditions (what init() provides):

• Valid phase fractions (sum to 1.0)
• Finite compressibility factor
• Finite enthalpy and entropy

Version:

1.0

Author:

NeqSim

Field Summary

Fields

Modifier and Type	Field	Description
private static final ThermodynamicSystemContract	INSTANCE	Singleton instance.
private static final double	MIN_PRESSURE_BAR	Minimum valid pressure in bar.
private static final double	MIN_TEMPERATURE_K	Minimum valid temperature in Kelvin.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ThermodynamicSystemContract()

Method Summary

Modifier and Type	Method	Description
ValidationResult	checkPostconditions(SystemInterface system)	Check postconditions after execution.
ValidationResult	checkPreconditions(SystemInterface system)	Check preconditions before execution.
String	getContractName()	Get the name of this contract.
static ThermodynamicSystemContract	getInstance()	Get the singleton instance.
String	getProvidesDescription()	Get a description of what this module provides.
String	getRequirementsDescription()	Get a description of what this module requires.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

private static final ThermodynamicSystemContract INSTANCE

Singleton instance.

MIN_TEMPERATURE_K

private static final double MIN_TEMPERATURE_K

Minimum valid temperature in Kelvin.

See Also:

• Constant Field Values

MIN_PRESSURE_BAR

private static final double MIN_PRESSURE_BAR

Minimum valid pressure in bar.

See Also:

• Constant Field Values

Constructor Details

ThermodynamicSystemContract

private ThermodynamicSystemContract()

Method Details

getInstance

public static ThermodynamicSystemContract getInstance()

Get the singleton instance.

Returns:

contract instance

getContractName

public String getContractName()

Description copied from interface: ModuleContract

Get the name of this contract.

Specified by:

getContractName in interface ModuleContract<SystemInterface>

Returns:

contract name for logging/debugging

checkPreconditions

public ValidationResult checkPreconditions(SystemInterface system)

Description copied from interface: ModuleContract

Check preconditions before execution.

Validates that all requirements are met before running the module.

Specified by:

checkPreconditions in interface ModuleContract<SystemInterface>

Parameters:

system - object to validate

Returns:

validation result with any precondition failures

checkPostconditions

public ValidationResult checkPostconditions(SystemInterface system)

Description copied from interface: ModuleContract

Check postconditions after execution.

Validates that the module produced valid output.

Specified by:

checkPostconditions in interface ModuleContract<SystemInterface>

Parameters:

system - object to validate

Returns:

validation result with any postcondition failures

getRequirementsDescription

public String getRequirementsDescription()

Description copied from interface: ModuleContract

Get a description of what this module requires.

AI agents can use this to understand setup requirements.

Specified by:

getRequirementsDescription in interface ModuleContract<SystemInterface>

Returns:

human-readable requirements description

getProvidesDescription

public String getProvidesDescription()

Description copied from interface: ModuleContract

Get a description of what this module provides.

AI agents can use this to understand available outputs.

Specified by:

getProvidesDescription in interface ModuleContract<SystemInterface>

Returns:

human-readable outputs description