OOF2: The Manual

VectorFieldIndex
	Indices and Iterators

Name

VectorFieldIndex — Index a vector field

Synopses

C++ Synopsis

#include "engine/fieldindex.h"

class VectorFieldIndex: , public FieldIndex {
  VectoFieldIndex();
  VectoFieldIndex(int i);
}

Python Synopsis

from ooflib.SWIG.engine.fieldindex import VectorFieldIndex

class VectorFieldIndex(FieldIndex):
  def __init__(self, i)

Subclasses

OutOfPlaneVectorFieldIndex

Source Files

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

Description

VectorFieldIndex is used to refer to the components of a vector-valued Field, Flux, or Equation. It is often used within an IndexP wrapper. See the FieldIndex documentation for details on the available methods.

Constructors

`VectorFieldIndex()`

The new VectorFieldIndex points to the first entry in the vector. (C++ only.)

`VectorFieldIndex(int i)`

The new VectorFieldIndex points to the i^th entry in the vector.


ScalarFieldIndex		OutOfPlaneVectorFieldIndex