OOF2: The Manual


OutOfPlaneVectorFieldIndex — Index the out-of-plane components of a vector


C++ Synopsis

#include "engine/fieldindex.h"
class OutOfPlaneVectorFieldIndex: , public VectorFieldIndex {

Python Synopsis

from oof2.SWIG.engine.fieldindex import OutOfPlaneVectorFieldIndex
class OutOfPlaneVectorFieldIndex(VectorFieldIndex):

Source Files

  • SRC/engine/fieldindex.h: C++ header
  • SRC/engine/fieldindex.C: C++ source code
  • SRC/engine/fieldindex.swg: SWIG source code


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, \(\partial u_z/\partial z\), 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.