OOF2: The Manual

PlaneFluxEquation
	Equation Classes and Functions

Name

PlaneFluxEquation — An Equation subclass for enforcing plane-flux constraints

Synopses

Consult the Equation base class for base class method documentation.

C++ Synopsis

#include "engine/equation.h"

class PlaneFluxEquation: , Equation {
}

Python Synopsis

from ooflib.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.

Description

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.

PlaneFluxEquation objects should only be created by calling their Python constructor. 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

`PlaneFluxEquation(name, flux, dim)`

The PlaneFluxEquation python constructor takes three arguments:

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


DivergenceEquation		getEquation