如何使用Pyomo创建带索引的VarList？

Pyomo原生VarList仅支持按自动递增的整数索引动态添加变量，无法通过自定义索引（如元组(i,j)）添加并后续通过索引访问。以下是针对该需求的解决方案：

问题回顾 #

原生VarList的局限（实际行为） #

import pyomo.environ as pe

m = pe.ConcreteModel()
m.x = pe.VarList()
for i in range(2):
    for j in range(2):
        new_v = m.x.add()

print(list(m.x._index_set))  # 输出: [0, 1, 2, 3]

期望行为 #

希望能通过传入自定义索引添加变量，后续可通过m.x[i,j]访问：

m = pe.ConcreteModel()
m.x = IndexedVarList(m)  # 自定义容器类
for i in range(2):
    for j in range(2):
        new_v = m.x.add((i,j))

print(list(m.x._index_set))  # 理想输出: [(0,0), (0,1), (1,0), (1,1)]
print(m.x[0,1])  # 直接通过索引访问变量

解决方案：自定义IndexedVarList类 #

通过封装一个支持自定义索引的变量容器，实现动态添加和索引访问的功能：

import pyomo.environ as pe

class IndexedVarList:
    def __init__(self, model, **var_kwargs):
        self.model = model
        self._index_map = {}  # 存储索引到变量的映射
        self._var_config = var_kwargs  # 变量的配置参数（如domain、bounds等）
    
    def add(self, index):
        if index in self._index_map:
            raise ValueError(f"索引 {index} 已存在")
        # 创建新变量并绑定到Pyomo模型
        new_var = pe.Var(**self._var_config)
        # 生成唯一组件名，避免模型内组件重名
        comp_name = f"_idx_var_{hash(index)}"
        self.model.add_component(comp_name, new_var)
        self._index_map[index] = new_var
        return new_var
    
    def __getitem__(self, index):
        return self._index_map[index]
    
    @property
    def _index_set(self):
        return self._index_map.keys()

使用示例 #

# 初始化模型和自定义变量容器
m = pe.ConcreteModel()
# 可传入变量配置参数，比如指定变量域为非负实数
m.x = IndexedVarList(m, domain=pe.NonNegativeReals)

# 动态添加带元组索引的变量
for i in range(2):
    for j in range(2):
        m.x.add((i,j))

# 验证索引集和访问方式
print(list(m.x._index_set))  # 输出: [(0, 0), (0, 1), (1, 0), (1, 1)]
print(f"变量m.x[1,0]的取值范围: {m.x[1,0].bounds}")

说明 #

• 该类模仿原生VarList的动态添加特性，同时支持自定义索引
• 通过__getitem__方法实现m.x[i,j]的索引访问方式
• 变量会被添加到Pyomo模型中，参与后续的建模和求解流程
• 支持传入变量的配置参数（如domain、bounds、initialize等）

内容的提问来源于stack exchange，提问作者somewhere