add_magnet_region_xy#
- MotorCAD.add_magnet_region_xy(x, y, region_name, magnet_material, br_angle, br_multiplier, polarity_code)#
Add a magnet region to the Motor-CAD geometry with an x, y coordinate system.
If a region already exists, this method overwrites the existing region.
Use degrees for angles.
- Parameters:
- x
float
Region position for the x coordinate.
- y
float
Region position for the y coordinate.
- region_name
str
Name of the region.
- magnet_material
str
Magnet material.
- br_angle
float
Magnet angle in degrees.
- br_multiplier
float
,optional
Magnet Br multiplier. The default is
1
.- polarity_code
integer
Magnet polarity, where
0
is north and1
is south.- .. deprecated:: 0.6.0
add_magnet_region_xy will be removed with Motor-CAD 2025R2 (tentative). Functionality replaced by adaptive templates.
- x