Source code for pyleecan.Classes.Frame

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

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 ._frozen import FrozenClass

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

try:
    from ..Methods.Machine.Frame.comp_height_eq import comp_height_eq
except ImportError as error:
    comp_height_eq = error

try:
    from ..Methods.Machine.Frame.comp_mass import comp_mass
except ImportError as error:
    comp_mass = error

try:
    from ..Methods.Machine.Frame.comp_surface import comp_surface
except ImportError as error:
    comp_surface = error

try:
    from ..Methods.Machine.Frame.comp_volume import comp_volume
except ImportError as error:
    comp_volume = error

try:
    from ..Methods.Machine.Frame.get_length import get_length
except ImportError as error:
    get_length = error

try:
    from ..Methods.Machine.Frame.plot import plot
except ImportError as error:
    plot = error


from numpy import isnan
from ._check import InitUnKnowClassError


[docs]class Frame(FrozenClass): """machine frame""" VERSION = 1 # Check ImportError to remove unnecessary dependencies in unused method # cf Methods.Machine.Frame.build_geometry if isinstance(build_geometry, ImportError): build_geometry = property( fget=lambda x: raise_( ImportError( "Can't use Frame method build_geometry: " + str(build_geometry) ) ) ) else: build_geometry = build_geometry # cf Methods.Machine.Frame.comp_height_eq if isinstance(comp_height_eq, ImportError): comp_height_eq = property( fget=lambda x: raise_( ImportError( "Can't use Frame method comp_height_eq: " + str(comp_height_eq) ) ) ) else: comp_height_eq = comp_height_eq # cf Methods.Machine.Frame.comp_mass if isinstance(comp_mass, ImportError): comp_mass = property( fget=lambda x: raise_( ImportError("Can't use Frame method comp_mass: " + str(comp_mass)) ) ) else: comp_mass = comp_mass # cf Methods.Machine.Frame.comp_surface if isinstance(comp_surface, ImportError): comp_surface = property( fget=lambda x: raise_( ImportError("Can't use Frame method comp_surface: " + str(comp_surface)) ) ) else: comp_surface = comp_surface # cf Methods.Machine.Frame.comp_volume if isinstance(comp_volume, ImportError): comp_volume = property( fget=lambda x: raise_( ImportError("Can't use Frame method comp_volume: " + str(comp_volume)) ) ) else: comp_volume = comp_volume # cf Methods.Machine.Frame.get_length if isinstance(get_length, ImportError): get_length = property( fget=lambda x: raise_( ImportError("Can't use Frame method get_length: " + str(get_length)) ) ) else: get_length = get_length # cf Methods.Machine.Frame.plot if isinstance(plot, ImportError): plot = property( fget=lambda x: raise_( ImportError("Can't use Frame method plot: " + str(plot)) ) ) else: plot = plot # 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, Lfra=0.35, Rint=0.2, Rext=0.2, mat_type=-1, 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 "Lfra" in list(init_dict.keys()): Lfra = init_dict["Lfra"] if "Rint" in list(init_dict.keys()): Rint = init_dict["Rint"] if "Rext" in list(init_dict.keys()): Rext = init_dict["Rext"] if "mat_type" in list(init_dict.keys()): mat_type = init_dict["mat_type"] # Set the properties (value check and convertion are done in setter) self.parent = None self.Lfra = Lfra self.Rint = Rint self.Rext = Rext self.mat_type = mat_type # The class is frozen, for now it's impossible to add new properties self._freeze() def __str__(self): """Convert this object in a readeable string (for print)""" Frame_str = "" if self.parent is None: Frame_str += "parent = None " + linesep else: Frame_str += "parent = " + str(type(self.parent)) + " object" + linesep Frame_str += "Lfra = " + str(self.Lfra) + linesep Frame_str += "Rint = " + str(self.Rint) + linesep Frame_str += "Rext = " + str(self.Rext) + linesep if self.mat_type is not None: tmp = self.mat_type.__str__().replace(linesep, linesep + "\t").rstrip("\t") Frame_str += "mat_type = " + tmp else: Frame_str += "mat_type = None" + linesep + linesep return Frame_str def __eq__(self, other): """Compare two objects (skip parent)""" if type(other) != type(self): return False if other.Lfra != self.Lfra: return False if other.Rint != self.Rint: return False if other.Rext != self.Rext: return False if other.mat_type != self.mat_type: 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() if ( other._Lfra is not None and self._Lfra is not None and isnan(other._Lfra) and isnan(self._Lfra) ): pass elif other._Lfra != self._Lfra: if is_add_value: val_str = ( " (self=" + str(self._Lfra) + ", other=" + str(other._Lfra) + ")" ) diff_list.append(name + ".Lfra" + val_str) else: diff_list.append(name + ".Lfra") if ( other._Rint is not None and self._Rint is not None and isnan(other._Rint) and isnan(self._Rint) ): pass elif other._Rint != self._Rint: if is_add_value: val_str = ( " (self=" + str(self._Rint) + ", other=" + str(other._Rint) + ")" ) diff_list.append(name + ".Rint" + val_str) else: diff_list.append(name + ".Rint") if ( other._Rext is not None and self._Rext is not None and isnan(other._Rext) and isnan(self._Rext) ): pass elif other._Rext != self._Rext: if is_add_value: val_str = ( " (self=" + str(self._Rext) + ", other=" + str(other._Rext) + ")" ) diff_list.append(name + ".Rext" + val_str) else: diff_list.append(name + ".Rext") if (other.mat_type is None and self.mat_type is not None) or ( other.mat_type is not None and self.mat_type is None ): diff_list.append(name + ".mat_type None mismatch") elif self.mat_type is not None: diff_list.extend( self.mat_type.compare( other.mat_type, name=name + ".mat_type", ignore_list=ignore_list, is_add_value=is_add_value, ) ) # 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 S += getsizeof(self.Lfra) S += getsizeof(self.Rint) S += getsizeof(self.Rext) S += getsizeof(self.mat_type) 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. """ Frame_dict = dict() Frame_dict["Lfra"] = self.Lfra Frame_dict["Rint"] = self.Rint Frame_dict["Rext"] = self.Rext if self.mat_type is None: Frame_dict["mat_type"] = None else: Frame_dict["mat_type"] = self.mat_type.as_dict( type_handle_ndarray=type_handle_ndarray, keep_function=keep_function, **kwargs ) # The class name is added to the dict for deserialisation purpose Frame_dict["__class__"] = "Frame" return Frame_dict
[docs] def copy(self): """Creates a deepcopy of the object""" # Handle deepcopy of all the properties Lfra_val = self.Lfra Rint_val = self.Rint Rext_val = self.Rext if self.mat_type is None: mat_type_val = None else: mat_type_val = self.mat_type.copy() # Creates new object of the same type with the copied properties obj_copy = type(self)( Lfra=Lfra_val, Rint=Rint_val, Rext=Rext_val, mat_type=mat_type_val ) return obj_copy
def _set_None(self): """Set all the properties to None (except pyleecan object)""" self.Lfra = None self.Rint = None self.Rext = None if self.mat_type is not None: self.mat_type._set_None() def _get_Lfra(self): """getter of Lfra""" return self._Lfra def _set_Lfra(self, value): """setter of Lfra""" check_var("Lfra", value, "float", Vmin=0) self._Lfra = value Lfra = property( fget=_get_Lfra, fset=_set_Lfra, doc=u"""frame length [m] :Type: float :min: 0 """, ) def _get_Rint(self): """getter of Rint""" return self._Rint def _set_Rint(self, value): """setter of Rint""" check_var("Rint", value, "float", Vmin=0) self._Rint = value Rint = property( fget=_get_Rint, fset=_set_Rint, doc=u"""frame internal radius :Type: float :min: 0 """, ) def _get_Rext(self): """getter of Rext""" return self._Rext def _set_Rext(self, value): """setter of Rext""" check_var("Rext", value, "float", Vmin=0) self._Rext = value Rext = property( fget=_get_Rext, fset=_set_Rext, doc=u"""Frame external radius :Type: float :min: 0 """, ) def _get_mat_type(self): """getter of mat_type""" return self._mat_type def _set_mat_type(self, value): """setter of mat_type""" if isinstance(value, str): # Load from file try: value = load_init_dict(value)[1] except Exception as e: self.get_logger().error( "Error while loading " + value + ", setting None instead" ) value = None if isinstance(value, dict) and "__class__" in value: class_obj = import_class( "pyleecan.Classes", value.get("__class__"), "mat_type" ) value = class_obj(init_dict=value) elif type(value) is int and value == -1: # Default constructor Material = import_class("pyleecan.Classes", "Material", "mat_type") value = Material() check_var("mat_type", value, "Material") self._mat_type = value if self._mat_type is not None: self._mat_type.parent = self mat_type = property( fget=_get_mat_type, fset=_set_mat_type, doc=u"""Frame material :Type: Material """, )