pyleecan.Classes.HoleMag module¶
Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Slot/HoleMag
- class HoleMag(Zh=36, mat_void=- 1, magnetization_dict_offset=None, Alpha0=0, init_dict=None, init_str=None)[source]¶
Bases:
HoleHole with magnets for lamination (abstract)
- VERSION = 1¶
- comp_mass_magnet_id(index)¶
Compute the mass of the hole magnet of the corresponding index
- Parameters:
self (HoleMag) – A HoleMag object
index (int) – Index of the magnet to compute the surface
- Returns:
Mmag – Mass of the Magnet [m**2]
- Return type:
float
- comp_mass_magnets()¶
Compute the mass of the hole magnets (some of them may be missing)
- Parameters:
self (HoleMag) – A HoleMag object
- Returns:
Mmag – mass of the magnets [kg]
- Return type:
float
- comp_surface_magnets()¶
Compute the surface of all the magnet(s)
- Parameters:
self (HoleMag) – A HoleMag object
- Returns:
Smag – Surface of all the Magnet(s) [m**2]
- Return type:
float
- comp_volume_magnets()¶
Compute the volume of the hole magnets (some of them may be missing)
- Parameters:
self (HoleMag) – A HoleMag object
- Returns:
Vmag – volume of the magnets [m**3]
- Return type:
float
- get_magnet_list()¶
Return the list of magnet (including None)
- Parameters:
self (HoleMag) – A HoleMag object
- Returns:
magnet_list – List of Magnet
- Return type:
list
- has_magnet()¶
Return if the Hole has magnet
- Parameters:
self (HoleMag) – A HoleMag object
- Returns:
has_magnet – True
- 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.