Source code for pyleecan.Classes.SlotM12

# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Slot/SlotM12.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Slot/SlotM12
"""

from os import linesep
from sys import getsizeof
from logging import getLogger
from ._check import check_var, raise_
from ..Functions.get_logger import get_logger
from ..Functions.save import save
from ..Functions.load import load_init_dict
from ..Functions.Load.import_class import import_class
from copy import deepcopy
from .Slot import Slot

# Import all class method
# Try/catch to remove unnecessary dependencies in unused method
try:
    from ..Methods.Slot.SlotM12._comp_point_coordinate import _comp_point_coordinate
except ImportError as error:
    _comp_point_coordinate = error

try:
    from ..Methods.Slot.SlotM12.build_geometry import build_geometry
except ImportError as error:
    build_geometry = error

try:
    from ..Methods.Slot.SlotM12.check import check
except ImportError as error:
    check = error

try:
    from ..Methods.Slot.SlotM12.comp_angle_opening import comp_angle_opening
except ImportError as error:
    comp_angle_opening = error

try:
    from ..Methods.Slot.SlotM12.comp_height import comp_height
except ImportError as error:
    comp_height = error

try:
    from ..Methods.Slot.SlotM12.comp_height_active import comp_height_active
except ImportError as error:
    comp_height_active = error

try:
    from ..Methods.Slot.SlotM12.comp_surface import comp_surface
except ImportError as error:
    comp_surface = error

try:
    from ..Methods.Slot.SlotM12.comp_surface_active import comp_surface_active
except ImportError as error:
    comp_surface_active = error

try:
    from ..Methods.Slot.SlotM12.get_surface_active import get_surface_active
except ImportError as error:
    get_surface_active = error

try:
    from ..Methods.Slot.SlotM12.plot_schematics import plot_schematics
except ImportError as error:
    plot_schematics = error


from numpy import isnan
from ._check import InitUnKnowClassError


[docs]class SlotM12(Slot): """Rectangular Slot with Rectangular magnet with polar top""" VERSION = 1 IS_SYMMETRICAL = 1 # Check ImportError to remove unnecessary dependencies in unused method # cf Methods.Slot.SlotM12._comp_point_coordinate if isinstance(_comp_point_coordinate, ImportError): _comp_point_coordinate = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method _comp_point_coordinate: " + str(_comp_point_coordinate) ) ) ) else: _comp_point_coordinate = _comp_point_coordinate # cf Methods.Slot.SlotM12.build_geometry if isinstance(build_geometry, ImportError): build_geometry = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method build_geometry: " + str(build_geometry) ) ) ) else: build_geometry = build_geometry # cf Methods.Slot.SlotM12.check if isinstance(check, ImportError): check = property( fget=lambda x: raise_( ImportError("Can't use SlotM12 method check: " + str(check)) ) ) else: check = check # cf Methods.Slot.SlotM12.comp_angle_opening if isinstance(comp_angle_opening, ImportError): comp_angle_opening = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method comp_angle_opening: " + str(comp_angle_opening) ) ) ) else: comp_angle_opening = comp_angle_opening # cf Methods.Slot.SlotM12.comp_height if isinstance(comp_height, ImportError): comp_height = property( fget=lambda x: raise_( ImportError("Can't use SlotM12 method comp_height: " + str(comp_height)) ) ) else: comp_height = comp_height # cf Methods.Slot.SlotM12.comp_height_active if isinstance(comp_height_active, ImportError): comp_height_active = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method comp_height_active: " + str(comp_height_active) ) ) ) else: comp_height_active = comp_height_active # cf Methods.Slot.SlotM12.comp_surface if isinstance(comp_surface, ImportError): comp_surface = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method comp_surface: " + str(comp_surface) ) ) ) else: comp_surface = comp_surface # cf Methods.Slot.SlotM12.comp_surface_active if isinstance(comp_surface_active, ImportError): comp_surface_active = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method comp_surface_active: " + str(comp_surface_active) ) ) ) else: comp_surface_active = comp_surface_active # cf Methods.Slot.SlotM12.get_surface_active if isinstance(get_surface_active, ImportError): get_surface_active = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method get_surface_active: " + str(get_surface_active) ) ) ) else: get_surface_active = get_surface_active # cf Methods.Slot.SlotM12.plot_schematics if isinstance(plot_schematics, ImportError): plot_schematics = property( fget=lambda x: raise_( ImportError( "Can't use SlotM12 method plot_schematics: " + str(plot_schematics) ) ) ) else: plot_schematics = plot_schematics # generic save method is available in all object save = save # get_logger method is available in all object get_logger = get_logger def __init__( self, W0=0.0122, H0=0.001, Wmag=0.0122, Hmag=0.001, Zs=36, wedge_mat=None, is_bore=True, init_dict=None, init_str=None, ): """Constructor of the class. Can be use in three ways : - __init__ (arg1 = 1, arg3 = 5) every parameters have name and default values for pyleecan type, -1 will call the default constructor - __init__ (init_dict = d) d must be a dictionary with property names as keys - __init__ (init_str = s) s must be a string s is the file path to load ndarray or list can be given for Vector and Matrix object or dict can be given for pyleecan Object""" if init_str is not None: # Load from a file init_dict = load_init_dict(init_str)[1] if init_dict is not None: # Initialisation by dict assert type(init_dict) is dict # Overwrite default value with init_dict content if "W0" in list(init_dict.keys()): W0 = init_dict["W0"] if "H0" in list(init_dict.keys()): H0 = init_dict["H0"] if "Wmag" in list(init_dict.keys()): Wmag = init_dict["Wmag"] if "Hmag" in list(init_dict.keys()): Hmag = init_dict["Hmag"] if "Zs" in list(init_dict.keys()): Zs = init_dict["Zs"] if "wedge_mat" in list(init_dict.keys()): wedge_mat = init_dict["wedge_mat"] if "is_bore" in list(init_dict.keys()): is_bore = init_dict["is_bore"] # Set the properties (value check and convertion are done in setter) self.W0 = W0 self.H0 = H0 self.Wmag = Wmag self.Hmag = Hmag # Call Slot init super(SlotM12, self).__init__(Zs=Zs, wedge_mat=wedge_mat, is_bore=is_bore) # The class is frozen (in Slot init), for now it's impossible to # add new properties def __str__(self): """Convert this object in a readeable string (for print)""" SlotM12_str = "" # Get the properties inherited from Slot SlotM12_str += super(SlotM12, self).__str__() SlotM12_str += "W0 = " + str(self.W0) + linesep SlotM12_str += "H0 = " + str(self.H0) + linesep SlotM12_str += "Wmag = " + str(self.Wmag) + linesep SlotM12_str += "Hmag = " + str(self.Hmag) + linesep return SlotM12_str def __eq__(self, other): """Compare two objects (skip parent)""" if type(other) != type(self): return False # Check the properties inherited from Slot if not super(SlotM12, self).__eq__(other): return False if other.W0 != self.W0: return False if other.H0 != self.H0: return False if other.Wmag != self.Wmag: return False if other.Hmag != self.Hmag: return False return True
[docs] def compare(self, other, name="self", ignore_list=None, is_add_value=False): """Compare two objects and return list of differences""" if ignore_list is None: ignore_list = list() if type(other) != type(self): return ["type(" + name + ")"] diff_list = list() # Check the properties inherited from Slot diff_list.extend( super(SlotM12, self).compare( other, name=name, ignore_list=ignore_list, is_add_value=is_add_value ) ) if ( other._W0 is not None and self._W0 is not None and isnan(other._W0) and isnan(self._W0) ): pass elif other._W0 != self._W0: if is_add_value: val_str = " (self=" + str(self._W0) + ", other=" + str(other._W0) + ")" diff_list.append(name + ".W0" + val_str) else: diff_list.append(name + ".W0") if ( other._H0 is not None and self._H0 is not None and isnan(other._H0) and isnan(self._H0) ): pass elif other._H0 != self._H0: if is_add_value: val_str = " (self=" + str(self._H0) + ", other=" + str(other._H0) + ")" diff_list.append(name + ".H0" + val_str) else: diff_list.append(name + ".H0") if ( other._Wmag is not None and self._Wmag is not None and isnan(other._Wmag) and isnan(self._Wmag) ): pass elif other._Wmag != self._Wmag: if is_add_value: val_str = ( " (self=" + str(self._Wmag) + ", other=" + str(other._Wmag) + ")" ) diff_list.append(name + ".Wmag" + val_str) else: diff_list.append(name + ".Wmag") if ( other._Hmag is not None and self._Hmag is not None and isnan(other._Hmag) and isnan(self._Hmag) ): pass elif other._Hmag != self._Hmag: if is_add_value: val_str = ( " (self=" + str(self._Hmag) + ", other=" + str(other._Hmag) + ")" ) diff_list.append(name + ".Hmag" + val_str) else: diff_list.append(name + ".Hmag") # Filter ignore differences diff_list = list(filter(lambda x: x not in ignore_list, diff_list)) return diff_list
def __sizeof__(self): """Return the size in memory of the object (including all subobject)""" S = 0 # Full size of the object # Get size of the properties inherited from Slot S += super(SlotM12, self).__sizeof__() S += getsizeof(self.W0) S += getsizeof(self.H0) S += getsizeof(self.Wmag) S += getsizeof(self.Hmag) return S
[docs] def as_dict(self, type_handle_ndarray=0, keep_function=False, **kwargs): """ 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_function : bool True to keep the function object, else return str Optional keyword input parameter is for internal use only and may prevent json serializability. """ # Get the properties inherited from Slot SlotM12_dict = super(SlotM12, self).as_dict( type_handle_ndarray=type_handle_ndarray, keep_function=keep_function, **kwargs ) SlotM12_dict["W0"] = self.W0 SlotM12_dict["H0"] = self.H0 SlotM12_dict["Wmag"] = self.Wmag SlotM12_dict["Hmag"] = self.Hmag # The class name is added to the dict for deserialisation purpose # Overwrite the mother class name SlotM12_dict["__class__"] = "SlotM12" return SlotM12_dict
[docs] def copy(self): """Creates a deepcopy of the object""" # Handle deepcopy of all the properties W0_val = self.W0 H0_val = self.H0 Wmag_val = self.Wmag Hmag_val = self.Hmag Zs_val = self.Zs if self.wedge_mat is None: wedge_mat_val = None else: wedge_mat_val = self.wedge_mat.copy() is_bore_val = self.is_bore # Creates new object of the same type with the copied properties obj_copy = type(self)( W0=W0_val, H0=H0_val, Wmag=Wmag_val, Hmag=Hmag_val, Zs=Zs_val, wedge_mat=wedge_mat_val, is_bore=is_bore_val, ) return obj_copy
def _set_None(self): """Set all the properties to None (except pyleecan object)""" self.W0 = None self.H0 = None self.Wmag = None self.Hmag = None # Set to None the properties inherited from Slot super(SlotM12, self)._set_None() def _get_W0(self): """getter of W0""" return self._W0 def _set_W0(self, value): """setter of W0""" check_var("W0", value, "float", Vmin=0) self._W0 = value W0 = property( fget=_get_W0, fset=_set_W0, doc=u"""Slot isthmus width. :Type: float :min: 0 """, ) def _get_H0(self): """getter of H0""" return self._H0 def _set_H0(self, value): """setter of H0""" check_var("H0", value, "float", Vmin=0) self._H0 = value H0 = property( fget=_get_H0, fset=_set_H0, doc=u"""Slot isthmus height. :Type: float :min: 0 """, ) def _get_Wmag(self): """getter of Wmag""" return self._Wmag def _set_Wmag(self, value): """setter of Wmag""" check_var("Wmag", value, "float", Vmin=0) self._Wmag = value Wmag = property( fget=_get_Wmag, fset=_set_Wmag, doc=u"""Magnet width :Type: float :min: 0 """, ) def _get_Hmag(self): """getter of Hmag""" return self._Hmag def _set_Hmag(self, value): """setter of Hmag""" check_var("Hmag", value, "float", Vmin=0) self._Hmag = value Hmag = property( fget=_get_Hmag, fset=_set_Hmag, doc=u"""Magnet Height :Type: float :min: 0 """, )