calculate electric_current command

Purpose

This command calculates the electric current on a mesh.

Warning

GPU support for this command has not been tested and may not work as expected.

Syntax

calculate electric_current keyword keyword/value pairs

Keywords	Description
id	user-assigned name for the calculate electric_current command
probes	obligatory, brace-enclosed list of mesh ids available options: {mesh1,mesh2, ...}

Examples

calculate electric_current id Amperemeter probes {lower_battery, upper_battery}

Access the calculated values above via:

id_Amperemeter.lower_battery or id_Amperemeter[1]
id_Amperemeter.upper_battery or id_Amperemeter[2]

Description

This command evaluates the total (summed) electric current in a solid body represented by a mesh. A negative current indicates that the net current is leaving the mesh, whereas a positive current is obtained when the net current is entering the mesh. Thus, this command emulates the behavior of an Ammeter device. It should be used together with the enable_electrical_conductivity command.

Output information

Two different options are available for getting the output of this command: see the example above. The output of this command is automatically written to the file simulation_data_aspherix.csv.

Related commands

The current on a mesh can also be obtained using the Aspherix dot access functionality directly from the mesh id. For example, for a mesh with id upper_battery, the current can be obtained by id_upper_battery.current.

See also: calculate voltage, calculate electric_resistance, enable_electrical_conductivity

Output commands: output_settings, status_style, write_to_file