OOF2: The Manual
| SymTensorOutOfPlaneIterator | ||
|---|---|---|
|
8.6.2. Field Iterators and Related Objects |  |
Name
SymTensorOutOfPlaneIterator — Iterate over the out-of-plane components of a symmetric 3×3 tensor
Synopses
C++ Synopsis
#include "engine/fieldindex.h"class SymTensorOutOfPlaneIterator: , public SymTensorIterator {
}
Python Synopsis
from oof2.SWIG.engine.fieldindex import SymTensorOutOfPlaneIterator
class SymTensorOutOfPlaneIterator(SymTensorIterator):
pass
Description
SymTensorOutOfPlaneIterator is a SymTensorIterator
that restricts itself to the out-of-plane components of a
3×3 symmetric tensor. It returns the indices in Voigt order: zz, yz, xz.
Because SymTensorOutOfPlaneIterator
is derived from SymTensorIterator,
the integer
function returns the integers assigned to the indices when
they're part of a full iteration,
i.e, zz=2, yz=3, and xz=4.
To get integers starting from 0 (as is necessary when
indexing the components of a plane flux equation, for
example), use OutOfPlaneSymTensorIterator
instead.
|
|
 |
|
| SymTensorInPlaneIterator |  |
OutOfPlaneSymTensorIterator |