pyleecan.Classes.HoleMLSRPM module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Slot/HoleMLSRPM

class HoleMLSRPM(H1=0.002373479, W0=0.00388, W1=0.219911482, W2=0.0007, R1=0.0003, R2=0.019327, R3=0.0165, magnet_0=- 1, Zh=36, mat_void=- 1, magnetization_dict_offset=None, Alpha0=0, init_dict=None, init_str=None)[source]

Bases: HoleMag

V shape slot for buried magnet

VERSION = 1
IS_SYMMETRICAL = 1
build_geometry(alpha=0, delta=0, is_simplified=False)

Compute the curve (Line) needed to plot the Slot. The ending point of a curve is the starting point of the next curve in the list

Parameters:

  • self (HoleMLSRPM) – A HoleMLSRPM object

  • alpha (float) – Angle to rotate the slot (Default value = 0) [rad]

  • delta (complex) – Complex to translate the slot (Default value = 0)

  • is_simplified (bool) – True to avoid line superposition

Returns:

surf_list – List of SurfLine needed to draw the HoleM51

Return type:

list

check()

Check that the HoleMLSRPM object is correct

Parameters:

self (HoleMLSRPM) – A HoleMLSRPM object

Return type:

None

comp_magnetization_dict(is_north=True)

Compute the dictionary of the magnetization direction of the magnets (key=magnet_X, value=angle[rad]) Mangetization angle with Hole centered on Ox axis

Parameters:

  • self (HoleMLSRPM) – a HoleMLSRPM object

  • is_north (True) – True: comp north magnetization, else add pi [rad]

Returns:

mag_dict – magnetization dictionary (key=magnet_X, value=angle[rad])

Return type:

dict

comp_mass_magnet()

Compute the mass of the magnet (if any)

Parameters:

self (HoleMLSRPM) – A HoleMLSRPM object

Returns:

Mmag – mass of the magnet [kg]

Return type:

float

comp_surface_magnet()

Compute the surface of the Hole

Parameters:

self (HoleMLSRPM) – A HoleMLSRPM object

Returns:

S – Surface of the Magnet. [m**2]

Return type:

float

comp_volume_magnet()

Compute the volume of the magnet (if any)

Parameters:

self (HoleMLSRPM) – A HoleMLSRPM object

Returns:

Vmag – Volume of the magnet [m**3]

Return type:

float

plot_schematics(is_default=False, is_add_point_label=False, is_add_schematics=True, is_add_main_line=True, type_add_active=True, save_path=None, is_show_fig=True, fig=None, ax=None)

Plot the schematics of the slot

Parameters:

  • self (HoleMLSRPM) – A HoleMLSRPM object

  • is_default (bool) – True: plot default schematics, else use current slot values

  • is_add_point_label (bool) – True to display the name of the points (Z1, Z2….)

  • is_add_schematics (bool) – True to display the schematics information (W0, H0…)

  • is_add_main_line (bool) – True to display “main lines” (slot opening and 0x axis)

  • type_add_active (int) – 0: No active surface, 2: active surface as magnet

  • save_path (str) – full path including folder, name and extension of the file to save if save_path is not None

  • is_show_fig (bool) – To call show at the end of the method

  • fig (Matplotlib.figure.Figure) – existing figure to use if None create a new one

  • ax (Matplotlib.axes.Axes object) – Axis on which to plot the data

Returns:

  • fig (Matplotlib.figure.Figure) – Figure containing the plot

  • ax (Matplotlib.axes.Axes object) – Axis containing the plot

remove_magnet()

Remove the magnet (set to None) of the Hole

Parameters:

self (HoleMLSRPM) – a HoleMLSRPM object

has_magnet()

Return if the Hole has magnets

Parameters:

self (HoleMLSRPM) – A HoleMLSRPM object

Returns:

has_magnet – True if the magnets are not None

Return type:

bool

save(save_path='', is_folder=False, type_handle_old=2, type_compression=0)

Save the object to the save_path

Parameters:

  • self – A pyleecan object

  • save_path (str) – path to the folder to save the object

  • is_folder (bool) – to split the object in different files: separate simulation machine and materials (json only)

  • type_handle_old (int) – How to handle old file in folder mode (0:Nothing, 1:Delete, 2:Move to “Backup” folder)

  • type_compression (int) – Available only for json, 0: no compression, 1: gzip

get_logger()

Get the object logger or its parent’s one

Parameters:

obj – A pyleecan object

Returns:

logger – Pyleecan object dedicated logger

Return type:

logging.Logger

compare(other, name='self', ignore_list=None, is_add_value=False)[source]

Compare two objects and return list of differences

as_dict(type_handle_ndarray=0, keep_function=False, **kwargs)[source]

Convert this object in a json serializable dict (can be use in __init__). type_handle_ndarray: int

How to handle ndarray (0: tolist, 1: copy, 2: nothing)

keep_functionbool

True to keep the function object, else return str

Optional keyword input parameter is for internal use only and may prevent json serializability.

copy()[source]

Creates a deepcopy of the object

property H1

Magnet depth

Type:

float

Min:

0

property W0

Magnet top width

Type:

float

Min:

0

property W1

Magnet width angular 1

Type:

float

Min:

0

property W2

Small distance

Type:

float

Min:

0

property R1

Rounding radius

Type:

float

Min:

0

property R2

Radius 2

Type:

float

property R3

Radius 3

Type:

float

property magnet_0

Magnet of the hole

Type:

Magnet