evaluate_boundary_quantity#
- PostProcessorIcepak.evaluate_boundary_quantity(boundary, quantity, side='Default', volume=False, setup_name=None, variations=None, ref_temperature='', time='0s')#
Export the field output on a boundary.
- Parameters:
- boundary
str
Name of boundary to perform the computation on.
- quantity
str
Name of the quantity to export.
- side
str
,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
, in which case the quantity will be evaluated only on the surface .- setup_name
str
,optional
Name of the setup and name of the sweep. For example,
"IcepakSetup1 : SteatyState"
. The default isNone
, in which case the active setup and active sweep are used.- variations
dict
,optional
Dictionary of parameters defined for the specific setup with values. The default is
{}
.- ref_temperature
str
,optional
Reference temperature to use for heat transfer coefficient computation. The default is
""
.- time
str
,optional
Timestep to get the data from. Default is
"0s"
.
- boundary
- 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