OOF2: The Manual

Name

VectorFlux — A vector-valued Flux

Synopses

C++ Synopsis

#include "engine/flux.h" 
class VectorFlux: , public Flux {
}

Python Synopsis

from oof2.SWIG.engine.flux import VectorFlux 
class VectorFlux(Flux):
  def __init__(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.1.

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