AbsSaveDump

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

This particle sink creates a region similar to absAndSav, however the particles’ data are also written to a file. The absSaveDump is useful for writing all the particle data into an array. However, if you really want to output the values of a single coordinate (i.e. the x position, or the y-momentum) of the particles that cross into a particle sink, you can use the History feature instead.

The absSaveDump particle sink has the additional feature that those particles are saved to a file. The saved output file can then be used outside of VSim as input to another program. Originally absSaveDump was used to make a file record of particles crossing a surface, so that those particles could be used as input for a particle mapping program.

The saved particle information is, with one exception, in the standard VSim particle dump format: position (or displacement), followed by momentum then other variables such as the weight. The exception is that the displacement in the direction perpendicular to the sink surface is instead given as the time at which the particle crossed into the sink region, for example: (t, x2, x3, p1, p2, p3, weight). All values are given as differences relative to the first dumped particle, which acts as a reference particle.

Note

As in the case of the absAndSav particle sink, you can specify whether particles are actually absorbed or just dumped by setting removePtclFlag = 0 in the input file.

<ParticleSink  redElecSwSwitchAbsorber>
    kind = absSaveDump minDim = 1
    # base name of dump files
    fluxSpeciesDumpName = redElectronsFlux
    # Whether to use global Vorpal dump index
    independentDumpIndicing = 1
    # Set whether particles should be removed (absorbed)
    # after being recorded
    #doNotRemoveParticlesFlag = 1
    # Bounds specified
    lowerBounds = [20 0 0] upperBounds = [21 20 20]
</ParticleSink>