OOF2: The Manual


ScalarFieldIterator — Iterate over the components of a scalar field


C++ Synopses

#include "engine/fieldindex.h"

class ScalarFieldIterator: , public ScalarFieldIndexvirtual public FieldIterator {


Python Synopsis

from oof2.SWIG.engine.fieldindex import ScalarFieldIterator

class ScalarFieldIterator(ScalarFieldIndexFieldIterator):


Source Files

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


This class is needed so that scalar Fields can be treated like other sorts of Fields. Multidimensional Fields have iterators that loop over their components, so scalar Fields do as well.

All of the ScalarFieldIterator functions are described in the documentation for its base classes, FieldIndex and FieldIterator.