pyleecan.Classes.SolutionMat module¶
Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Mesh/SolutionMat
- class SolutionMat(field=None, indice=None, axis_name=None, axis_size=None, type_cell='triangle', label=None, dimension=2, unit='', init_dict=None, init_str=None)[source]¶
Bases:
Solution
Define a Solution with ndarray object.
- VERSION = 1¶
- get_field(*args, is_squeeze=False, node=None, is_rthetaz=False)¶
Get the value of variables stored in Solution.
- Parameters:
self (Solution) – an Solution object
*args (list of strings) – List of axes requested by the user, their units and values (optional)
is_squeeze (boolean) – To numpy.squeeze the output ndarray
- Returns:
field_new – an ndarray of field values sliced according to args.
- Return type:
ndarray
- get_axes_list(*args)¶
Get the value of variables stored in Solution.
- Parameters:
self (SolutionMat) – an SolutionMat object
- Returns:
axis_dict – a list of axis names containing axis sizes
- Return type:
list
- get_solution(indice=None)¶
Return a copy of the solution with the option to only include specified indices.
- Parameters:
self (SolutionMat) – a SolutionMat object
indices (list) – list of indices, if list is empty or None all indices are included
- Returns:
solution – solution
- Return type:
- 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.
- property field¶
Matrix/Vector of the numerical values of the solutions.
- Type:
ndarray
- property indice¶
Indices of loaded cells. Set to None if all cells are loaded
- Type:
ndarray
- property axis_name¶
List of axis names (e.g. “time”, “direction”)
- Type:
list
- property axis_size¶
List of axis sizes
- Type:
list