pyleecan.Classes.Simulation module

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

class Simulation(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)

Bases: FrozenClass

Abstract class for the simulation

VERSION = 1

run()

Run the simulation and optionnaly its multisimulation

Returns:

output – Contains simulation results

Return type:

Output

init_logger(output)

Create all the logger for the simulation

Parameters:

• self (Simulation) – A Simulation object

• output (XOuput) – XOutput or Output object

get_var_load()

Return the VarLoad object from var_simu or var_simu.var_simu

Parameters:

self (Simulation) – A Simulation object

get_OP_array(*arg_list)

Return the OP matrix of the simulation Single speed simulation return a single line matrix

Parameters:

• self (Simulation) – A Simulation object

• *arg_list (list of str) – arguments to select the OP_matrix columns name (N0, Id, Id, Tem…)

Returns:

OP_matrix – Operating Points matrix (N_OP, len(arg_list))

Return type:

ndarray

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

Name of the simulation

Type:

str

property desc

Simulation description

Type:

str

property machine

Machine to simulate

Type:

Machine

property input

Input of the simulation

Type:

Input

property logger_name

Name of the logger to use

Type:

str

property var_simu

Multi-simulation definition

Type:

VarSimu

property postproc_list

List of postprocessings to run on Output after the simulation

Type:

[Post]

property index

Index of the simulation (if part of a multi-simulation)

Type:

int

Min:

0

property path_result

Path to the Result folder to use (None to use default one)

Type:

str

property layer

Layer of the simulation in a multi-simulation (0 is top simulation)

Type:

int

Min:

0

property layer_log_warn

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