fieldOnMovingPlane

fieldOnMovingPlane

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

Indicates Vorpal should perform the diagnostic activity of tracking any grid fields (electric magnetic or charge plus current) along a line (2D) or plane (3D) of cells that is perpendicular to one of the Cartesian axes and that can be moving along this axis. The fieldOnMovingPlane diagnostic dumps the global grid cells defining the line in the simulation domain. In 2D, fieldOnMovingPlane dumps X and Y. In 3D, fieldOnMovingPlane dumps X, Y, and Z. In addition, fieldOnMovingPlane dumps the initial position and speed of the plane. You can use fieldOnMovingPlane for simulations only 2D or higher.

fieldOnMovingPlane Parameters

fields (string vector, required)

Indicates the fields for a History kind that reports data. User can specify multiple fields, but must specify at least one field. If multiple fields are specified, the values of each component of all these fields are recorded.

numComponents (integer, default value = 1)

Sets how many number of components of each field to record. By default, only the first component is recorded.

direction (integer, optional, default value = 0)

Direction in which the plane (or line) is moving. 0: x, 1: y, 2: z.

initialLoc (float, required)

Location, on the direction axis, of the plane (or line) at t=0.

speed (float, required)

Velocity of the plane (or line), in m/s, along the direction axis.

cutDir (integer, default value = 0.0)

Axis perpendicular to the line.

cutVal (float, optional, default value = 0.0)

Location of line along axis perpendicular to the line.

fieldOnMovingPlane History Example

# Specify history diagnostics
<History fieldAtMovingPlaneWaist>
    kind = fieldOnMovingPlane
    fields = [myField.elecField myField.magField]
    direction = 0
    initialLoc = HISTORY_LOC
    speed = $ -1. * VX_BOOST $
    numComponents = 3
</History>