monee.model.formulation

Core

class monee.model.formulation.core.BranchFormulation

Bases: Formulation

equations(branch, grid, from_node_model, to_node_model, **kwargs)

minimize(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.core.ChildFormulation

Bases: Formulation

equations(child, grid, node, **kwargs)

minimize(child, grid, node, **kwargs)

overwrite(child, node_model, grid)

class monee.model.formulation.core.CompoundFormulation

Bases: Formulation

equations(compound, network, **kwargs)

minimize(compound, network, **kwargs)

class monee.model.formulation.core.Formulation

Bases: object

ensure_var(model)

class monee.model.formulation.core.NetworkConstraint

Bases: object

Solver-agnostic network-level constraint extension.

Analogous to BranchFormulation / NodeFormulation but spanning the entire network. Register with network.add_extension(constraint).

Phase 1 — prepare(network): called before variable injection; add Var placeholders to model objects so the injection loop picks them up.

Phase 2 — equations(network, ignored_nodes) → list: called after variable injection; return relational expressions (==, <=, >=) built from injected model attributes. The solver registers them with m.Equations(eqs) / pm.cons.add without inspecting their content — exactly like branch/node equations.

equations(network, ignored_nodes: set)

Return solver-agnostic relational expressions (empty by default).

Return type:

list

prepare(network)

Add Var placeholders before variable injection (no-op by default).

Return type:

None

class monee.model.formulation.core.NetworkFormulation(branch_type_to_formulations=None, node_type_to_formulations=None, child_type_to_formulations=None, compound_type_to_formulations=None)

Bases: object

branch_type_to_formulations: dict[tuple[type, type], BranchFormulation]

child_type_to_formulations: dict[tuple[type, type], ChildFormulation]

compound_type_to_formulations: dict[tuple[type, type], CompoundFormulation]

node_type_to_formulations: dict[tuple[type, type], NodeFormulation]

class monee.model.formulation.core.NodeFormulation

Bases: Formulation

equations(node, grid, from_branch_models, to_branch_models, connected_child_models, **kwargs)

minimize(node, grid, from_branch_models, to_branch_models, connected_child_models, **kwargs)

Ready-to-use network formulations

The following constants are importable directly from monee.model.formulation:

Electricity

Nonlinear AC

class monee.model.formulation.nonlinear.ac.ACElectricityBranchFormulation

Bases: BranchFormulation

equations(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.nonlinear.ac.ACElectricityNodeFormulation

Bases: NodeFormulation

MISOCP relaxation

class monee.model.formulation.misoc.el.MISOCPElectricityBranchFormulation

Bases: BranchFormulation

ensure_var(branch)

equations(branch, grid, from_node_model, to_node_model, **kwargs)

minimize(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.misoc.el.MISOCPElectricityNodeFormulation

Bases: NodeFormulation

ensure_var(node)

equations(node, grid, from_branch_models, to_branch_models, connected_node_models, **kwargs)

Gas

Nonlinear Weymouth

class monee.model.formulation.nonlinear.gas.NLWeymouthBranchFormulation

Bases: BranchFormulation

equations(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.nonlinear.gas.NLWeymouthNodeFormulation

Bases: NodeFormulation

ensure_var(model)

equations(node, grid, from_branch_models, to_branch_models, connected_child_models, **kwargs)

Water / district heating

Nonlinear Darcy–Weisbach

class monee.model.formulation.nonlinear.water.NLDarcyWeisbachBranchFormulation

Bases: BranchFormulation

ensure_var(model)

equations(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.nonlinear.water.NLDarcyWeisbachHeatExchangerFormulation

Bases: NLDarcyWeisbachBranchFormulation

ensure_var(model)

equations(branch, grid, from_node_model, to_node_model, **kwargs)

class monee.model.formulation.nonlinear.water.NLDarcyWeisbachNodeFormulation

Bases: NodeFormulation

ensure_var(model)

equations(node, grid, from_branch_models, to_branch_models, connected_child_models, **kwargs)