OOF2: The Manual
Name
OutOfPlaneVectorFieldIndex — Index the out-of-plane components of a vector
Synopses
C++ Synopsis
#include "engine/fieldindex.h"class OutOfPlaneVectorFieldIndex: , public VectorFieldIndex {
}
Description
The OutOfPlaneVectorFieldIndex
is a
FieldIndex
that only refers to the out-of-plane components of a
vector-valued Field
.
The z component of a vector is
component 0 when converted to an integer by
OutOfPlaneVectorFieldIndex::integer
.
There is some potential for confusion here. The TwoVectorField
used in OOF2 has only in-plane components, so an
OutOfPlaneVectorFieldIndex
willl
never be used to refer to its components. But
TwoVectorField
is also a CompoundField
,
so it has an associated out-of-plane
part, which is a 3-vector of derivatives.
This vector has a z component,
, which can be referred to by an
OutOfPlaneVectorFieldIndex
.
Following these subtleties isn't really important, though,
because most of the time FieldIndex
objects are created by the Fields
themselves (e.g, with Field::iterator
,
which automatically does the right thing.