aquakin.Constraint#

class aquakin.Constraint(fn, upper=None, lower=None, name=None)[source]#

Bases: object

An inequality constraint on a design optimization.

fn(x) (a scalar function of the design vector, e.g. an effluent concentration or a total-nitrogen metric) must satisfy lower <= fn(x) <= upper. Give an upper (a permit ceiling), a lower (a floor), or both. fn should be JAX-differentiable – its gradient is taken by autodiff and handed to the optimizer.

Parameters:

  • fn (Callable)

  • upper (float | None)

  • lower (float | None)

  • name (str | None)

__init__(fn, upper=None, lower=None, name=None)#
Parameters:

  • fn (Callable)

  • upper (float | None)

  • lower (float | None)

  • name (str | None)

Return type:

None

Methods

__init__(fn[, upper, lower, name])

Attributes

lower

name

upper

fn