# -*- coding: utf-8 -*-
# File generated according to Generator/ClassesRef/Simulation/Simulation.csv
# WARNING! All changes made in this file will be lost!
"""Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Simulation/Simulation
"""
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.Simulation.Simulation.run import run
except ImportError as error:
run = error
try:
from ..Methods.Simulation.Simulation.init_logger import init_logger
except ImportError as error:
init_logger = error
try:
from ..Methods.Simulation.Simulation.get_var_load import get_var_load
except ImportError as error:
get_var_load = error
try:
from ..Methods.Simulation.Simulation.get_OP_array import get_OP_array
except ImportError as error:
get_OP_array = error
from numpy import isnan
from ._check import InitUnKnowClassError
[docs]class Simulation(FrozenClass):
"""Abstract class for the simulation"""
VERSION = 1
# Check ImportError to remove unnecessary dependencies in unused method
# cf Methods.Simulation.Simulation.run
if isinstance(run, ImportError):
run = property(
fget=lambda x: raise_(
ImportError("Can't use Simulation method run: " + str(run))
)
)
else:
run = run
# cf Methods.Simulation.Simulation.init_logger
if isinstance(init_logger, ImportError):
init_logger = property(
fget=lambda x: raise_(
ImportError(
"Can't use Simulation method init_logger: " + str(init_logger)
)
)
)
else:
init_logger = init_logger
# cf Methods.Simulation.Simulation.get_var_load
if isinstance(get_var_load, ImportError):
get_var_load = property(
fget=lambda x: raise_(
ImportError(
"Can't use Simulation method get_var_load: " + str(get_var_load)
)
)
)
else:
get_var_load = get_var_load
# cf Methods.Simulation.Simulation.get_OP_array
if isinstance(get_OP_array, ImportError):
get_OP_array = property(
fget=lambda x: raise_(
ImportError(
"Can't use Simulation method get_OP_array: " + str(get_OP_array)
)
)
)
else:
get_OP_array = get_OP_array
# 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,
name="",
desc="",
machine=-1,
input=-1,
logger_name="Pyleecan.Simulation",
var_simu=None,
postproc_list=-1,
index=None,
path_result=None,
layer=None,
layer_log_warn=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 "name" in list(init_dict.keys()):
name = init_dict["name"]
if "desc" in list(init_dict.keys()):
desc = init_dict["desc"]
if "machine" in list(init_dict.keys()):
machine = init_dict["machine"]
if "input" in list(init_dict.keys()):
input = init_dict["input"]
if "logger_name" in list(init_dict.keys()):
logger_name = init_dict["logger_name"]
if "var_simu" in list(init_dict.keys()):
var_simu = init_dict["var_simu"]
if "postproc_list" in list(init_dict.keys()):
postproc_list = init_dict["postproc_list"]
if "index" in list(init_dict.keys()):
index = init_dict["index"]
if "path_result" in list(init_dict.keys()):
path_result = init_dict["path_result"]
if "layer" in list(init_dict.keys()):
layer = init_dict["layer"]
if "layer_log_warn" in list(init_dict.keys()):
layer_log_warn = init_dict["layer_log_warn"]
# Set the properties (value check and convertion are done in setter)
self.parent = None
self.name = name
self.desc = desc
self.machine = machine
self.input = input
self.logger_name = logger_name
self.var_simu = var_simu
self.postproc_list = postproc_list
self.index = index
self.path_result = path_result
self.layer = layer
self.layer_log_warn = layer_log_warn
# 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)"""
Simulation_str = ""
if self.parent is None:
Simulation_str += "parent = None " + linesep
else:
Simulation_str += "parent = " + str(type(self.parent)) + " object" + linesep
Simulation_str += 'name = "' + str(self.name) + '"' + linesep
Simulation_str += 'desc = "' + str(self.desc) + '"' + linesep
if self.machine is not None:
tmp = self.machine.__str__().replace(linesep, linesep + "\t").rstrip("\t")
Simulation_str += "machine = " + tmp
else:
Simulation_str += "machine = None" + linesep + linesep
if self.input is not None:
tmp = self.input.__str__().replace(linesep, linesep + "\t").rstrip("\t")
Simulation_str += "input = " + tmp
else:
Simulation_str += "input = None" + linesep + linesep
Simulation_str += 'logger_name = "' + str(self.logger_name) + '"' + linesep
if self.var_simu is not None:
tmp = self.var_simu.__str__().replace(linesep, linesep + "\t").rstrip("\t")
Simulation_str += "var_simu = " + tmp
else:
Simulation_str += "var_simu = None" + linesep + linesep
if len(self.postproc_list) == 0:
Simulation_str += "postproc_list = []" + linesep
for ii in range(len(self.postproc_list)):
tmp = (
self.postproc_list[ii].__str__().replace(linesep, linesep + "\t")
+ linesep
)
Simulation_str += (
"postproc_list[" + str(ii) + "] =" + tmp + linesep + linesep
)
Simulation_str += "index = " + str(self.index) + linesep
Simulation_str += 'path_result = "' + str(self.path_result) + '"' + linesep
Simulation_str += "layer = " + str(self.layer) + linesep
Simulation_str += "layer_log_warn = " + str(self.layer_log_warn) + linesep
return Simulation_str
def __eq__(self, other):
"""Compare two objects (skip parent)"""
if type(other) != type(self):
return False
if other.name != self.name:
return False
if other.desc != self.desc:
return False
if other.machine != self.machine:
return False
if other.input != self.input:
return False
if other.logger_name != self.logger_name:
return False
if other.var_simu != self.var_simu:
return False
if other.postproc_list != self.postproc_list:
return False
if other.index != self.index:
return False
if other.path_result != self.path_result:
return False
if other.layer != self.layer:
return False
if other.layer_log_warn != self.layer_log_warn:
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._name != self._name:
if is_add_value:
val_str = (
" (self=" + str(self._name) + ", other=" + str(other._name) + ")"
)
diff_list.append(name + ".name" + val_str)
else:
diff_list.append(name + ".name")
if other._desc != self._desc:
if is_add_value:
val_str = (
" (self=" + str(self._desc) + ", other=" + str(other._desc) + ")"
)
diff_list.append(name + ".desc" + val_str)
else:
diff_list.append(name + ".desc")
if (other.machine is None and self.machine is not None) or (
other.machine is not None and self.machine is None
):
diff_list.append(name + ".machine None mismatch")
elif self.machine is not None:
diff_list.extend(
self.machine.compare(
other.machine,
name=name + ".machine",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if (other.input is None and self.input is not None) or (
other.input is not None and self.input is None
):
diff_list.append(name + ".input None mismatch")
elif self.input is not None:
diff_list.extend(
self.input.compare(
other.input,
name=name + ".input",
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.var_simu is None and self.var_simu is not None) or (
other.var_simu is not None and self.var_simu is None
):
diff_list.append(name + ".var_simu None mismatch")
elif self.var_simu is not None:
diff_list.extend(
self.var_simu.compare(
other.var_simu,
name=name + ".var_simu",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if (other.postproc_list is None and self.postproc_list is not None) or (
other.postproc_list is not None and self.postproc_list is None
):
diff_list.append(name + ".postproc_list None mismatch")
elif self.postproc_list is None:
pass
elif len(other.postproc_list) != len(self.postproc_list):
diff_list.append("len(" + name + ".postproc_list)")
else:
for ii in range(len(other.postproc_list)):
diff_list.extend(
self.postproc_list[ii].compare(
other.postproc_list[ii],
name=name + ".postproc_list[" + str(ii) + "]",
ignore_list=ignore_list,
is_add_value=is_add_value,
)
)
if other._index != self._index:
if is_add_value:
val_str = (
" (self=" + str(self._index) + ", other=" + str(other._index) + ")"
)
diff_list.append(name + ".index" + val_str)
else:
diff_list.append(name + ".index")
if other._path_result != self._path_result:
if is_add_value:
val_str = (
" (self="
+ str(self._path_result)
+ ", other="
+ str(other._path_result)
+ ")"
)
diff_list.append(name + ".path_result" + val_str)
else:
diff_list.append(name + ".path_result")
if other._layer != self._layer:
if is_add_value:
val_str = (
" (self=" + str(self._layer) + ", other=" + str(other._layer) + ")"
)
diff_list.append(name + ".layer" + val_str)
else:
diff_list.append(name + ".layer")
if other._layer_log_warn != self._layer_log_warn:
if is_add_value:
val_str = (
" (self="
+ str(self._layer_log_warn)
+ ", other="
+ str(other._layer_log_warn)
+ ")"
)
diff_list.append(name + ".layer_log_warn" + val_str)
else:
diff_list.append(name + ".layer_log_warn")
# 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.name)
S += getsizeof(self.desc)
S += getsizeof(self.machine)
S += getsizeof(self.input)
S += getsizeof(self.logger_name)
S += getsizeof(self.var_simu)
if self.postproc_list is not None:
for value in self.postproc_list:
S += getsizeof(value)
S += getsizeof(self.index)
S += getsizeof(self.path_result)
S += getsizeof(self.layer)
S += getsizeof(self.layer_log_warn)
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.
"""
Simulation_dict = dict()
Simulation_dict["name"] = self.name
Simulation_dict["desc"] = self.desc
if self.machine is None:
Simulation_dict["machine"] = None
else:
Simulation_dict["machine"] = self.machine.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
if self.input is None:
Simulation_dict["input"] = None
else:
Simulation_dict["input"] = self.input.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
Simulation_dict["logger_name"] = self.logger_name
if self.var_simu is None:
Simulation_dict["var_simu"] = None
else:
Simulation_dict["var_simu"] = self.var_simu.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
if self.postproc_list is None:
Simulation_dict["postproc_list"] = None
else:
Simulation_dict["postproc_list"] = list()
for obj in self.postproc_list:
if obj is not None:
Simulation_dict["postproc_list"].append(
obj.as_dict(
type_handle_ndarray=type_handle_ndarray,
keep_function=keep_function,
**kwargs
)
)
else:
Simulation_dict["postproc_list"].append(None)
Simulation_dict["index"] = self.index
Simulation_dict["path_result"] = self.path_result
Simulation_dict["layer"] = self.layer
Simulation_dict["layer_log_warn"] = self.layer_log_warn
# The class name is added to the dict for deserialisation purpose
Simulation_dict["__class__"] = "Simulation"
return Simulation_dict
[docs] def copy(self):
"""Creates a deepcopy of the object"""
# Handle deepcopy of all the properties
name_val = self.name
desc_val = self.desc
if self.machine is None:
machine_val = None
else:
machine_val = self.machine.copy()
if self.input is None:
input_val = None
else:
input_val = self.input.copy()
logger_name_val = self.logger_name
if self.var_simu is None:
var_simu_val = None
else:
var_simu_val = self.var_simu.copy()
if self.postproc_list is None:
postproc_list_val = None
else:
postproc_list_val = list()
for obj in self.postproc_list:
postproc_list_val.append(obj.copy())
index_val = self.index
path_result_val = self.path_result
layer_val = self.layer
layer_log_warn_val = self.layer_log_warn
# Creates new object of the same type with the copied properties
obj_copy = type(self)(
name=name_val,
desc=desc_val,
machine=machine_val,
input=input_val,
logger_name=logger_name_val,
var_simu=var_simu_val,
postproc_list=postproc_list_val,
index=index_val,
path_result=path_result_val,
layer=layer_val,
layer_log_warn=layer_log_warn_val,
)
return obj_copy
def _set_None(self):
"""Set all the properties to None (except pyleecan object)"""
self.name = None
self.desc = None
if self.machine is not None:
self.machine._set_None()
if self.input is not None:
self.input._set_None()
self.logger_name = None
if self.var_simu is not None:
self.var_simu._set_None()
self.postproc_list = None
self.index = None
self.path_result = None
self.layer = None
self.layer_log_warn = None
def _get_name(self):
"""getter of name"""
return self._name
def _set_name(self, value):
"""setter of name"""
check_var("name", value, "str")
self._name = value
name = property(
fget=_get_name,
fset=_set_name,
doc=u"""Name of the simulation
:Type: str
""",
)
def _get_desc(self):
"""getter of desc"""
return self._desc
def _set_desc(self, value):
"""setter of desc"""
check_var("desc", value, "str")
self._desc = value
desc = property(
fget=_get_desc,
fset=_set_desc,
doc=u"""Simulation description
:Type: str
""",
)
def _get_machine(self):
"""getter of machine"""
return self._machine
def _set_machine(self, value):
"""setter of machine"""
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__"), "machine"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
Machine = import_class("pyleecan.Classes", "Machine", "machine")
value = Machine()
check_var("machine", value, "Machine")
self._machine = value
if self._machine is not None:
self._machine.parent = self
machine = property(
fget=_get_machine,
fset=_set_machine,
doc=u"""Machine to simulate
:Type: Machine
""",
)
def _get_input(self):
"""getter of input"""
return self._input
def _set_input(self, value):
"""setter of input"""
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__"), "input"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
Input = import_class("pyleecan.Classes", "Input", "input")
value = Input()
check_var("input", value, "Input")
self._input = value
if self._input is not None:
self._input.parent = self
input = property(
fget=_get_input,
fset=_set_input,
doc=u"""Input of the simulation
:Type: Input
""",
)
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_var_simu(self):
"""getter of var_simu"""
return self._var_simu
def _set_var_simu(self, value):
"""setter of var_simu"""
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__"), "var_simu"
)
value = class_obj(init_dict=value)
elif type(value) is int and value == -1: # Default constructor
VarSimu = import_class("pyleecan.Classes", "VarSimu", "var_simu")
value = VarSimu()
check_var("var_simu", value, "VarSimu")
self._var_simu = value
if self._var_simu is not None:
self._var_simu.parent = self
var_simu = property(
fget=_get_var_simu,
fset=_set_var_simu,
doc=u"""Multi-simulation definition
:Type: VarSimu
""",
)
def _get_postproc_list(self):
"""getter of postproc_list"""
if self._postproc_list is not None:
for obj in self._postproc_list:
if obj is not None:
obj.parent = self
return self._postproc_list
def _set_postproc_list(self, value):
"""setter of postproc_list"""
if type(value) is list:
for ii, obj in enumerate(value):
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[ii] = None
if type(obj) is dict:
class_obj = import_class(
"pyleecan.Classes", obj.get("__class__"), "postproc_list"
)
value[ii] = class_obj(init_dict=obj)
if value[ii] is not None:
value[ii].parent = self
if value == -1:
value = list()
check_var("postproc_list", value, "[Post]")
self._postproc_list = value
postproc_list = property(
fget=_get_postproc_list,
fset=_set_postproc_list,
doc=u"""List of postprocessings to run on Output after the simulation
:Type: [Post]
""",
)
def _get_index(self):
"""getter of index"""
return self._index
def _set_index(self, value):
"""setter of index"""
check_var("index", value, "int", Vmin=0)
self._index = value
index = property(
fget=_get_index,
fset=_set_index,
doc=u"""Index of the simulation (if part of a multi-simulation)
:Type: int
:min: 0
""",
)
def _get_path_result(self):
"""getter of path_result"""
return self._path_result
def _set_path_result(self, value):
"""setter of path_result"""
check_var("path_result", value, "str")
self._path_result = value
path_result = property(
fget=_get_path_result,
fset=_set_path_result,
doc=u"""Path to the Result folder to use (None to use default one)
:Type: str
""",
)
def _get_layer(self):
"""getter of layer"""
return self._layer
def _set_layer(self, value):
"""setter of layer"""
check_var("layer", value, "int", Vmin=0)
self._layer = value
layer = property(
fget=_get_layer,
fset=_set_layer,
doc=u"""Layer of the simulation in a multi-simulation (0 is top simulation)
:Type: int
:min: 0
""",
)
def _get_layer_log_warn(self):
"""getter of layer_log_warn"""
return self._layer_log_warn
def _set_layer_log_warn(self, value):
"""setter of layer_log_warn"""
check_var("layer_log_warn", value, "int", Vmin=0)
self._layer_log_warn = value
layer_log_warn = property(
fget=_get_layer_log_warn,
fset=_set_layer_log_warn,
doc=u"""Enable to set the log console_handler to warning starting from a particular layer. layer_log_warn=2 => layer 0 and 1 info, layer 2 warning
:Type: int
:min: 0
""",
)
