OOF2: The Manual

ScalarFieldIterator
Prev  8.6.2. Field Iterators and Related Objects  Next

Name

ScalarFieldIterator — “Iterate” over the components of a scalar field

Synopses

C++ Synopses


#include "engine/fieldindex.h"
    

class ScalarFieldIterator: public ScalarFieldIndex, virtual public FieldIterator {
}

  

Python Synopsis


from oof2.SWIG.engine.fieldindex import ScalarFieldIterator
    

class ScalarFieldIterator(ScalarFieldIndex, 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

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.

Prev  Up  Next
OutOfPlaneSymTensorIndex  Home  VectorFieldIterator

/* OOF home */ /* OOF2 home */ /* Send mail to the OOF Team */