fieldAverage

fieldAverage

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

Indicates Vorpal should calculate the average of a field over a specified region. Specify the region with the upperBounds and lowerBounds parameters, or a Slab.

fieldAverage Parameters

field (string, required)

Indicates the field for a History kind that reports data for a single field.

components (integer vector, optional)

Specify the average value of which components of the field are recorded. If not specified, all available components of the field are written out.

region (slab object, required)

A slab region defined by lowerBounds/upperBounds.

fieldAverage History Example

<History fieldAverage>
    kind =  fieldAverage
    field = myField.testField
    components = [0 1 2]
    <Slab region>
        lowerBounds = [4 4 4]
        upperBounds = [7 7 7]
    </Slab>
</History>