Name
DivergenceEquation — An Equation subclass for divergence equations
Synopses
Consult the Equation
base class for base class method documentation.
C++ Synopsis
#include "engine/equation.h"
class DivergenceEquation: , Equation {
}
Python Synopsis
from oof2.SWIG.engine.equation import DivergenceEquation
class DivergenceEquation(Equation):
def __init__(self, name, flux, dim)
Source Files
SRC/engine/equation.h
: C++ header
SRC/engine/equation.C
: C++ code

SRC/engine/equation.swg
: SWIG source code

SRC/engine/equation.spy
: python code
included in equation.swg
.
Description
The DivergenceEquation
class represents
equations
of the form

(8.1)

DivergenceEquation
objects should only
be constructed in Python. See Section 8.1 for more information.
Methods
DivergenceEquation(name, flux, dim)
The DivergenceEquation
python
constructor takes three arguments:
 name

The name of the equation, as it will be seen in the
GUI.
 flux

A
Flux
object. This is the flux that appears on the left
hand side of Eq. (8.1).
 dim

The integer dimension of the equation. This should
be equal to the number of inplane components
of the flux.