端口数据

(类来自 pyomo.network.port)

class pyomo.network.port.PortData(component=None)

基础类: ComponentData

此类定义了单个端口的数据

vars

一个字典，将添加的名称映射到变量

Type:

字典

__init__(component=None)

方法

__init__([component])
add(var[, name, rule])	将var添加到此端口，必要时将其转换为Pyomo数值
arcs([active])	此端口所属的弧线列表
clear_suffix_value(suffix_or_name[, expand])	设置此组件数据的后缀值
cname(*args, **kwds)	已弃用。
dests([active])	此端口作为源的弧线列表
fix()	将所有变量固定在端口中的当前值。
free()	解除端口中的所有变量的固定。
get_split_fraction(arc)	返回一个元组 (val, fix)，表示通过 set_split_fraction 设置的此弧的分割分数（如果存在），否则返回 None。
get_suffix_value(suffix_or_name[, default])	获取此组件数据的后缀值
getname([fully_qualified, name_buffer, ...])	返回包含组件名称和索引的字符串
index()	返回此ComponentData实例相对于父组件索引集的索引。
is_binary()	如果端口中的所有变量都是二进制的，则返回True
is_component_type()	如果此类是Pyomo组件，则返回True
is_continuous()	如果端口中的所有变量都是连续的，则返回True
is_equality(name)	如果此端口成员的规则是Port.Equality，则返回True
is_expression_type([expression_system])	如果此数值是一个表达式，则返回 True
is_extensive(name)	如果此端口成员的规则是 Port.Extensive，则返回 True
is_fixed()	如果端口中的所有变量/表达式都已固定，则返回 True
is_indexed()	如果此组件已索引，则返回true
is_integer()	如果端口中的所有变量都是整数，则返回True
is_logical_type()	如果此类是Pyomo布尔对象，则返回True。
is_named_expression_type()	如果此数值是一个命名表达式，则返回 True
is_numeric_type()	如果此类是Pyomo数值对象，则返回True
is_parameter_type()	除非此类是参数对象，否则返回 False
is_potentially_variable()	返回 True，因为端口可能（应该！）包含变量
is_reference()	如果此对象是引用，则返回 True。
is_variable_type()	除非此类是变量对象，否则返回 False
iter_vars([expr_vars, fixed, names])	遍历端口的每个成员，通过索引成员的索引进行遍历。
model()	返回拥有此数据的组件的模型。
parent_block()	返回拥有此数据的组件的父组件。
parent_component()	返回与此对象关联的组件。
polynomial_degree()	返回所有端口成员的最大多项式次数
pprint([ostream, verbose, prefix])	打印组件信息
remove(name)	从端口移除此成员
rule_for(name)	返回与给定端口成员关联的规则
set_split_fraction(arc, val[, fix])	在使用Port.Extensive时，设置用于弧扩展的弧的分割分数值。
set_suffix_value(suffix_or_name, value[, expand])	设置此组件数据的后缀值
set_value(value)	无法指定端口的值
sources([active])	此端口作为目的地的弧线列表
type()	已弃用。
unfix()	解除端口中的所有变量的固定。

属性

vars
active	返回活动属性
ctype	返回此组件的类类型
local_name	仅在直接父容器的上下文中获取组件名称。
name	获取完全限定的组件名称。

成员文档

add(var, name=None, rule=None, **kwds)

将var添加到此端口，必要时将其转换为Pyomo数值

Parameters:

• var – 一个变量或一些NumericValue，如表达式

• name (str) – 与此端口成员关联的名称

• 规则 (function) – 实现此成员所需扩展过程的函数。默认为Port.Equality，其他选项包括Port.Extensive。允许自定义。

• kwds – 将传递给规则的关键字参数

arcs(active=None)

此端口所属的弧线列表

clear_suffix_value(suffix_or_name, expand=True)

设置此组件数据的后缀值

cname(*args, **kwds)

已弃用。

