首页 / design / oaMutualInductor

oaMutualInductor

模块: oapy._oa._design 导入: from oapy._oa import _design

概览

oaMutualInductor 在 oapy 中可用，可通过 _design 模块访问。

本页汇总 oaMutualInductor 当前在 oapy 中可用的 Python 接口。

详细说明

The oaMutualInductor class represents the mutual inductance between two inductor devices。 The two inductors can be within the same parasitic network or within the parasitic networks for two different nets。

方法总览

状态	Python 调用
✅	`obj.isLocal()`
✅	`obj.setValue(ap, value)`
✅	`obj.getValue(ap)`
✅	`obj.getInductor(endpoint)`
✅	`obj.getOtherInductor(inductor)`
✅	`obj.getOtherInductor(otherNet, otherInductorId)`
✅	`_design.oaMutualInductor.create(fromInductor, toInductor)`
✅	`_design.oaMutualInductor.create(fromInductor, toInductor, id)`
✅	`_design.oaMutualInductor.create(fromInductor, otherNet, otherInductorId, id)`

方法说明

`obj.isLocal()`

绑定状态: 已绑定

Python 调用: obj.isLocal()

This function returns true if this mutual inductor connects two inductors within the same parasitic network。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.isLocal()

`obj.setValue(ap, value)`

绑定状态: 已绑定

Python 调用: obj.setValue(ap, value)

This function sets the mutual inductance value of this device for the specified analysis point。

参数

ap: The analysis point for which to set the mutual inductance。
value: The inductance value to set。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.setValue(ap, value)

`obj.getValue(ap)`

绑定状态: 已绑定

Python 调用: obj.getValue(ap)

This function returns the mutual inductance value of this device for the specified analysis point。

参数

ap: The analysis point for which to return the mutual inductance。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.getValue(ap)

`obj.getInductor(endpoint)`

绑定状态: 已绑定

Python 调用: obj.getInductor(endpoint)

This function returns the inductor connected to the specified endpoint of this mutual inductor。 If this mutual inductor couples to an inductor within another parasitic network, NULL is returned for the "to" endpoint。

参数

endpoint: The endpoint value。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.getInductor(endpoint)

`obj.getOtherInductor(inductor)`

绑定状态: 已绑定

Python 调用: obj.getOtherInductor(inductor)

This function returns information about the inductor connected to the "to" endpoint of this device。 The parasitic network for otherNet does not have to exist or be in memory at the time that this function is called。 When this is a local mutual inductor, the otherInductorId is set to oacNullIndex if the other inductor does not have an ID。

参数

otherNet: The other network from which to return information。
otherInductorId: A unique ID for the inductor in the other parasitic network。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.getOtherInductor(inductor)

`obj.getOtherInductor(otherNet, otherInductorId)`

绑定状态: 已绑定

Python 调用: obj.getOtherInductor(otherNet, otherInductorId)

This function returns the inductor connected to the other endpoint of this device (the endpoint that is not connected to inductor)。 When inductor is the from endpoint of this mutual inductor and this mutual inductor couples to an inductor within another parasitic network, NULL is returned。

参数

inductor: The inductor connected to the other endpoint of this device。

Python 示例

from oapy._oa import _design

# assume obj is a oaMutualInductor
obj.getOtherInductor(otherNet, otherInductorId)

`_design.oaMutualInductor.create(fromInductor, toInductor)`

绑定状态: 已绑定

Python 调用: _design.oaMutualInductor.create(fromInductor, toInductor)

This function creates a mutual inductor in fromInductor's parasitic network that couples between fromInductor and an inductor in the parasitic network for another net。 The parasitic network for otherNet does not have to exist or be in memory at the time this function is called。 The otherInductorId value specifies a unique ID for the inductor in otherNet's parasitic network, and that ID must be specified when the inductor is created。 If the inductance is between 2 nets, those nets must be in a single hierarchy domain。 Each must be an oaNet , or each must be an oaOccNet 。

参数

fromInductor: The inductor from which to couple。
otherNet: The other network to which to couple。
otherInductorId: A unique ID for the inductor in the other parasitic network。
id: The unique ID value。

异常

oacCoupledInductorWithoutId。
oacInvalidNet。
oacInvalidMutualInductorId。
oacInductorNetNotInSameDesign。
oacDeviceNetNotInSameDomain。
oacNonLocalDeviceIdExists。

Python 示例

from oapy._oa import _design

_design.oaMutualInductor.create(fromInductor, toInductor)

`_design.oaMutualInductor.create(fromInductor, toInductor, id)`

绑定状态: 已绑定

Python 调用: _design.oaMutualInductor.create(fromInductor, toInductor, id)

This function creates a local mutual inductor between the specified pair of inductors。 An exception will be thrown if the two inductors are not in the same design。 An explicit unique mutual inductor ID id is required to be specified。 An exception will be thrown if the id is the reserved oacInvalidDeviceID value or if a mutual inductor with the specified id value already exists。 The hasId() function will return true for mutual inductors created with this function and the getId() function will return the user-specified id。 Mutual inductors can be created between inductors in different partitions of the same root parasitic network, where one of the partitions must be an ancestor of the other。 In this case, the mutual inductor device will be created in the lower level partition, and the inductor in the higher level partition must have an id so that it can be found when loading the lower level partition。

参数

fromInductor: The inductor from which to couple。
toInductor: The inductor to which to couple。
id: The unique ID value。

异常

oacInvalidDeviceIdSpecified。
oacLocalDeviceIdExists。
oacInductorsNotInSameDesign。
oacInductorsNotInSameNetwork。
oacInductorsNotInRelatedPartitions。
oacAncestorInductorWithoutId。

Python 示例

from oapy._oa import _design

_design.oaMutualInductor.create(fromInductor, toInductor, id)

`_design.oaMutualInductor.create(fromInductor, otherNet, otherInductorId, id)`

绑定状态: 已绑定

Python 调用: _design.oaMutualInductor.create(fromInductor, otherNet, otherInductorId, id)

This function creates a local mutual inductor between the specified pair of inductors。 An exception will be thrown if the two inductors are not in the same design。 The mutual inductor created does not have an ID associated with it。 The hasId() function will return false for these inductors and the getId() function will return an oacInvalidDeviceID value。 Mutual inductors can be created between inductors in different partitions of the same root parasitic network, where one of the partitions must be an ancestor of the other。 In this case, the mutual inductor device will be created in the lower level partition, and the inductor in the higher level partition must have an id so that it can be found when loading the lower level partition。

参数

fromInductor: The inductor from which to couple。
toInductor: The inductor to which to couple。

异常

oacInductorsNotInSameDesign。
oacInductorsNotInSameNetwork。
oacInductorsNotInRelatedPartitions。
oacAncestorInductorWithoutId。

Python 示例

from oapy._oa import _design

_design.oaMutualInductor.create(fromInductor, otherNet, otherInductorId, id)