pyleecan.Classes.LamSquirrelCage module¶
Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Machine/LamSquirrelCage
- class LamSquirrelCage(Hscr=0.03, Lscr=0.015, ring_mat=- 1, Ksfill=None, winding=- 1, slot=- 1, L1=0.35, mat_type=- 1, Nrvd=0, Wrvd=0, Kf1=0.95, is_internal=True, Rint=0, Rext=1, is_stator=True, axial_vent=- 1, notch=- 1, skew=None, bore=None, yoke=None, init_dict=None, init_str=None)[source]¶
Bases:
LamSlotWind
squirrel cages lamination
- VERSION = 1¶
- build_geometry(sym=1, alpha=0, delta=0, is_circular_radius=False)¶
Build geometry of the LamSquirrelCage
- Parameters:
self – LamSquirrelCage Object
sym (int) – Symmetry factor (1= full machine, 2= half of the machine…)
alpha (float) – Angle for rotation [rad]
delta (complex) – Complex value for translation
is_circular_radius (bool) – True to add surfaces to “close” the Lamination radii
- Returns:
surf_list – list of surfaces
- Return type:
list
- check()¶
Check that the Lamination object is correct
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Return type:
None
- Raises:
SCC_NotARotor – A LamSquirrelCage Lamination can’t be a stator
SCC_WrongCond – A LamSquirrelCage’s conductor must be a type 2_1
- comp_length_ring()¶
Computation of the squirrel cage end-ring average perimeter (circumferential length)
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
Lring – Length of the ring [m]
- Return type:
float
- plot(fig=None, ax=None, is_lam_only=False, sym=1, alpha=0, delta=0, is_edge_only=False, edgecolor=None, is_add_arrow=False, is_show_fig=True, is_winding_connection=False)¶
Plot the Lamination in a matplotlib fig
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
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
is_lam_only (bool) – True to plot only the lamination (remove the bare)
sym (int) – Symmetry factor (1= full machine, 2= half of the machine…)
alpha (float) – Angle for rotation [rad]
delta (complex) – Complex value for translation
is_edge_only (bool) – To plot transparent Patches
edgecolor – Color of the edges if is_edge_only=True
is_show_fig (bool) – To call show at the end of the method
is_winding_connection (bool) – True to display winding connections (not used)
- Returns:
fig (Matplotlib.figure.Figure) – Figure containing the plot
ax (Matplotlib.axes.Axes object) – Axis containing the plot
- comp_number_phase_eq()¶
Compute the equivalent number of phase
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
qb – Zs/p
- Return type:
float
- comp_surface_ring()¶
Computation of the ring cross-section surface area
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
Lring – Surface area of the cross-section of the ring [m^2]
- Return type:
float
- comp_resistance_wind(T=20)¶
Computation of the equivalent rotor resistance per phase of a cage winding with ‘qs’ number of phases
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
T (float) – mean winding temperature [°C], default value is 20°C
- Returns:
Rrot – resistance of the rotor [Ohm]
- Return type:
float
- get_name_phase()¶
Return the name of the winding phases
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
name_phase – Empty list
- Return type:
list
- comp_angle_d_axis()¶
Compute the angle between the X axis and the first d+ axis By convention a “Tooth” is centered on the X axis
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
d_angle – angle between the X axis and the first d+ axis
- Return type:
float
- comp_periodicity_spatial()¶
Compute the periodicity factor of the lamination
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
per_a (int) – Number of spatial periodicities of the lamination
is_antiper_a (bool) – True if an spatial anti-periodicity is possible after the periodicities
- comp_masses()¶
Compute the Lamination masses
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
- Returns:
M_dict – Lamination mass dictionary (Mtot, Mlam, Mwind, Mring) [kg]
- Return type:
dict
- plot_schematics_scr(is_default=False, is_add_schematics=True, is_add_main_line=True, save_path=None, is_show_fig=True, fig=None, ax=None)¶
Plot the schematics of the short circuit ring
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
is_default (bool) – True: plot default schematics, else use current lamination values
is_add_schematics (bool) – True to display the schematics information (Hscr, Lscr…)
is_add_main_line (bool) – True to display “main lines” (dotted lines and Z axis)
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
- plot_side(fig=None, ax=None, is_show_fig=True, save_path=None)¶
Plot the side view of the Lamination in a matplotlib fig (Z axis left to right)
- Parameters:
self (LamSquirrelCage) – A LamSquirrelCage object
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
is_show_fig (bool) – To call show at the end of the method
save_path (str) – full path including folder, name and extension of the file to save if save_path is not None
- Returns:
fig (Matplotlib.figure.Figure) – Figure containing the plot
ax (Matplotlib.axes.Axes object) – Axis containing the plot
- 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.
- property Hscr¶
short circuit ring section radial height [m]
- Type:
float
- Min:
0
- property Lscr¶
short circuit ring section axial length
- Type:
float
- Min:
0
- property ring_mat¶
Material of the Rotor short circuit ring
- Type:
Material