Currdump

This object allows the user to collect all of the currents in the system into one CSV file at a given run time. In all cases, this is the current flowing INTO the link object (as defined by the to/from convention). Currents are placed in the CSV output file with format:

link_name,	currA_real,	currA_imag,	currB_real,	currB_imag,	currC_real,	currC_imag,
In rectangular
link_1	10	0	-5	-8.66	-5	8.66
Or in polar (radians)
link_2	20	0	20	-2.0944	20	2.0944

Currdump Parameters

Properties

currdump does not declare inherited parent classes.

The I/O column indicates whether a property is user-settable input (I), simulation-computed output (O), or both (IO).

Table 1: current_dump table 1

Property Name	Type	Unit	I/O	Description
group	char32	N/A	I	Using the group_id feature, this allows only nodes with the matching group_id to be dumped into the output file.
runtime	timestamp	N/A	IO	Tells the object at what time to output the currents of the system. Can be in either seconds from epoch (Unix time) or with a timestamp ('2006-01-01 00:00:00'). If not specified, the default is immediately after the first time step solution.
filename	char256	N/A	I	Tells the object what file to print all information to. While a CSV extension is not necessary, it is recommended as the formatted output is CSV.
runcount	int32	N/A	—	The number of times the file has been written to
mode	enumeration	N/A	I	Allows the user to choose between polar and rectangular coordinates when printing output. Valid choices are - rect rectangular coordinates (default) - polar polar coordinates (in radians) Valid values: RECT, POLAR.

Default Current Dump

The minimal amount of code to specify a currdump object is

object currdump {
       filename output_current.csv;
       }

which will produce an output file of the given name in the format shown above, and will display the current of every link object in the glm file.

Current Dump State of Development

Current Dump is considered a well developed, but unvalidated model. Additional features may be included as needed.