pyleecan.Classes.OutForce module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Output/OutForce

class OutForce(axes_dict=None, AGSF=None, logger_name='Pyleecan.Force', Rag=None, meshsolution=None, init_dict=None, init_str=None)[source]

Bases: FrozenClass

Gather the structural module outputs

VERSION = 1
store(out_dict, axes_dict)

Store the standard outputs of Force that are temporarily in out_dict as arrays into OutForce as Data object

Parameters:

  • self (OutForce) – the OutForce object to update

  • out_dict (dict) – Dict containing all force quantities

  • axes_dict ({Data}) – Dict of axes used for magnetic calculation

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 axes_dict

Dict containing axes data used for Force

Type:

{SciDataTool.Classes.DataND.Data}

property AGSF

Air Gap Surface Force (mainly computed with Maxwell stress tensor)

Type:

SciDataTool.Classes.VectorField.VectorField

property logger_name

Name of the logger to use

Type:

str

property Rag

Radius value for air-gap computation

Type:

float

property meshsolution

Force computed on a mesh

Type:

MeshSolution