Frame (class)

File generated according to Generator/ClassesRef/Machine/Frame.csv WARNING! All changes made in this file will be lost!

class Frame(Lfra=0.35, Rint=0.2, Rext=0.2, mat_type=-1, init_dict=None)[source]

Bases: pyleecan.Classes._frozen.FrozenClass

machine frame

VERSION = 1
build_geometry(sym=1, alpha=0, delta=0)

Build the geometry of the Frame

Parameters:
  • self (Frame) – Frame Object
  • sym (int) – symmetry factor (1= full machine, 2= half of the machine…)
  • alpha (float) – Angle for rotation [rad]
  • delta (complex) – Complex value for translation
Returns:

surf_list – list of surface

Return type:

list

comp_height_eq()

Computation of the Frame equivalent Height for the mechanical model

Parameters:self (Frame) – A Frame object
Returns:Hfra – Equivalent Height of the Frame [m]
Return type:float
comp_mass()

Compute the mass of the Frame

Parameters:self (Frame) – A Frame object
Returns:Mfra – Mass of the Frame [kg]
Return type:float
comp_surface()

Compute the surface of the Frame

Parameters:self (Frame) – A Frame object
Returns:Sfra – Surface of the Frame [m**2]
Return type:float
comp_volume()

Compute the volume of the Frame

Parameters:self (Frame) – A Frame object
Returns:Vfra – Volume of the Frame [m**3]
Return type:float
get_length()

Return the length of the Frame

Parameters:self (Frame) – A Frame object
Returns:length – Length of the frame
Return type:float
plot(fig=None, sym=1, alpha=0, delta=0, is_edge_only=False)

Plot the Frame in a matplotlib fig

Parameters:
  • self (Frame) – A Frame object
  • fig – if None, open a new fig and plot, else add to the gcf (Default value = None)
  • sym (int) – Symmetry factor (1= plot full machine, 2= half of the machine…)
  • alpha (float) – Angle for rotation [rad]
  • delta (complex) – Complex value for translation
  • is_edge_only (bool) – To plot transparent Patches
Returns:

Return type:

None

save(save_path='')

Save the object to the save_path

Parameters:
  • self – A pyleecan object
  • save_path (str) – path to the folder to save the object
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
as_dict()[source]

Convert this objet in a json seriable dict (can be use in __init__)

Lfra

frame length [m]

Rint

frame internal radius

Rext

Frame external radius

mat_type

Frame material