pyleecan.Classes.ParamExplorer module

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

class ParamExplorer(name='', symbol='', unit='', setter=None, getter=None, init_dict=None, init_str=None)[source]

Bases: FrozenClass

Abstract class for the multi-simulation

VERSION = 1
get_desc(simu=None, is_print=False)

Generate a string description of the ParamExplorer

Parameters:

  • self (ParamExplorer) – A ParamExplorer object

  • simu (Simulation) – Optional simulation object to add reference value

  • is_print (bool) – True to call print on desc

Returns:

desc – Description (for instance “W0: N values from 0.001 to 0.01 (ref=0.0015) [m]”)

Return type:

str

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)[source]

Compare two objects and return list of differences

as_dict(type_handle_ndarray=0, keep_function=False, **kwargs)[source]

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()[source]

Creates a deepcopy of the object

property name

Parameter name

Type:

str

property symbol

Parameter symbol

Type:

str

property unit

Parameter unit

Type:

str

property setter

Function that takes a Simulation and a value in argument and modifiers the simulation

Type:

function

property getter

Function to return the reference value (simulation as argument)

Type:

function