pyleecan.Classes.Unit module

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

class Unit(unit_m=0, unit_rad=0, unit_m2=0, init_dict=None, init_str=None)[source]

Bases: FrozenClass

VERSION = 1
get_m(value)

Convert the value the correct m unit (to display in GUI)

Parameters:
  • self (Unit) – A Unit object

  • value (float) – Value to convert

Returns:

value – Converted value in the current unit

Return type:

float

get_m2(value)

Convert the value the correct m² unit (to display in GUI)

Parameters:
  • self (Unit) – A Unit object

  • value (float) – Value to convert

Returns:

value – Value in the current unit

Return type:

float

get_m_name()

Return the name of the length unit ([m] by default)

Parameters:

self (Unit) – A Unit object

Returns:

unit_name – Name of the current unit

Return type:

str

get_m2_name()

Return the name of the current area unit

Parameters:

self (Unit) – A Unit object

Returns:

unit_name – Name of the current unit

Return type:

str

set_m(value)

Convert the value the correct m unit (to set in the object in m)

Parameters:
  • self (Unit) – A Unit object

  • value (float) – Value to convert

Returns:

value – value converted in [m]

Return type:

float

set_m2(value)

Convert the value the correct m² unit (to set in the object in m²)

Parameters:
  • self (Unit) – A Unit object

  • value (float) – Value to convert

Returns:

value – value converted in [m²]

Return type:

float

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 unit_m

use mm

Type:

int

Min:

0

Max:

1

Type:

0

Type:

use m, 1

property unit_rad

use deg

Type:

int

Min:

0

Max:

1

Type:

0

Type:

use rad, 1

property unit_m2

use mm^2

Type:

int

Min:

0

Max:

1

Type:

0

Type:

use m^2, 1