Class ProductionOptimizer.OptimizationConstraint

java.lang.Object

neqsim.process.util.optimizer.ProductionOptimizer.OptimizationConstraint

All Implemented Interfaces:

ProcessConstraint

Enclosing class:

ProductionOptimizer

public static final class ProductionOptimizer.OptimizationConstraint
extends Object
implements ProcessConstraint

Constraint on a process-level metric such as total power, pressure, or temperature.

Implements the unified ProcessConstraint interface so that constraints defined for the internal optimizer are interchangeable with those used by external solvers via ProcessSimulationEvaluator.

Version:

1.0

Author:

NeqSim Development Team

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description
private final ProductionOptimizer.ConstraintDirection	direction
private final double	limit
private final ToDoubleFunction<ProcessSystem>	metric
private final String	name
private final double	penaltyWeight
private final ProductionOptimizer.ConstraintSeverity	severity

Constructor Summary

Constructors

Constructor	Description
OptimizationConstraint(String name, ToDoubleFunction<ProcessSystem> metric, double limit, ProductionOptimizer.ConstraintDirection direction, ProductionOptimizer.ConstraintSeverity severity, double penaltyWeight, String description)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a human-readable description of this constraint.
ProductionOptimizer.ConstraintDirection	getDirection()	Returns the constraint direction.
double	getLimit()	Returns the constraint limit value.
String	getName()	Returns the name of this constraint.
double	getPenaltyWeight()	Returns the penalty weight for this constraint.
ProductionOptimizer.ConstraintSeverity	getSeverity()	Returns the optimizer-level severity.
ConstraintSeverityLevel	getSeverityLevel()	Returns the severity of this constraint.
static ProductionOptimizer.OptimizationConstraint	greaterThan(String name, ToDoubleFunction<ProcessSystem> metric, double limit, ProductionOptimizer.ConstraintSeverity severity, double penaltyWeight, String description)
boolean	isSatisfied(ProcessSystem process)	Checks if this constraint is satisfied for the given process state.
static ProductionOptimizer.OptimizationConstraint	lessThan(String name, ToDoubleFunction<ProcessSystem> metric, double limit, ProductionOptimizer.ConstraintSeverity severity, double penaltyWeight, String description)
double	margin(ProcessSystem process)	Computes the constraint margin for the given process state.
ProcessSimulationEvaluator.ConstraintDefinition	toConstraintDefinition()	Converts this constraint to a ProcessSimulationEvaluator.ConstraintDefinition for use with external optimizers.

Methods inherited from class Object

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

Methods inherited from interface ProcessConstraint

isHard, penalty

Field Details

name

private final String name

metric

private final ToDoubleFunction<ProcessSystem> metric

limit

private final double limit

direction

private final ProductionOptimizer.ConstraintDirection direction

severity

private final ProductionOptimizer.ConstraintSeverity severity

penaltyWeight

private final double penaltyWeight

description

private final String description

Constructor Details

OptimizationConstraint

public OptimizationConstraint(String name,
 ToDoubleFunction<ProcessSystem> metric,
 double limit,
 ProductionOptimizer.ConstraintDirection direction,
 ProductionOptimizer.ConstraintSeverity severity,
 double penaltyWeight,
 String description)

Method Details

lessThan

public static ProductionOptimizer.OptimizationConstraint lessThan(String name,
 ToDoubleFunction<ProcessSystem> metric,
 double limit,
 ProductionOptimizer.ConstraintSeverity severity,
 double penaltyWeight,
 String description)

greaterThan

public static ProductionOptimizer.OptimizationConstraint greaterThan(String name,
 ToDoubleFunction<ProcessSystem> metric,
 double limit,
 ProductionOptimizer.ConstraintSeverity severity,
 double penaltyWeight,
 String description)

getName

public String getName()

Returns the name of this constraint.

Specified by:

getName in interface ProcessConstraint

Returns:

constraint name, never null

getSeverity

public ProductionOptimizer.ConstraintSeverity getSeverity()

Returns the optimizer-level severity.

Returns:

HARD or SOFT severity

getSeverityLevel

public ConstraintSeverityLevel getSeverityLevel()

Returns the severity of this constraint.

Uses the unified ConstraintSeverityLevel enum that maps across all constraint types.

Specified by:

getSeverityLevel in interface ProcessConstraint

Returns:

constraint severity level

getPenaltyWeight

public double getPenaltyWeight()

Returns the penalty weight for this constraint.

Higher weight means constraint violations are penalized more strongly in penalty-based optimization methods.

Specified by:

getPenaltyWeight in interface ProcessConstraint

Returns:

penalty weight (non-negative)

getDescription

public String getDescription()

Returns a human-readable description of this constraint.

Specified by:

getDescription in interface ProcessConstraint

Returns:

constraint description, may be empty but never null

getLimit

public double getLimit()

Returns the constraint limit value.

Returns:

the limit

getDirection

public ProductionOptimizer.ConstraintDirection getDirection()

Returns the constraint direction.

Returns:

LESS_THAN or GREATER_THAN

margin

public double margin(ProcessSystem process)

Computes the constraint margin for the given process state.

Convention:

• margin >= 0 means the constraint is satisfied
• margin < 0 means the constraint is violated (more negative = worse)

Specified by:

margin in interface ProcessConstraint

Parameters:

process - the process system in its current state (already run)

Returns:

constraint margin (positive = satisfied, negative = violated)

isSatisfied

public boolean isSatisfied(ProcessSystem process)

Checks if this constraint is satisfied for the given process state.

Default implementation returns margin(process) >= 0.

Specified by:

isSatisfied in interface ProcessConstraint

Parameters:

process - the process system

Returns:

true if satisfied

toConstraintDefinition

public ProcessSimulationEvaluator.ConstraintDefinition toConstraintDefinition()

Converts this constraint to a ProcessSimulationEvaluator.ConstraintDefinition for use with external optimizers.

Returns:

equivalent ConstraintDefinition