OOF2: The Manual


PlaneFluxEquation — An Equation subclass for enforcing plane-flux constraints


Consult the Equation base class for base class method documentation.

C++ Synopsis

#include "engine/equation.h"
class PlaneFluxEquation: , Equation {

Python Synopsis

from oof2.SWIG.engine.equation import PlaneFluxEquation
class PlaneFluxEquation(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.


PlaneFluxEquations set the out-of-plane components of a Flux to zero. They are solved simultaneously with DivergenceEquations to enforce OOF2's generalized plane-stress conditions.

PlaneFluxEquations should only be created by calling their Python constructor. See Section 8.1 for more information.


PlaneFluxEquation(name, flux, dim)

The PlaneFluxEquation python constructor takes three arguments:

The name of the equation, as it will be seen in the GUI.
The Flux object whose out-of-plane components are to be constrained.
The integer dimension of the equation. This should be equal to the number of out-of-plane components of the Flux.