evaluate_object_quantity#

PostProcessorIcepak.evaluate_object_quantity(object_name, quantity_name, side='Default', volume=False, setup_name=None, variations=None, ref_temperature='', time='0s')#

Export the field output on or in an object.

Parameters:
object_namestr

Name of object to perform the computation on.

quantity_namestr

Name of the quantity to export.

sidestr, optional

Side of the mesh face to use. The default is "Default". Options are "Adjacent", "Combined", and "Default".

volumebool, optional

Whether to compute the quantity on the volume or on the surface. The default is False.

setup_namestr, optional

Name of the setup and name of the sweep. For example, "IcepakSetup1 : SteatyState". The default is None, in which case the active setup and active sweep are used.

variationsdict, optional

Dictionary of parameters defined for the specific setup with values. The default is {}.

ref_temperaturestr, optional

Reference temperature to use for heat transfer coefficient computation. The default is "".

timestr, optional

Timestep to get the data from. Default is "0s".

Returns:
dict

Output dictionary, which depending on the quantity chosen, contains one of these sets of keys:

  • "Min", "Max", "Mean", "Stdev", and "Unit"

  • "Total" and "Unit"

References

>>> oModule.ExportFieldsSummary