bluemira.geometry.optimisation.typed

Typing for the geometry optimisation module

Classes

`GeomOptimiserObjective`	Form for a geometry optimisation objective function.
`GeomOptimiserCallable`	Form for a geometry optimiser function (derivative, constraint, etc.).
`GeomClsOptimiserCallable`	Form for a geometry optimiser function (derivative, constraint, etc.).
`GeomConstraintT`	Typing for definition of a constraint.

Module Contents

class bluemira.geometry.optimisation.typed.GeomOptimiserObjective

Bases: Protocol

Form for a geometry optimisation objective function.

__call__(geom: bluemira.geometry.parameterisations.GeometryParameterisation) → float

Call the geometry optimiser objective function.

Parameters:: geom (bluemira.geometry.parameterisations.GeometryParameterisation)
Return type:: float

class bluemira.geometry.optimisation.typed.GeomOptimiserCallable

Bases: Protocol

Form for a geometry optimiser function (derivative, constraint, etc.).

__call__(geom: bluemira.geometry.parameterisations.GeometryParameterisation) → numpy.ndarray | float

Call the geometry optimiser function.

Parameters:: geom (bluemira.geometry.parameterisations.GeometryParameterisation)
Return type:: numpy.ndarray | float

class bluemira.geometry.optimisation.typed.GeomClsOptimiserCallable

Bases: Protocol

Form for a geometry optimiser function (derivative, constraint, etc.).

__call__() → numpy.ndarray

Call the geometry optimiser function.

Return type:: numpy.ndarray

class bluemira.geometry.optimisation.typed.GeomConstraintT

Bases: TypedDict

Typing for definition of a constraint.

f_constraint: GeomOptimiserCallable

tolerance: numpy.ndarray

df_constraint: NotRequired[GeomOptimiserCallable | None]