OOF2: The Manual

Planarity
	8.6.2. Field Iterators and Related Objects

Name

Planarity — Specify the range of component iterators

Synopsis

C++ Synopsis

#include "engine/planarity.h"

enum Planarity {IN_PLANE, OUT_OF_PLANE, ALL_INDICES};

Python Synopsis

from oof2.SWIG.engine import planarity

planarity.IN_PLANE
planarity.OUT_OF_PLANE
planarity.ALL_INDICES

Source Files

SRC/engine/planarity.h
SRC/engine/planarity.swg

Description

The enumerated Planarity type is used when specifying the range of an iterator that is looping over the indices of a Field, Flux, or Equation. It indicates whether the loop should cover the in-plane or out-of-plane components, or both.


OutOfPlaneSymTensorIterator		Property