pwrs.power_models.cvxpy.context#

Shared state and semantic registries for CVXPY power models.

class pwrs.power_models.cvxpy.context.BoundConstraint(constraint, size, indices)[source]#

Bases: object

A CVXPY bound constraint and its positions in a semantic variable.

Parameters:

  • constraint (Any)

  • size (int)

  • indices (ndarray)

class pwrs.power_models.cvxpy.context.CvxpyPowerModel(network, formulation, cone_kind, objective, result_builder, option_validator, network_build_time=0.0, model_build_time=0.0, variables=<factory>, expressions=<factory>, constraints=<factory>, constraint_senses=<factory>, objective_terms=<factory>, lower_bounds=<factory>, upper_bounds=<factory>, metadata=<factory>, _variable_result_order=(), base_variable_groups=(), base_constraint_groups=(), extension_records=(), extensions_applied=False, extension_signature=(), base_problem_class=None)[source]#

Bases: object

A built CVXPY formulation plus solver and result metadata.

Parameters:

  • network (PowerNetwork)

  • formulation (str)

  • cone_kind (str)

  • objective (Any)

  • result_builder (ResultBuilder)

  • option_validator (OptionValidator)

  • network_build_time (float)

  • model_build_time (float)

  • variables (dict[str, Any])

  • expressions (dict[str, Any])

  • constraints (dict[str, tuple[Any, ...]])

  • constraint_senses (dict[str, tuple[str, ...]])

  • objective_terms (dict[str, Any])

  • lower_bounds (dict[str, BoundConstraint])

  • upper_bounds (dict[str, BoundConstraint])

  • metadata (dict[str, Any])

  • _variable_result_order (tuple[str, ...])

  • base_variable_groups (tuple[str, ...])

  • base_constraint_groups (tuple[str, ...])

  • extension_records (tuple[Any, ...])

  • extensions_applied (bool)

  • extension_signature (tuple[tuple[str, int], ...])

  • base_problem_class (str | None)

add_constraint(name, constraint, *, senses=None)[source]#

Register a named custom constraint before solving.

Parameters:

  • name (str)

  • constraint (Any | tuple[Any, ...])

  • senses (str | tuple[str, ...] | None)

Return type:

Any | tuple[Any, …]

add_variable(name, variable)[source]#

Register an auxiliary CVXPY variable or variable expression.

Parameters:

  • name (str)

  • variable (Any)

Return type:

Any

add_objective_term(name, expression)[source]#

Add a named expression to the minimization objective.

Parameters:

  • name (str)

  • expression (Any)

Return type:

Any

add_bounded_constraint(name, expression, *, lower=None, upper=None)[source]#

Create and register one semantic group of scalar bounds.

Parameters:

  • name (str)

  • expression (Any)

  • lower (float | None)

  • upper (float | None)

Return type:

tuple[Any, …]

add_bounded_constraints(name, bounds)[source]#

Create and register a group of scalar lower/upper bounds.

Parameters:

  • name (str)

  • bounds (tuple[tuple[Any, float | None, float | None], ...])

Return type:

tuple[Any, …]

add_equality_constraints(name, equalities)[source]#

Create and register a group of scalar equalities.

Parameters:

  • name (str)

  • equalities (tuple[tuple[Any, float], ...])

Return type:

tuple[Any, …]

quantity(name, index=None)[source]#

Return a semantic variable/expression group or one indexed value.

Parameters:

  • name (str)

  • index (int | None)

Return type:

Any

variable(name, index=None)[source]#

Compatibility alias for quantity().

Parameters:

  • name (str)

  • index (int | None)

Return type:

Any

unregistered_active_constraints()[source]#

CVXPY constraints can only enter the solve through the registry.

Return type:

tuple[str, …]