export_summary#
- Icepak.export_summary(output_dir=None, solution_name=None, type='Object', geometry_type='Volume', quantity='Temperature', variation='', variation_list=None, filename='IPKsummaryReport')[source]#
Export a fields summary of all objects.
- Parameters:
- output_dir
str
,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_name
str
,optional
Name of the solution. The default is
None
, in which case the default solution is used.- type
str
,optional
Entity type,
"Boundary"
or"Object"
. The default is"Object"
.- geometry_type
str
,optional
Geometry type,
"Volume"
or"Surface"
. The default is"Volume"
.- quantity
str
,optional
The default is
"Temperature"
.- variation
str
,optional
The default is
""
.- variation_list
list
,optional
The default is
None
.- filename
str
,optional
The default is
"IPKsummaryReport"
.
- output_dir
- Returns:
- bool
True
when successful,False
when failed.
References
>>> oModule.EditFieldsSummarySetting >>> oModule.ExportFieldsSummary