Simulation (class)

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

class Simulation(name='', desc='', machine=-1, input=-1, logger_name='Pyleecan.Simulation', var_simu=None, postproc_list=-1, index=None, path_result=None, init_dict=None, init_str=None)[source]

Bases: pyleecan.Classes._frozen.FrozenClass

Abstract class for the simulation

VERSION = 1
run()

Run the simulation and optionnaly its multisimulation

Returns

output – Contains simulation results

Return type

Output

save(save_path='', is_folder=False)

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

copy()

Return a copy of the class

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 object in a json seriable dict (can be use in __init__)

property name

Name of the simulation

Type

str

property desc

Simulation description

Type

str

property machine

Machine to simulate

Type

Machine

property input

Input of the simulation

Type

Input

property logger_name

Name of the logger to use

Type

str

property var_simu

Multi-simulation definition

Type

VarSimu

property postproc_list

List of postprocessings to run on Output after the simulation

Type

[Post]

property index

Index of the simulation (if part of a multi-simulation)

Type

int

Min

0

property path_result

Path to the Result folder to use (None to use default one)

Type

str