export_summary

Icepak.export_summary(output_dir: str | None = None, solution_name: str | None = None, type: str | None = 'Object', geometry_type: str | None = 'Volume', quantity: str | None = 'Temperature', variation: str | None = '', variation_list: list | None = None, filename: str | None = 'IPKsummaryReport') → bool

Export a fields summary of all objects.

Parameters:

output_dirstr, optional

Name of directory for exporting the fields summary. The default is None, in which case the fields summary is exported to the working directory.

solution_namestr, optional

Name of the solution. The default is None, in which case the default solution is used.

typestr, optional

Entity type, "Boundary" or "Object". The default is "Object".

geometry_typestr, optional

Geometry type, "Volume" or "Surface". The default is "Volume".

quantitystr, optional

The default is "Temperature".

variationstr, optional

The default is "".

variation_listlist, optional

The default is None.

filenamestr, optional

The default is "IPKsummaryReport".

Returns:

bool

True when successful, False when failed.

References

>>> oModule.EditFieldsSummarySetting
>>> oModule.ExportFieldsSummary