OOF2: The Manual

getEquation
	Equation Classes and Functions

Name

getEquation — Retrieve a Equation object by name

#include "engine/equation.h"
static Equation* Equation::getEquation(const std::string& name);

from ooflib.SWIG.engine import equation
eq = equation.getEquation(name)

getEquation returns a previously created Equation object. In C++ it returns a pointer to the base class, which may be cast to the derived class:

DivergenceEquation *eq = dynamic_cast<DivergenceEquation*>(getEquation("Force_Balance"));

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

>>> eq = getEquation("Force_Balace")
>>> type(eq)
<class 'ooflib.SWIG.engine.equation.DivergenceEquation>

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


PlaneFluxEquation		Indices and Iterators