speciesTrackTag

speciesTrackTag

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.

Indicates Vorpal should track the trajectory (position) or the internal variables of a subset of species particles. The species tracked must be a tagged species where each particle has a unique integer tag assigned to it. If there is no particle associated with a tag or the particle with a particular tag is removed from the simulation then the position is reported as all zeros.

speciesTrackTag Parameters

species (string vector, required)

Indicates particle species type for a History kind that reports data for particle species. This species should be a tagged kind, for example, kind = relBorisTagged.

tags (integer vector)

List of tags of particles that will be tracked.

maximumTag (integer)

Any particle with a tag smaller than the maximumTag will be tracked.

The user must specify either tags or maximumTag.

getTagsFromSpecies (bool)

If true then tags will be generated from initial distribution of particles.

getTagsFromAbsorber (bool)

If true then tags will be generated when particles interact with a specific particle sink.

tagsFromFile (string)

If this is set the tags will be taken from a text with the given name. The format of the file is just one column of numbers which are the tags to be tracked.

xComponents (integer vector)

Indicates which position components to track.

iComponents (integer vector)

Indicates which internal variables (velocities, weights, etc) to track.

speciesTrackTag Particle Species History Example

<History trajectory>
    kind = speciesTrackTag
    # List of tags to be tracked
    tags = [0 1 2 3]
    # Or give a maximum tag to be tracked. Any particle
    # with a tag less than the maximum tag will be tracked.
    # maximumTag = 4
    species = [electrons]
</History>