OOF2: The Manual

getFlux
	Flux Classes and Functions

Name

getFlux — Retrieve a Flux object by name

#include "engine/flux.h"
static Flux *Flux::getFlux(const std::string& name);

from ooflib.SWIG.engine import flux
f = flux.getFlux(name)

getFlux returns a previously created Flux object. In C++ it returns a pointer to the base class, which may be cast to the derived class, e.g:

VectorFlux *hf = dynamic_cast<VectorFlux*>(getField("Heat_Flux"));

In Python, it returns a reference to an object of the appropriate derived class:

>>> hf = getFlux("Heat_Flux")
>>> type(hf)
<class 'ooflib.SWIG.engine.flux.VectorFlux'>

getFlux is defined in the main OOF2 namespace so that it can be used freely in scripts, text mode and the Console Window.


SymmetricTensorFlux		Equation Classes and Functions