OOF2: The Manual

ScalarFieldIndex
	Indices and Iterators

Name

ScalarFieldIndex — Index object for a scalar Field

Synopses

C++ Synopsis

#include "engine/fieldindex.h"

class ScalarFieldIndex: , public FieldIndex {
  void ();
}

Python Synopsis

from ooflib.SWIG.engine.fieldindex import ScalarFieldIndex

class ScalarFieldIndex(FieldIndex):
  def __init__(self)

Source Files

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

Description

For OOF2's component addressing mechanism to be generic, all subclasses of Field must have an associated FieldIndex type. ScalarFieldIndex is the FieldIndex for ScalarField. It is a trivial class — it stores no data and most of its methods are no-ops — since scalar fields have only one component. Specifically,

ScalarFieldIndex::integer() always returns 0.
ScalarFieldIndex::in_plane() always returns true.


IndexP		VectorFieldIndex