OOF2: The Manual

6.6. Enumerated Types
	Chapter 6. Reference

6.6. Enumerated Types

Many command arguments in OOF2 require the user to choose from a small set of predetermined constant values, called Enums. These Enums differ from RegisteredClasses in that they are much simpler objects, and never require any parameters. This section describes all of the Enum classes and lists their allowed values.

In the GUI, Enum parameters are chosen from a pull-down menu. In scripts, Enum parameters can be set to the name of the Enum object, in quotation marks. For example, this documentation was generated by

OOF.Help.API_Listing(filename='oof2_api.xml', format='xml')

Here, format is a parameter that requires an object from the MenuDumpFormat class.

AngleUnits -- None
AnisoCrystalSymmetry -- None
Arrangement -- Arrangement for triangular initial Skeleton.
CacheType -- How to store data for previous time steps.
ColorNorm -- Ways of measuring the difference between two colors.
ConstancyEnum -- None
DataFileFormat -- Types of OOF2 data files.
DataFileFormatExt -- More types of OOF2 data files.
Director -- Directions for arranging objects.
EigenValueRank -- Select an eigenvalue of a symmetric 3x3 tensor.
Element2 -- 2 cornered finite elements.
Element3 -- 3 cornered finite elements.
Element4 -- 4 cornered finite elements.
ElementShapeType -- Shapes of Skeleton Elements.
EnergyType -- Varieties of Energy.
FlipDirection -- Axis about which to flip an Image.
InPlaneSpaceComponent -- The in-plane components of vectors.
InternationalName -- The short International (Hermann-Mauguin) name for a point group.
MaterialType -- Types of OOF2 materials.
MenuDumpFormat -- File formats for the OOF2 API dump.
OrientationEnum -- Various ways to specify an Orientation
OutputType -- Different varieties of Output classes.
ReferenceFrame -- Evaluate quantities in the lab or crystal reference frame.
RuleSet -- Refinement rule sets.
SchoenfliesName -- The Schoenflies name for a point group.
SegmentSide -- The side of an element edge on which output data should be computed.
Separator -- Characters used between columns in output files.
Units -- Specify units for inputs
WriteMode -- Write or append?


`Z-Z Estimator (ZZ_Estimator)`		AngleUnits