JouleHeatFraction object

The JouleHeatFraction object defines the fraction of electric energy released as heat.

The following topics are discussed:

Access

materialApi.materials()[name].jouleHeatFraction()

JouleHeatFraction(...)

This method creates a JouleHeatFraction object.

Path

materialApi.materials()[name].JouleHeatFraction

Prototype

odb_JouleHeatFraction& 
JouleHeatFraction(double fraction);

Required arguments

None.

Optional arguments

fraction

A Double specifying the fraction of electrical energy released as heat, including any unit conversion factor. The default value is 1.0.

Return value

A JouleHeatFraction object.

Exceptions

RangeError.

Members

The JouleHeatFraction object has members with the same names and descriptions as the arguments to the JouleHeatFraction method.

Corresponding analysis keywords