VarParam (class)¶
Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Simulation/VarParam
-
class
VarParam
(paramexplorer_list=-1, name='', desc='', datakeeper_list=-1, is_keep_all_output=False, stop_if_error=False, ref_simu_index=None, nb_simu=0, is_reuse_femm_file=True, postproc_list=-1, pre_keeper_postproc_list=None, post_keeper_postproc_list=None, init_dict=None, init_str=None)[source]¶ Bases:
pyleecan.Classes.VarSimu.VarSimu
Handle multisimulation by varying parameters
-
VERSION
= 1¶
-
check_param
()¶ Check VarParam parameters validity
- Raises
ParamExplorerError – Error in ParamExplorer setting:
VarParamError – Error in VarParam general setting:
DataKeeperError – Error in DataKeeper setting:
-
get_simulations
()¶ Create simulations and returns them
- Returns
multisim_dict – dictionary containing simulation shape, setters, parameter values and simulations generated
- Return type
dict
-
get_simu_number
()¶ Return the number of simulation defined by the Param Explorer
- Parameters
self (VarParam) – A VarParam object
- Returns
nb_simu – number of simulation
- Return type
int
-
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
-
property
paramexplorer_list
¶ List containing ParamSetter to define every simulation
- Type
[ParamExplorer]
-