add_calculation

FieldSummary.add_calculation(entity, geometry, geometry_name, quantity, normal='', side='Default', mesh='All', ref_temperature='AmbientTemp', time='0s')

Add an entry in the field summary calculation requests.

Parameters:

entitystr

Type of entity to perform the calculation on. Options are

"Boundary", "Monitor”, and "Object". ("Monitor" is available in AEDT 2024 R1 and later.)

geometrystr

Location to perform the calculation on. Options are "Surface" and "Volume".

geometry_namestr or list of str

Objects to perform the calculation on. If a list is provided, the calculation is performed on the combination of those objects.

quantitystr

Quantity to compute.

normallist of floats

Coordinate values for direction relative to normal. The default is "", in which case the normal to the face is used.

sidestr, optional

String containing which side of the face to use. The default is "Default". Options are "Adjacent", "Combined", and “Default”`.

meshstr, optional

Surface meshes to use. The default is "All". Options are "All" and "Reduced".

ref_temperaturestr, optional

Reference temperature to use in the calculation of the heat transfer coefficient. The default is "AmbientTemp".

timestr, optional

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

Returns:

bool

True when successful, False when failed.