pyaedt.modeler.multiparts.MultiPartComponent

class pyaedt.modeler.multiparts.MultiPartComponent(comp_folder, name=None, use_relative_cs=False, relative_cs_name=None, motion=False, offset=('0', '0', '0'), yaw='0deg', pitch='0deg', roll='0deg')[source]

Supports multi-part 3D components for HFSS SBR+.

Note

Forward motion is in the X-axis direction if motion is set.

Parameters
comp_folderstr

Full path to the folder with the JSON file containing the component definition. This JSON file must have the same name as the folder.

namestr, optional

Name of the multipart component. If this value is set, the component is selected from the corresponding JSON file in comp_folder. The default is None, in which case the name of the first JSON file in the folder is used.

use_relative_csbool, optional

Whether to use the relative coordinate system. The default is False. Set to False if the multi-part component doesn’t move. Set to True if the multi-part component moves relative to the global coordinate system.

relative_cs_namestr, optional

Name of the coordinate system to connect the multipart relative system to when use_relative_cs=True.

motionbool, optional

Whether expressions should be used to define the position and orientation of the multi-part component. The default is False.

offsetlist, optional

List of [x, y, z] coordinate values defining the component offset. The default is ["0", "0", "0"].

yawstr or float, optional

Yaw angle, indicating the rotation about the component’s Z-axis. The default is "0deg".

pitchstr or float, optional

Pitch angle, indicating the rotation about the component Y-axis The default is "0deg".

rollstr or float, optional

Roll angle, indicating the rotation about the component X-axis. The default is "0deg".

rollstr or float, optional

Roll angle, indicating the rotation about the component’s X-axis. The default

Methods

MultiPartComponent.insert(app[, motion])

Insert the object in HFSS SBR+.

MultiPartComponent.position_in_app(app)

Set up design variables and values to enable motion for the multi-part 3D component.

MultiPartComponent.start(app)

Initialize app for SBR+ simulation.

Attributes

MultiPartComponent.cs_name

Coordinate system name.

MultiPartComponent.index

Number of multi-part components.

MultiPartComponent.modeler_units

MultiPartComponent.name

Unique instance name.

MultiPartComponent.offset

Offset values for the multi-part component.

MultiPartComponent.offset_names

X-, Y-, and Z-axis offset names.

MultiPartComponent.offset_x_name

X-axis offset name.

MultiPartComponent.offset_y_name

Y-axis offset name.

MultiPartComponent.offset_z_name

Z-axis offset name.

MultiPartComponent.pitch

Pitch variable value.

MultiPartComponent.pitch_name

Pitch variable name.

MultiPartComponent.roll

Roll variable value.

MultiPartComponent.roll_name

Roll variable name.

MultiPartComponent.use_global_cs

Global coordinate system.

MultiPartComponent.yaw

Yaw variable value.

MultiPartComponent.yaw_name

Yaw variable name.