OOF2: The Manual

DivergenceEquation
	Equation Classes and Functions

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 ooflib.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 (2.8) or, more generally, (2.9):

{\bf M}\frac{\partial^{2}}{\partial t^{2}}\mathrm{field}+{\bf C}\frac{\partial% }{\partial t}\mathrm{field}+\nabla\cdot\mathrm{flux}+\mathrm{force}=0.

(182)

DivergenceEquation objects should only be constructed in Python. Other than the constructor, its methods that are useful for extension authors are all defined in the Equation base class. See Section 8.3 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. (182).
dim: The integer dimension of the equation. This should be equal to the number of in-plane components of the divergence of the flux. The dimension of the heat equation is 1 and the dimension of the force balance equation is 2.


Equation		PlaneFluxEquation