Histories

Histories provide data from each time step of a simulation. They can provide useful diagnostics to make sure your simulation is proceeding as intended. Some histories are only available with certain simulation setups (e.g. only available in electromagnetic simulation, or only available in simulations with particles).

To add a history, right-click the “Histories” element of the setup tree then navigate to the history to be added to the simulation

Field History

Field Histories record on a per time-step basis. Field histories are used to measure quantities such as the value or energy of the field at a location. The output will be a 1D array of the value vs time.

EM Field On Plane

ONLY AVAILABLE IN ELECTROMAGNETIC SIMULATIONS

Records E and B Field data in the plane of cells specified, typically used for computation of S Parameters using computeSParams Analyzers. The Two histories created will be historyName*_E and *historyName_B.

kind (not editable)

S Parameter

surface

The plane to use.

yz

offset
The x offset from zero, in meters.

yMin
The location of the y minimum, in meters.

yMax
The location of the y maximum, in meters.

zMin
The location of the z minimum, in meters.

zMax
The location of the z maximum, in meters.
xz

offset
The y offset from zero, in meters.

xMin
The location of the x minimum, in meters.

xMax
The location of the x maximum, in meters.

zMin
The location of the z minimum, in meters.

zMax
The location of the z maximum, in meters.
xy

offset
The z offset from zero, in meters.

xMin
The location of the x minimum, in meters.

xMax
The location of the x maximum, in meters.

yMin
The location of the y minimum, in meters.

yMax
The location of the y maximum, in meters.

Field at Indices

Record the specified field at the specified coordinates. All components of the field are recorded into an array.

kind (not editable): Field at Indices
field: Select the desired field.
coordinate 0: The indice coordinate in the 0th dimension, x in cartesian coordinates, z in cylindrical.
coordinate 1: The indice coordinate in the 1st dimension, y in cartesian coordinates, r in cylindrical.
coordinate 2: The indice coordinate in the 2nd dimension, z in cartesian coordinates.
representationRadius: The size of the sphere used to show the field at Indices history in the setup window. Does not impact the recorded history.

Poynting Flux

ONLY AVAILABLE IN ELECTROMAGNETIC SIMULATIONS

Calculates the integrated Poynting vector (energy flux) through the area defined by the min and max values.

kind (not editable)

Poynting Vector

surface

The plane to use.

yz

offset
The x offset from zero, in meters.

yMin
The location of the y minimum, in meters.

yMax
The location of the y maximum, in meters.

zMin
The location of the z minimum, in meters.

zMax
The location of the z maximum, in meters.
xz

offset
The y offset from zero, in meters.

xMin
The location of the x minimum, in meters.

xMax
The location of the x maximum, in meters.

zMin
The location of the z minimum, in meters.

zMax
The location of the z maximum, in meters.
xy

offset
The z offset from zero, in meters.

xMin
The location of the x minimum, in meters.

xMax
The location of the x maximum, in meters.

yMin
The location of the y minimum, in meters.

yMax
The location of the y maximum, in meters.

Pseudo-potential at Coordinates

Calculates the pseudo-potential difference, in Volts, between two points. The start point would correspond to the measure point, while the end point would correspond to the reference.

kind (not editable): Pseudo-potential
start coordinate 0: The coordinate of the start point in the 0th dimension.
start coordinate 1: The coordinate of the start point in the 1st dimension.
start coordinate 2: The coordinate of the start point in the 2nd dimension.
end coordinate 0: The coordinate of the end point in the 0th dimension.
end coordinate 1: The coordinate of the end point in the 1st dimension.
end coordinate 2: The coordinate of the end point in the 2nd dimension.

Array History

An Array History will output an array of data for each time-step.

Far-Field Box

ONLY AVAILABLE IN ELECTROMAGNETIC SIMULATIONS

kind (not editable)

Far-Field Box

measurement time

The way to define measurement time.

seconds defined Gives specification of time in seconds.
- start time
  The time to start recording data for far field calculations (seconds).
- end time
  The time to stop recording data for far field calculations (seconds).
timesteps defined Gives specification of time in timestep number.
- start time
  The time to start recording data for far field calculations (timesteps).
- end time
  The time to stop recording data for far field calculations (timesteps).

volume

The volume to use for the box.

cartesian 3d slab
- xMin
  The minimum x position of the box.
- xMax
  The maximum x position of the box.
- yMin
  The minimum y position of the box.
- yMax
  The maximum y position of the box.
- zMin
  The minimum z position of the box.
- zMax
  The maximum z position of the box.
index 3d slab Index 3d slab is used in cases where absolute symmetry is necessary so grid alignment must be guranteed.
- lower index 0
  The lower grid cell of the box in the 0th direction.
- lower index 1
  The lower grid cell of the box in the 1st direction.
- lower index 2
  The lower grid cell of the box in the 2nd direction.
- upper index 0
  The upper grid cell of the box in the 0th direction.
- upper index 1
  The upper grid cell of the box in the 1st direction.
- upper index 2
  The upper grid cell of the box in the 2nd direction.

Field Slab

Store the value of a field at every timestep within a specified 3D volume.

kind (not editable)

Field Slab

description

A comment to describe the history.

field

Choose the field to record. Options for electromagnetic simulations are:

Electric Field
Magnetic Field

Options for electromagnetic simulations are:

Phi
Charge Density
Electric Field

volume

The volume inside of which to collect the field data.

cartesian 3d slab
- xMin
  The minimum x position of the box.
- xMax
  The maximum x position of the box.
- yMin
  The minimum y position of the box.
- yMax
  The maximum y position of the box.
- zMin
  The minimum z position of the box.
- zMax
  The maximum z position of the box.