contact.energy.sum

Syntax

f = contact.energy.sum(s1<,s2>)

Get the current value of an energy partition accumulated over contacts. The first, mandatory argument s1 refers to the name of an energy partition. If no such energy partition exists, then a zero value is returned. If the optional argument s2 is not provided, then the summation occurs on all mechanical contacts. Otherwise, s2 must correspond to a process name (e.g., mechanical) or a contact type name (e.g., ball-ball), and the summation will be restricted on the contact of the desired process or type, respectively.

Some energy partitions, such as the energy (work) dissipated during slip events, are accumulated over time at each contact throughout the existence of that contact. If the contact is deleted, its contribution is stored and added to the returned value.

Available contact energies are energy-adhesive, energy-dashpot, energy-pbstrain, energy-rrstrain, energy-rrslip, energy-slip, and energy-strain. These are defined in the “Contacts and Contact Models” section.

By default, energies are not accumulated. See the “Energy Tracking” topic for further details.

Returns:

f - energy value

Arguments:

s1 - energy name

s2 - optional process name or contact type name