fieldArray

fieldArray

Stores field values in a sub-array of the field.

Histories of kind=fieldArray are tensor histories that store values in a sub-array of a <Field>. For example, one might want to store the values of the electric field E in the \(5\times 6 \times 4\) sub-array from lowerBounds=[2 2 2] to upperBounds=[7 8 6]. In this case if one specifies components = [0 1 2] the resulting history will be a 1D array of \(5 \times 6 \times 4 \times 3\) arrays, or a dataset of dimension \(n \times 5 \times 6 \times 4 \times 3\).

(See fieldAtIndices, which is similar, but stores field values for one cell only.)

fieldArray Parameters

field (string, required)

The name of the <Field> for which to record values (the field name may need to be qualified: e.g., myEmField.yeeE instead of just yeeE).

lowerBounds (vectors of integers, required)

The lower bounds of the field values.

upperBounds (vectors of integers, required)

The upper bounds of the field values. As usual in Vorpal, the range is exclusive of the upper bound.

components (vector of integers, required)

The components of the field to be recorded; e.g., components = [0 1 2] to record all components of a 3-vector field, or components = [0] to store just the x-component.

fieldArray History Example

<History E1>
 kind = fieldArray
 field = emField.elecField
 components = [0 1 2]
 lowerBounds = [$NX/2$ $NY/2$ $NZ/2$]
 upperBounds = [$NX/2+1$ $NY/2+1$ $NZ/2+1$]
</History>