# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Output/OutForce.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Output/OutForce
"""
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.Output.OutForce.store import store
except ImportError as error:
store = error
from numpy import isnan
from ._check import InitUnKnowClassError
[docs]class OutForce(FrozenClass):
"""Gather the structural module outputs"""
VERSION = 1
# cf Methods.Output.OutForce.store
if isinstance(store, ImportError):
store = property(
fget=lambda x: raise_(
ImportError("Can't use OutForce method store: " + str(store))
)
)
else:
store = store
# 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,
axes_dict=None,
AGSF=None,
logger_name="Pyleecan.Force",
Rag=None,
meshsolution=None,
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 "axes_dict" in list(init_dict.keys()):
axes_dict = init_dict["axes_dict"]
if "AGSF" in list(init_dict.keys()):
AGSF = init_dict["AGSF"]
if "logger_name" in list(init_dict.keys()):
logger_name = init_dict["logger_name"]
if "Rag" in list(init_dict.keys()):
Rag = init_dict["Rag"]
if "meshsolution" in list(init_dict.keys()):
meshsolution = init_dict["meshsolution"]
# Set the properties (value check and convertion are done in setter)
self.parent = None
self.axes_dict = axes_dict
self.AGSF = AGSF
self.logger_name = logger_name
self.Rag = Rag
self.meshsolution = meshsolution
# 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)"""
OutForce_str = ""
if self.parent is None:
OutForce_str += "parent = None " + linesep
else:
OutForce_str += "parent = " + str(type(self.parent)) + " object" + linesep
OutForce_str += "axes_dict = " + str(self.axes_dict) + linesep + linesep
OutForce_str += "AGSF = " + str(self.AGSF) + linesep + linesep
OutForce_str += 'logger_name = "' + str(self.logger_name) + '"' + linesep
OutForce_str += "Rag = " + str(self.Rag) + linesep
if self.meshsolution is not None:
tmp = (
self.meshsolution.__str__()
.replace(linesep, linesep + "\t")
.rstrip("\t")
)
OutForce_str += "meshsolution = " + tmp
else:
OutForce_str += "meshsolution = None" + linesep + linesep
return OutForce_str
def __eq__(self, other):
"""Compare two objects (skip parent)"""
if type(other) != type(self):
return False
if other.axes_dict != self.axes_dict:
return False
if other.AGSF != self.AGSF:
return False
if other.logger_name != self.logger_name:
return False
if other.Rag != self.Rag:
return False
if other.meshsolution != self.meshsolution:
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.axes_dict is None and self.axes_dict is not None) or (
other.axes_dict is not None and self.axes_dict is None
):
diff_list.append(name + ".axes_dict None mismatch")
elif self.axes_dict is None:
pass
elif len(other.axes_dict) != len(self.axes_dict):
diff_list.append("len(" + name + "axes_dict)")
else:
for key in self.axes_dict:
diff_list.extend(
self.axes_dict[key].compare(
other.axes_dict[key],
name=name + ".axes_dict[" + str(key) + "]",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if (other.AGSF is None and self.AGSF is not None) or (
other.AGSF is not None and self.AGSF is None
):
diff_list.append(name + ".AGSF None mismatch")
elif self.AGSF is not None:
diff_list.extend(
self.AGSF.compare(
other.AGSF,
name=name + ".AGSF",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if other._logger_name != self._logger_name:
if is_add_value:
val_str = (
" (self="
+ str(self._logger_name)
+ ", other="
+ str(other._logger_name)
+ ")"
)
diff_list.append(name + ".logger_name" + val_str)
else:
diff_list.append(name + ".logger_name")
if (
other._Rag is not None
and self._Rag is not None
and isnan(other._Rag)
and isnan(self._Rag)
):
pass
elif other._Rag != self._Rag:
if is_add_value:
val_str = (
" (self=" + str(self._Rag) + ", other=" + str(other._Rag) + ")"
)
diff_list.append(name + ".Rag" + val_str)
else:
diff_list.append(name + ".Rag")
if (other.meshsolution is None and self.meshsolution is not None) or (
other.meshsolution is not None and self.meshsolution is None
):
diff_list.append(name + ".meshsolution None mismatch")
elif self.meshsolution is not None:
diff_list.extend(
self.meshsolution.compare(
other.meshsolution,
name=name + ".meshsolution",
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
if self.axes_dict is not None:
for key, value in self.axes_dict.items():
S += getsizeof(value) + getsizeof(key)
S += getsizeof(self.AGSF)
S += getsizeof(self.logger_name)
S += getsizeof(self.Rag)
S += getsizeof(self.meshsolution)
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.
"""
OutForce_dict = dict()
if self.axes_dict is None:
OutForce_dict["axes_dict"] = None
else:
OutForce_dict["axes_dict"] = dict()
for key, obj in self.axes_dict.items():
if obj is not None:
OutForce_dict["axes_dict"][key] = obj.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
else:
OutForce_dict["axes_dict"][key] = None
if self.AGSF is None:
OutForce_dict["AGSF"] = None
else:
OutForce_dict["AGSF"] = self.AGSF.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
OutForce_dict["logger_name"] = self.logger_name
OutForce_dict["Rag"] = self.Rag
if self.meshsolution is None:
OutForce_dict["meshsolution"] = None
else:
OutForce_dict["meshsolution"] = self.meshsolution.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
# The class name is added to the dict for deserialisation purpose
OutForce_dict["__class__"] = "OutForce"
return OutForce_dict
[docs] def copy(self):
"""Creates a deepcopy of the object"""
# Handle deepcopy of all the properties
if self.axes_dict is None:
axes_dict_val = None
else:
axes_dict_val = dict()
for key, obj in self.axes_dict.items():
axes_dict_val[key] = obj.copy()
if self.AGSF is None:
AGSF_val = None
else:
AGSF_val = self.AGSF.copy()
logger_name_val = self.logger_name
Rag_val = self.Rag
if self.meshsolution is None:
meshsolution_val = None
else:
meshsolution_val = self.meshsolution.copy()
# Creates new object of the same type with the copied properties
obj_copy = type(self)(
axes_dict=axes_dict_val,
AGSF=AGSF_val,
logger_name=logger_name_val,
Rag=Rag_val,
meshsolution=meshsolution_val,
)
return obj_copy
def _set_None(self):
"""Set all the properties to None (except pyleecan object)"""
self.axes_dict = None
self.AGSF = None
self.logger_name = None
self.Rag = None
if self.meshsolution is not None:
self.meshsolution._set_None()
def _get_axes_dict(self):
"""getter of axes_dict"""
if self._axes_dict is not None:
for key, obj in self._axes_dict.items():
if obj is not None:
obj.parent = self
return self._axes_dict
def _set_axes_dict(self, value):
"""setter of axes_dict"""
if type(value) is dict:
for key, obj in value.items():
if isinstance(obj, str): # Load from file
try:
obj = load_init_dict(obj)[1]
except Exception as e:
self.get_logger().error(
"Error while loading " + obj + ", setting None instead"
)
obj = None
value[key] = None
if type(obj) is dict:
class_obj = import_class(
"SciDataTool.Classes", obj.get("__class__"), "axes_dict"
)
value[key] = class_obj(init_dict=obj)
if type(value) is int and value == -1:
value = dict()
check_var("axes_dict", value, "{Data}")
self._axes_dict = value
axes_dict = property(
fget=_get_axes_dict,
fset=_set_axes_dict,
doc=u"""Dict containing axes data used for Force
:Type: {SciDataTool.Classes.DataND.Data}
""",
)
def _get_AGSF(self):
"""getter of AGSF"""
return self._AGSF
def _set_AGSF(self, value):
"""setter of AGSF"""
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(
"SciDataTool.Classes", value.get("__class__"), "AGSF"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
value = VectorField()
check_var("AGSF", value, "VectorField")
self._AGSF = value
AGSF = property(
fget=_get_AGSF,
fset=_set_AGSF,
doc=u"""Air Gap Surface Force (mainly computed with Maxwell stress tensor)
:Type: SciDataTool.Classes.VectorField.VectorField
""",
)
def _get_logger_name(self):
"""getter of logger_name"""
return self._logger_name
def _set_logger_name(self, value):
"""setter of logger_name"""
check_var("logger_name", value, "str")
self._logger_name = value
logger_name = property(
fget=_get_logger_name,
fset=_set_logger_name,
doc=u"""Name of the logger to use
:Type: str
""",
)
def _get_Rag(self):
"""getter of Rag"""
return self._Rag
def _set_Rag(self, value):
"""setter of Rag"""
check_var("Rag", value, "float")
self._Rag = value
Rag = property(
fget=_get_Rag,
fset=_set_Rag,
doc=u"""Radius value for air-gap computation
:Type: float
""",
)
def _get_meshsolution(self):
"""getter of meshsolution"""
return self._meshsolution
def _set_meshsolution(self, value):
"""setter of meshsolution"""
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__"), "meshsolution"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
MeshSolution = import_class(
"pyleecan.Classes", "MeshSolution", "meshsolution"
)
value = MeshSolution()
check_var("meshsolution", value, "MeshSolution")
self._meshsolution = value
if self._meshsolution is not None:
self._meshsolution.parent = self
meshsolution = property(
fget=_get_meshsolution,
fset=_set_meshsolution,
doc=u"""Force computed on a mesh
:Type: MeshSolution
""",
)
