assign_layout_force#
- Maxwell3d.assign_layout_force(nets_layers_mapping: dict, component_name: str, reference_cs: 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:
- nets_layers_mapping
dict
Each <layer, net> pair represents the object(s) in the intersection of corresponding layer and net. Net name is dictionary’s key, layers name is the list of layer names.
- component_name
str
Name of the 3d component to assign the layout force to.
- reference_cs
str
,optional
Reference coordinate system. If not provided the global one will be set.
- force_name
str
,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 isTrue
.
- nets_layers_mapping
- 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 = {} >>> nets_layers[“<no-net>”] = [“PWR”,”TOP”,”UNNAMED_000”,”UNNAMED_002”] >>> nets_layers[“GND”] = [“LYR_1”,”LYR_2”,”UNNAMED_006”]
Assign layout force to a component. >>> m3d = Maxwell3d() >>> m3d.assign_layout_force(nets_layers_mapping=nets_layers, component_name=”LC1_1”)