OOF2: The Manual
This section contains the reference pages for the classes and functions that can be used when programming OOF2 extensions. Both the C++ and Python interfaces are documented, when appropriate. In general, only functions that are relevant to building OOF2 extensions are listed, and base class functions are not listed again in the derived classes.
Table of Contents
- Field — Base class for fields
- CompoundField —
A
Field
with both in- and out-of-plane parts. - ScalarField — A scalar-valued
Field
- TwoVectorField —
A two dimensional vector-valued
Field
object - Flux — Base class for
Fluxes
- VectorFlux — A vector-valued
Flux
- SymmetricTensorFlux — A 3×3 symmetric tensor valued
Flux
- FluxData — Store data during flux matrix computation
- Equation — Base class for Equations
- DivergenceEquation — An Equation subclass for divergence equations
- PlaneFluxEquation — An Equation subclass for enforcing plane-flux constraints
Table of Contents
- IndexP — Generic wrapper for index objects
- IteratorP — An IndexP that can loop over a range of values
- FieldIndex — Base class for index objects
- FieldIterator — Base class for FieldIndexes that loop over components
- ScalarFieldIndex — Index object for a scalar Field
- VectorFieldIndex — Index a vector field
- OutOfPlaneVectorFieldIndex — Index the out-of-plane components of a vector
- SymTensorIndex — Index a symmetric 3×3 tensor
- OutOfPlaneSymTensorIndex — Index the out-of-plane components of a 3×3 symmetric tensor
- ScalarFieldIterator — “Iterate” over the components of a scalar field
- VectorFieldIterator — Iterate over the components of a vector Field
- OutOfPlaneVectorFieldIterator — Loop over the out-of-plane components of a vector Field
- SymTensorIterator — Iterate over the components of a symmetric 3×3 tensor
- SymTensorInPlaneIterator — Iterate over the in-plane components of a symmetric 3×3 tensor
- SymTensorOutOfPlaneIterator — Iterate over the out-of-plane components of a symmetric 3×3 tensor
- OutOfPlaneSymTensorIterator — Iterate over the out-of-plane components of a symmetric 3×3 tensor
- Planarity — Specify the range of component iterators
Table of Contents
- Property — Base class for material properties
- PropertyRegistration — Register new Properties
- Material — Collection of Properties
Table of Contents
- Parameter — Parameter classes for OOF2 menu commands, Properties, Outputs, and RegisteredClasses.
Table of Contents
- Output — Compute output data on a Mesh
- PropertyOutput — Compute Property-dependent data on a Mesh
- PropertyOutputRegistration — Define a new Property-dependent output quantity
- PropertyOutputInit — Initialize Property Outputs
- definePositionOutput, defineScalarOutput, defineAggregateOutput — Install Outputs in the GUI
- OutputVal — Wrappers for Output data
- OutputValue — Wrapper for OutputVal classes
Table of Contents
- FEMesh — C++ FE mesh class
- CSubProblem — C++ subproblem class
- Element — Element class for finite element meshes
- Node, FuncNode — Node classes for finite element meshes
- ElementNodeIterator — Iterate over Nodes in an Element
- ElementShapeFuncIterator — Base class for other Node iterators
- ElementMapNodeIterator — Iterate over mapping nodes in an Element
- ElementFuncNodeIterator — Iterate over function nodes in an Element
- ElementCornerNodeIterator — Iterate over the corner Nodes of an Element
- DegreeOfFreedom — Degree of freedom at a Node
Table of Contents
- Coord — Coordinate classes
- MasterCoord — Position in master coordinate space
- Point — Python point class
Table of Contents
- acquirePyLock — ensure thread-safe Python API calls
- ErrError — Classes and functions for handling exceptions
- advertise —
announce the creation of
Fields
,Fluxes
, andEquations
- conjugatePair — Establish conjugacy relations
- loadFile — Specify an external file of documentation