histories.mac

This macro file can be imported to an input file with

$ import histories

It is imported by VSim.mac.

This macro file is available to all packages.

This macro file provides macros for all vorpal histories supported in this release. Histories pertain primarily to fields and particles.

Public Macros

addParticleMomentumHistory(name, speciesName)

Add particle history block that records the momentum of a particle species.

Parameters:

  • name – The name of the history block.

  • speciesName – The name of the species to be recorded.

addParticleAbsorberLog(name, absorberName, ptclQty, component)

Add particle history block that records a specific quantity about particles absorbed by the given absorber.

Parameters:

  • name – The name of the history block.

  • absorberName – The name of the particle absorber at which to record.

  • ptclQty – The quantity to be recorded. Particle quantities include time, position, velocity, weight, energy, and current.

  • component – The component of the particle quantity to record. Only position, velocity, and weight require a component.

addParticleAbsorberCurrentHistory(name, absorberName)

Add particle history block that records the current located at a particle absorber.

Parameters:

  • name – The name of the history block.

  • absorberName – The name of the particle absorber at which to record.

addParticleAbsorberEnergyHistory(name, absorberName)

Add particle history block that records the energy of particles located at a particle absorber.

Parameters:

  • name – The name of the history block.

  • absorberName – The name of the particle absorber at which to record.

addParticleEmitterCurrentHistory(name, emitterName)

Add particle history block that records the current located at a particle emitter.

Parameters:

  • name – The name of the history block.

  • emitterName – The name of the particle emitter at which to record.

addMacroParticleCountHistory(name, speciesName)

Add particle history block that records the number of macro particles in a simulation.

:param name The name of the history block.

:param speciesName The name of the species to be recorded.

addPhysicalParticleCountHistory(name, speciesName)

Add particle history block that records the number of physical particles in a simulation.

:param name The name of the history block.

:param speciesName The name of the species to be recorded.

addParticleEnergyHistory(name, speciesName)

Add particle history block that records energy of a particle species.

Parameters:

  • name – The name of the history block.

  • speciesName – The name of the species to be recorded.

addEMFieldEnergyHistory(name, region)

Add field history block that records energy of the EM field. Can specify the entire simulation region or the region inside a user defined shape.

Parameters:

  • name – The name of the history block.

  • region – A string representing the region in which to record. Can either be the entire simulation domain or a regiondefined by an imported geometry or created through CSG.

addEMFieldEnergyHistory(name, lb, ub)

Add field history block that records energy of the EM field. Can specify any region in the simulation domain.

param name:

The name of the history block.

param lb:

An integer three-vector. The lower bounds on which to record in grid indices.

param ub:

An integer three-vector. The upper bounds on which to record in grid indices.

addFieldEnergyAtPositionHistory(name, location, field)

Add field history block that records energy of the specified field. Records field energy at specific point in the simulation domain.

Parameters:

  • name – The name of the history block.

  • location – A real valued three-vector. The point at which to record.

  • field – The field which to record.

addElectricFieldEnergyHistory(name, simRgn)

Add field history block that records energy of the electric field inside the whole simulation domain.

Parameters:

  • name – The name of the history block.

  • simRgn – A string representing the entire simulation region.

addElectricFieldEnergyHistory(name, lb, ub)

Add field history block that records energy of the electric field. Can specify any region in the simulation domain.

param name:

The name of the history block.

param lb:

An integer three-vector. The lower bounds on which to record in grid indices.

param ub:

An integer three-vector. The upper bounds on which to record in grid indices.

addMagneticFieldEnergyHistory(name, simRgn)

Add field history block that records energy of the magnetic field inside the whole simulation domain.

Parameters:

  • name – The name of the history block.

  • simRgn – A string representing the entire simulation region.

addMagneticFieldEnergyHistory(name, lb, ub)

Add field history block that records energy of the magnetic field. Can specify any region in the simulation domain.

param name:

The name of the history block.

param lb:

An integer three-vector. The lower bounds on which to record, in grid indices.

param ub:

An integer three-vector. The upper bounds on which to record, in grid indices.

addPseudoPotentialHistory(name, refPoint, measPoint)

Add history block that calculates the pseudo-potential difference, in volts, between the reference point and the measure point. See the pseudoPotential documentation for details.

Parameters:

  • name – The name of the history block.

  • refPoint – An integer three-vector. The grid indices of the reference point.

  • measPoint – An integer three-vector. The grid indices of the measurement point.

addBinaryCombinationHistory(name, coeff1, coeff2, op, history1, history2)

Add history block that performs an element-wise binary operation on two other histories.

Parameters:

  • name – The name of the history block.

  • coeff1 – A real valued coefficient for history1.

  • coeff2 – A real valued coefficient for history2.

  • op – The operation to perform on the two histories.

  • history1 – The name of the first history.

  • history2 – The name of the second history.

addPoyntingHistory(name, lb, ub)

Add history block that records the poynting flux on some plane within the simulation domain.

Parameters:

  • name – The name of the history block.

  • lb – A real valued three-vector. The lower bounds on which to record, in coordinates.

  • coeff2 – A real valued three-vector. The upper bounds on which to record, in coordinates.

addFarFieldHistory(name, timeDelay, duration, numTimePts, kirchRad, numPolarAng, numAzimAng, numLinInts, comp, kirchCenter, field)

Add history block that records the far field radiation pattern of an EM source.

Parameters:

  • name – The name of the history block.

  • timeDelay – The simulation time at which to begin recording.

  • duration – The length of time during which the history records.

  • numTimePts – The number of sampling points on the time interval.

  • kirchRad – The radius of the Kirchhoff sphere.

  • numPolarAng – The number of polar angles represented on the Kirchhoff sphere.

  • numAzimAng – The number of azimuthal angles represented on the Kirchhoff sphere.

  • numLinInts – The number of integration segments around the Kirchhoff sphere.

  • kirchCenter – The center of the Kirchhoff sphere.

addFarFieldBoxHistory(name, startTime, endTime, lc, uc)

This history macro adds a set of histories that save fields on a 2-cell thick box, for use in the Kirchhoff Box Far Field post-processing.

Parameters:

  • name – The name of the history block.

  • startTime – The simulation time at which the history begins recording.

  • endTime – The simulation time at which the history stops recording.

  • lc – The lower coordinates of the box (or slab).

  • uc – The upper coordinates of the box (or slab).