OOF2: The Manual

VectorFlux
	Flux Classes and Functions

Name

VectorFlux — A vector-valued Flux

Synopses

C++ Synopsis

#include "engine/flux.h"

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

Python Synopsis

from ooflib.SWIG.engine.flux import VectorFlux

class VectorFlux(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

VectorFlux is a Flux whose value is a three-vector, such as a heat current. Like all Fluxes, it should only be constructed in Python. See Section 8.3.

The FieldIndex class for VectorFlux is VectorFieldIndex. The Components class is VectorFieldComponents, and the ComponentIterator is VectorFieldIterator.

Methods

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

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

VectorFlux::getIndex returns a pointer to a VectorFieldIndex. The name argument can be "x", "y", or "z".


Flux		SymmetricTensorFlux