pyleecan.Classes.Mode module¶

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

class Mode(nat_freq=None, order_circ=None, order_long=None, field=None, indice=None, axis_name=None, axis_size=None, type_cell='triangle', label=None, dimension=2, unit='', init_dict=None, init_str=None)[source]¶

Bases: SolutionMat

Structural module: Mode object

VERSION = 1¶

plot(i)¶

Return the pyvista mesh object.

Parameters:

self (Mode) – a Mode object
i (int) – index of the mode to plot

Returns:

mesh – a pyvista StructuredGrid object

Return type:

pyvista.core.pointset.StructuredGrid

plot_animated(i)¶

Return the pyvista mesh object.

Parameters:

self (Mode) – a Mode object
i (int) – index of the mode to plot

Returns:

mesh – a pyvista StructuredGrid object

Return type:

pyvista.core.pointset.StructuredGrid

get_shape_xyz()¶

Return the mode shape in cartesian coordinates.

Parameters:: self (Mode) – a Mode object
Returns:: shape – ndarray of the shape (Nnodes*Ndof)
Return type:: ndarray

get_shape_pol()¶

Return the mode shape in cartesian coordinates.

Parameters:: self (Mode) – a Mode object
Returns:: shape – ndarray of the shape (Nnodes*Ndof)
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)[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 nat_freq¶

Natural frequency of the mode

Type:: float

property order_circ¶

Circumferential order

Type:: int
Min:: 0

property order_long¶

Longitudinal order

Type:: int
Min:: 0