pyleecan.Classes.SurfRing module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Geometry/SurfRing

class SurfRing(out_surf=- 1, in_surf=- 1, point_ref=0, label='', init_dict=None, init_str=None)[source]

Bases: Surface

SurfRing is a surface between two closed surfaces (lamination surfaces for instance)

VERSION = 1
get_lines()

The list returned contains all the Line of the SurRing

Parameters:

self (SurfRing) – A SurfRing object

Returns:

line_list – list of lines delimiting the surface

Return type:

list

rotate(angle)

Rotate the surface

Parameters:

  • self (SurfRing) – A SurfRing object

  • angle (float) – the angle of rotation [rad]

Return type:

None

translate(Zt)

Translate the surface

Parameters:

  • self (SurfRing) – A SurfRing object

  • Zt (complex) – Complex value for translation

Return type:

None

check()

assert the Surface is correct

Parameters:

self (SurfRing) – A SurfRing object

Return type:

None

comp_length()

Compute the length of the SurfRing object (length of both surfaces)

Parameters:

self (SurfRing) – A SurfRing object

Returns:

length – Length of the surface [m]

Return type:

float

get_patches(color='w', edgecolor=None, is_edge_only=False, linestyle=None)

Returns the PolarArc Patch to be display in matplotlib

Parameters:

  • self (SurfLine) – a SurfLine object

  • color – the color of the patch (Default value = PATCH_COLOR)

  • edgecolor – the edge color of the patch (Default value = PATCH_EDGE)

  • is_edge_only (bool) – To set the transparancy of the face color to 0 and 1 for the edge color

  • linestyle (str) – Line style of the edge {‘-’, ‘–’, ‘-.’, ‘:’, ‘’, (offset, on-off-seq), …}

Returns:

patch_list – List of patches corresponding to the surface

Return type:

list of matplotlib.patches.Polygon

discretize(Npoint=- 1)

Returns the discretize version of the SurfRing

Parameters:

  • self (SurfRing) – A SurfRing object

  • Npoint (int) – Number of point on each line (Default value = -1 => use the line default discretization)

Returns:

point_list – List of complex coordinates

Return type:

list

comp_surface()

Compute the SurfRing surface

Parameters:

self (SurfRing) – A SurfRing object

Returns:

surf – The SurfRing surface [m**2]

Return type:

float

plot_lines(fig=None, ax=None)

Plot the SurfRing-Contour in a matplotlib fig (For plotting unclosed contour, for Polygon use plot method from Surface object)

Parameters:

  • self (SurfRing) – A SurfRing object

  • fig (Matplotlib.figure.Figure) – existing figure to use if None create a new one

  • ax (Matplotlib.axes.Axes object) – Axis on which to plot the data

Returns:

  • fig (Matplotlib.figure.Figure) – Figure containing the plot

  • ax (Matplotlib.axes.Axes object) – Axis containing the plot

comp_point_ref(is_set=False)

Compute the point ref of the Surface

Parameters:

  • self (SurfRing) – A SurfRing object

  • is_set (bool) – True to update the point_ref property

Returns:

point_ref – the reference point of the surface

Return type:

complex

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 out_surf

Outter surface

Type:

Surface

property in_surf

Inner surface

Type:

Surface