OOF2: The Manual

SymmetricTensorFlux
	Flux Classes and Functions

Name

SymmetricTensorFlux — A 3×3 symmetric tensor valued Flux

Synopses

C++ Synopsis

#include "engine/flux.h"

class SymmetricTensorFlux: , public Flux {
  virtual FieldIndex* getIndex(const std::string& name) const;
}

Python Synopsis

from ooflib.SWIG.engine.flux import SymmetricTensorFlux

class SymmetricTensorFlux(Flux):
  def __init__(self, name)
  def getIndex(self, name)

Source Files

SRC/engine/flux.h: C++ headers
SRC/engine/flux.C: C++ source code
SRC/engine/flux.swg: SWIG source code
SRC/engine/flux.spy: python code included in flux.swg

Description

SymmetricTensorFlux is a Flux whose value is a 3×3 symmetric tensor, such as stress. Like all Fluxes, it should only be constructed in Python. See Section 8.3.

The FieldIndex class for SymmetricTensorFlux is SymTensorIndex. The Components class is SymTensorComponents, and the ComponentIterator is SymTensorIterator.

For out-of-plane components, as returned by Flux::components(OUT_OF_PLANE), the FieldIndex class is SymTensorIndex, the Components class is SymTensorOutOfPlaneComponents, and the ComponentIterator is SymTensorOutOfPlaneIterator.

For out-of-plane components, as returned by Flux::outOfPlaneComponents(), the FieldIndex class is OutOfPlaneSymTensorIndex, the Components class is OutOfPlaneSymTensorComponents, and the iterator is OutOfPlaneSymTensorIterator.

Methods

Most of the SymmetricTensorFlux methods are inherited from and documented in its base class, Flux.

`FieldIndex *getIndex(const std::string &name) const`

SymmetricTensorFlux::getIndex returns a pointer to a SymTensorIndex. The name argument is a two letter string: "xx", "xy", "yz", etc.


VectorFlux		getFlux