OOF2: The Manual

OutOfPlaneVectorFieldIterator
	8.6.2. Field Iterators and Related Objects

Name

OutOfPlaneVectorFieldIterator — Loop over the out-of-plane components of a vector Field

Synopses

C++ Synopsis

#include "engine/fieldindex.h"
	    class OutOfPlaneVectorFieldIterator: , public OutOfPlaneVectorFieldIndex, public FieldIterator {
}

Python Synopsis

from oof2.SWIG.engine.fieldindex import OutOfPlaneVectorFieldIterator
	    class OutOfPlaneVectorFieldIterator(OutOfPlaneVectorFieldIndex, FieldIterator):
   pass

Source Files

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

Description

The OutOfPlaneVectorFieldIterator is a FieldIterator that loops over the out-of-plane components of a vector Field. It's usually wrapped in an IteratorP object. OutOfPlaneVectorFieldIterator adds no functions to the base class FieldIterator or the wrapper API IteratorP classes.

See OutOfPlaneVectorFieldIndex for some important comments.


VectorFieldIterator		SymTensorIterator