pyleecan.Classes.DataKeeper module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Simulation/DataKeeper

class DataKeeper(name='', symbol='', unit='', keeper=None, error_keeper=None, result=- 1, result_ref=None, physic=None, init_dict=None, init_str=None)

Bases: FrozenClass

Class for defining data to keep on a multi-simulation

VERSION = 1

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)

Compare two objects and return list of differences

as_dict(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_functionbool

True to keep the function object, else return str

Optional keyword input parameter is for internal use only and may prevent json serializability.

copy()

Creates a deepcopy of the object

property name

Data name

Type:

str

property symbol

Data symbol

Type:

str

property unit

Data unit

Type:

str

property keeper

Function that takes an Output in argument and return a value

Type:

function

property error_keeper

Function that takes a Simulation in argument and returns a value, this attribute enables to handle errors and to put NaN values in the result matrices

Type:

function

property result

List containing datakeeper results for each simulation

Type:

[]

property result_ref

Result for the reference simulation

Type:

property physic

Physic of the tracked quantity

Type:

str