assign_layout_force#

Maxwell3d.assign_layout_force(net_layers: dict, component_name: str, coordinate_system: str = 'Global', force_name: str = None, include_no_layer: bool = True) bool[source]#

Assign the layout force to a component in a Transient A-Phi solver. To access layout component features the Beta option has to be enabled first.

Parameters:
net_layersdict

Each <net, layer> pair represents the objects in the intersection of the corresponding net and layer. The layer name is from the list of layer names. The net name is the dictionary’s key.

component_namestr

Name of the 3D component to assign the layout force to.

coordinate_systemstr, optional

Reference coordinate system. If not provided, the global one is used.

force_namestr, optional

Name of the layout force. If not provided a random name will be generated.

include_no_layerbool, optional

Whether to include "<no-layer>" layer or not (used for vias). Default is True.

Returns:
bool

True when successful, False when failed.

References

>>> oModule.AssignLayoutForce

Examples

Create a dictionary to give as an input to assign_layout_force method. >>> nets_layers = {“<no-net>”: [“PWR”,”TOP”,”UNNAMED_000”,”UNNAMED_002”], >>> “GND”: [“LYR_1”,”LYR_2”,”UNNAMED_006”]} >>>

Assign layout force to a component. >>> from ansys.aedt.core import Maxwell3d >>> m3d = Maxwell3d() >>> m3d.assign_layout_force(net_layers=nets_layers,component_name=”LC1_1”) >>> m3d.release_desktop(True, True)