OOF2: The Manual
| FieldIndex | ||
|---|---|---|
|
8.6.2. Field Iterators and Related Objects |  |
Name
FieldIndex — Base class for index objects
Synopses
C++ Synopsis
#include "engine/fieldindex.h"class FieldIndex {virtual FieldIndex* cloneIndex() const;virtual int integer() const;virtual bool in_plane() const;virtual void set(const std::vector<int>* components);virtual std::vector<int>* components() const;
}
Python Synopsis
from oof2.SWIG.engine.fieldindex import FieldIndexclass FieldIndex:def cloneIndex(self)def integer(self)def in_plane(self)def set(self, components)def components(self)
Description
FieldIndex is the abstract base class
for classes which refer to the components of
multi-dimensional Fields,
Fluxes,
and Equations.
The different subclasses refer to components of
scalars,[55]
vectors, and tensors.
Methods
Because FieldIndex objects are most
often used when wrapped within an IndexP
object, and because the IndexP
provides a similar API, this section mostly just refers to
the IndexP documentation.
virtual FieldIndex *cloneIndex() const
cloneIndex returns a pointer to a
new copy of the derived class object. The pointer must be
explicitly deallocated. See IndexP::cloneIndex.
|
|
 |
|
| IteratorP |  |
FieldIterator |