pyleecan.Classes.ParamExplorerInterval module

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

class ParamExplorerInterval(min_value=0, max_value=1, N=4, type_value_gen=0, type_value=0, name='', symbol='', unit='', setter=None, getter=None, init_dict=None, init_str=None)

Bases: ParamExplorer

Define a set of value (for parameter sweep) on interval

VERSION = 1

get_value()

Return parameters values

get_min()

Return the minimum value of the ParamExplorer

Parameters:

self (ParamExplorerInterval) – A ParamExplorerInterval object

Returns:

min_value – Minimum value of the ParamExplorer

Return type:

float

get_max()

Return the maximum value of the ParamExplorer

Parameters:

self (ParamExplorerInterval) – A ParamExplorerInterval object

Returns:

max_value – Maximum value of the ParamExplorer

Return type:

float

get_N()

Return the number of value of the ParamExplorer

Parameters:

self (ParamExplorerInterval) – A ParamExplorerInterval object

Returns:

N – number of value of the ParamExplorer

Return type:

int

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 min_value

Minumum value of the interval

Type:

float

property max_value

Maximum value of the interval

Type:

float

property N

Number of value to take in the interval

Type:

int

Min:

2

property type_value_gen

random (Not available yet)

Type:

int

Min:

0

Max:

1

Type:

How to generate the value list. 0

Type:

linspace, 1

property type_value

float, 1:int

Type:

int

Min:

0

Max:

1

Type:

Type of the value

Type:

0