自版本5.0起已弃用：cname() 方法已重命名为 getname()。 获取组件名称的首选方法是使用 .name 属性，该属性返回完全限定的组件名称。 .local_name 属性将仅在直接父容器的上下文中返回组件名称。

dests(active=None)

此端口作为源的弧线列表

fix()

将所有变量固定在端口中的当前值。 对于表达式，固定表达式中的每个变量。

free()

解除端口中的所有变量的固定。 对于表达式，解除表达式中每个变量的固定。

get_split_fraction(arc)

返回一个元组 (val, fix)，表示通过 set_split_fraction 设置的此弧的分割分数（如果存在），否则返回 None。

get_suffix_value(suffix_or_name, default=None)

获取此组件数据的后缀值

getname(fully_qualified=False, name_buffer=None, relative_to=None)

返回包含组件名称和索引的字符串

index()

返回此ComponentData实例相对于父组件索引集的索引。如果此实例没有父组件，或者由于某些未知原因此实例不属于父组件的索引集，则返回None。

is_binary()

如果端口中的所有变量都是二进制的，则返回True

is_component_type()

如果此类是Pyomo组件，则返回True

is_continuous()

如果端口中的所有变量都是连续的，则返回True

is_equality(name)

如果此端口成员的规则是Port.Equality，则返回True

is_expression_type(expression_system=None)

如果此数值是一个表达式，则返回 True

is_extensive(name)

如果此端口成员的规则是 Port.Extensive，则返回 True

is_fixed()

如果端口中的所有变量/表达式都已固定，则返回 True

is_indexed()

如果此组件已索引，则返回true

is_integer()

如果端口中的所有变量都是整数，则返回True

is_logical_type()

如果此类是Pyomo布尔对象，则返回True。

布尔对象包括常量、变量或逻辑表达式。

is_named_expression_type()

如果此数值是一个命名表达式，则返回 True

is_numeric_type()

如果此类是Pyomo数值对象，则返回True

is_parameter_type()

除非此类是参数对象，否则返回 False

is_potentially_variable()

返回 True，因为端口可能（应该！）包含变量

is_reference()

如果此对象是引用，则返回 True。

is_variable_type()

除非此类是变量对象，否则返回 False

iter_vars(expr_vars=False, fixed=None, names=False)

遍历端口的每个成员，通过索引成员的索引进行遍历。

Parameters:

• expr_vars (bool) – 如果为True，对表达式类型的成员调用identify_variables

• fixed (bool) – 仅包含具有此类型固定的变量/表达式

• names (bool) – 如果为True，则生成 (name, index, var/expr) 元组

model()

返回拥有此数据的组件的模型。

parent_block()

返回拥有此数据的组件的父组件。

parent_component()

返回与此对象关联的组件。

polynomial_degree()

返回所有端口成员的最大多项式次数

pprint(ostream=None, verbose=False, prefix='')

打印组件信息

请注意，此方法通常只能通过IndexedComponent容器中的ComponentData对象访问。组件，包括未索引的Component派生类以及标量和索引的IndexedComponent派生类，将会看到Component.pprint()

remove(name)

从端口移除此成员

rule_for(name)

返回与给定端口成员关联的规则

set_split_fraction(arc, val, fix=True)

设置在使用Port.Extensive时用于弧扩展的弧的分割分数值。

set_suffix_value(suffix_or_name, value, expand=True)

设置此组件数据的后缀值

set_value(value)

无法指定端口的值

sources(active=None)

此端口作为目的地的弧线列表

type()

已弃用。

返回此组件的类类型

自版本5.7起已弃用：Component.type() 方法已被 .ctype 属性取代。

unfix()

解除端口中的所有变量的固定。 对于表达式，解除表达式中每个变量的固定。

property active

返回活动属性

property ctype

返回此组件的类类型

property local_name

仅在直接父容器的上下文中获取组件名称。

property name

获取完全限定的组件名称。