pyleecan.Classes.BoreUD module

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

class BoreUD(line_list=- 1, sym=1, name='', type_merge_slot=1, alpha=0, init_dict=None, init_str=None)[source]

Bases: Bore

User Defined Bore shape

VERSION = 1
get_bore_line(label=None)

Return the bore line description

Parameters:

self (BoreUD) – A BoreUD object

Returns:

bore_list – List of bore lines

Return type:

list

comp_periodicity_spatial()

Compute the periodicity factor of the Bore

Parameters:

self (BoreUD) – A BoreUD object

Returns:

  • per_a (int) – Number of spatial periodicities of the bore

  • is_antiper_a (bool) – True if an spatial anti-periodicity is possible after the periodicities

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 line_list

List of line to draw the full bore

Type:

[Line]

property sym

Symmetry factor (1= full machine, 2= half of the machine…)

Type:

int

Min:

1

property name

Name of the bore (for save)

Type:

str