pyleecan.Classes.ElmerResults module

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Elmer/ElmerResults

class ElmerResults(data=- 1, file='', usecols=- 1, columns=- 1, is_scalars=False, logger_name='Pyleecan.Elmer', init_dict=None, init_str=None)

Bases: Elmer

Class to get ‘SaveScalars’ and ‘SaveLine’ data

VERSION = 1

load_data()

Method to load the Elmer simulation results (as an alternative for direct input)

Parameters:

self (ElmerResults) – An ElmerResults object

Returns:

data – list of data

Return type:

list

load_columns()

Method to load the names of the columns data of the Elmer simulation results

Parameters:

self (ElmerResults) – An ElmerResults object

get_data()

Method to return the Elmer simulation results

Parameters:

self (ElmerResults) – An ElmerResults object

Returns:

data – list of data

Return type:

list

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)

Compare two objects and return list of differences

as_dict(type_handle_ndarray=0, keep_function=False, **kwargs)

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()

Creates a deepcopy of the object

property data

Dict with simulation results

Type:

dict

property file

Filename of the results data file

Type:

str

property usecols

List integers (starting with 1) of columns to load. If usecols is not set all columns are loaded.

Type:

list

property columns

List of columns data names

Type:

list

property is_scalars

Determin if data are ‘SaveScalars’ data, else ‘SaveLine’ data are assumed

Type:

bool