- nodeFieldVectorWriter
nodeFieldVectorWriter¶
Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.
Fill vector entries from values in a single Field, taking into account the geometry specified by a GridBoundary.
nodeFieldVectorWriter Parameters¶
- minDim (integer, required)
If NDIM < minDim, the writer will not be used to fill the vector.
- component (integer, required if componentBounds not specified)
If a single-component fill, the component over which this writer operates. The number of components is set by the updater, and valid component indices are in the range [0, numberUpdaterComponents).
- componentBounds (integer vector, required if component not specified)
The component range over which this writer operates. The number of components is set by the updater, and valid component indices are in the range [0, numberUpdaterComponents).
- readFields (string, required)
The names of the fields whose values will be written to the vector. If multiple fields are given, only the first is used.
- readComponent (integer, required if readComponentBounds not specified)
The component index of the field being read.
- readComponentBounds (integer vector, required if readComponent not specified)
The range of component indices of the field being read.
- gridBoundary (string, required)
Name of the GridBoundary specifying the geometry.
- interiorosity (string vector, required)
Which node locations are valid for writing vector entries. Options are any combination of
insideBoundary
,cutByBoundary
, andoutsideBoundary
.
- scaling (real, default = 1.0)
A factor for scaling all field values that are written to the vector.