OOF2: The Manual
| OutOfPlaneVectorFieldIndex | ||
|---|---|---|
|
Indices and Iterators |  |
Name
OutOfPlaneVectorFieldIndex — Index the out-of-plane components of a vector
Synopses
C++ Synopsis
#include "engine/fieldindex.h"
class OutOfPlaneVectorFieldIndex: , public VectorFieldIndex {void ();int i(int i);
}
Python Synopsis
from ooflib.SWIG.engine.fieldindex import OutOfPlaneVectorFieldIndex
class OutOfPlaneVectorFieldIndex(VectorFieldIndex):
pass
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 will
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. Most of the
time FieldIndex objects are created by the
Fields themselves
e.g, via their Field::components()
methods, which automatically return the correct type of
FieldIndex.
See FieldIndex for more.
|
|
 |
|
| VectorFieldIndex |  |
SymTensorIndex |