OOF2: The Manual

6.4. Registered Classes
Prev  Chapter 6. Reference  Next

6.4. Registered Classes

Many command arguments in OOF2 require the user to choose one of a set of related objects. These sets are called RegisteredClasses, because the objects are constructed from Registrations, stored in a Registry, which provide the information needed to create the objects. All of that is completely irrelevant to you, the OOF2 user, but helps to explain the title of this section.

Section Section 6.4.1 lists the RegisteredClasses and the choices (subclasses) available for each class. Section Section 6.4.2 describes the subclasses and lists the parameters required to create the objects. Some subclasses may be members of more than one RegisteredClass.

6.4.1. Base RegisteredClasses

6.4.2. Subclasses

  • Abg -- Euler angles (alpha, beta, gamma) are applied: first beta about the z axis, then alpha about the y, and finally gamma about z. This operation brings the crystal axes into coincidence with the lab axes.
  • AcceptanceRate -- Iteration stops when the move acceptance rate falls below the given threshold.
  • AdaptiveMeshRefine -- Refine less accurate elements.
  • AdaptiveMeshRefinement -- Adaptively refine mesh based on error estimation.
  • AddNodes -- Add a set of nodes to an existing point boundary.
  • AddSegments -- Add a set of segments to an existing edge boundary.
  • AllElements -- Modify all elements.
  • AllMeshElements -- Operate on all Mesh elements
  • AllNodes -- Try moving all nodes.
  • Anneal -- Move nodes randomly and accept the ones that meet the acceptance criterion.
  • AssignMaterial -- Assign a Material to elements. This is *optional*, and overrides Material assignments from the Microstructure.
  • AutomaticRationalization -- Automatically fix badly shaped Skeleton elements.
  • AverageEnergy -- Accept the change, if any, that improves the average energy the most.
  • AverageField -- Average a Field over a boundary.
  • Axis -- Axis and angle representation of a 3D rotation. The rotation brings the crystal axes into coincidence with the lab axes.
  • Axis2HSV -- Map Axis orientations to HSV values.
  • BadlyShapedElements -- Modify badly shaped elements.
  • BiCGSolver -- Bi-Conjugate Gradient method. An iterative method for non-symmetric matrices.
  • BiCGStabSolver -- Stabilized Bi-Conjugate Gradient method for non-symmetric matrices.
  • Bisection -- Divide element edges into two.
  • BitmapDisplayMethod -- Display an Image as a bitmap.
  • BitmapOverlayDisplayMethod -- Special bitmap display method for overlays.
  • BlockPreconditioner -- A preconditioner that treats in-plane and out-of-plane components differently.
  • Both -- Iteration stops when both the energy reduction rate and move acceptance rate fall below the given thresholds.
  • Bunge -- Bunge angles for defining a rotation which operates on the lab axes, bringing them into coincidence with the crystal axes, in the order z, x, z.
  • Bunge2RGB -- Map Bunge angles to RGB values.
  • CGSolver -- Conjugate Gradient method for solving symmetric matrices.
  • CheckAllElements -- Refine all elements.
  • CheckAspectRatio -- Divide elements with extreme aspect ratios.
  • CheckElementsInGroup -- Refine elements in an element group.
  • CheckHeterogeneousEdges -- Divide heterogeneous segments.
  • CheckHomogeneity -- Refine heterogeneous elements.
  • CheckSegmentGroup -- Refine segments in a segment group
  • CheckSelectedEdges -- Divide selected segments.
  • CheckSelectedElements -- Refine selected elements.
  • CircleBrush -- Brush with a circular profile.
  • ComplementSubProblem -- Construct a Subproblem from the elements that aren't in another subproblem.
  • ConditionalIteration -- Iteration stops when a given condition is satisfied.
  • ConstScalarFieldInit -- Initialize a scalar field with a constant value.
  • ConstThreeVectorFieldInit -- Initialize a two-vector field with a constant value.
  • ConstTwoVectorFieldInit -- Initialize a two-vector field with a constant value.
  • ConstantProfile -- Boundary condition has a constant value.
  • ContinuumProfile -- Boundary condition is arbitrary function of position or arclength.
  • CrossSectionDomain -- Use a Mesh cross section as the post-processing domain.
  • CubicRank4TensorBulkShear -- Cubic rank 4 tensor in terms of bulk and shear moduli.
  • CubicRank4TensorCij -- Explicit representation in terms of tensor components.
  • CubicRank4TensorEnu -- Cubic rank 4 tensor in terms of Young's modulus and Poisson ratio.
  • CubicRank4TensorLame -- Cubic rank 4 tensor in terms of Lame coefficients.
  • DeltaGray -- Range of gray values.
  • DeltaHSV -- Range of colors in hue, saturation, and value space.
  • DeltaRGB -- Range of colors in red, green, and blue space.
  • Determinant -- Determinant of a symmetric tensor.
  • Deviator -- Magnitude of deviatoric part of a symmetric tensor.
  • DirectSolver -- A non-iterative non-sparse matrix solver using LU decomposition. Uses a lot of memory. Not recommended if the finite element mesh is large.
  • DirichletBC -- Fix the values of a Field along a boundary.
  • EdgeFromElements -- Construct an edge boundary around a set of elements.
  • EdgeFromNodes -- Construct an edge boundary from a collection of nodes.
  • EdgeFromSegments -- Construct an edge boundary from a set of segments.
  • Either -- Iteration stops when either the energy reduction rate or move acceptance rate falls below the given thresholds.
  • ElasticStrain -- The part of the geometric strain that contributes to stress.
  • ElementGroup -- Use an element group as the post-processing domain.
  • ElementSampleSet -- Data will be integrated over Element areas.
  • ElementSegmentSampleSet -- Evaluate data on line segments within Elements.
  • ElementsInGroup -- Operate on an Element group
  • EntireMesh -- Use the entire Mesh as a post-processing domain.
  • EntireMeshSubProblem -- A 'subproblem' that includes the entire Mesh.
  • Euler2HSV -- Map ABG Euler angles to HSV values.
  • Euler2RGB -- Map ABG Euler angles to RGB values.
  • ExpandByElements -- Expand the node selection by selecting all nodes of neighboring elements.
  • ExpandBySegments -- Expand the node selection by selecting all nodes of neighboring segments.
  • FiddleElementsInGroup -- Move nodes of elements in a given element group
  • FiddleHeterogeneousElements -- Try moving nodes of heterogeneous elements.
  • FiddleSelectedElements -- Try moving nodes of selected elements.
  • FilledContourDisplay -- Draw a filled contour plot of the given output data.
  • FixIllegal -- Remove illegal elements from a Skeleton.
  • FixedIteration -- Repeat operation a fixed number of times.
  • FloatBC -- Fix the values of Fields on the boundary, up to an unspecified offset.
  • ForceBC -- Apply a force to all nodes on a boundary. A force is a divergence of a flux (eg, stress, heat flux). The condition is applied independently at each node, and is therefore sensitive to node density.
  • FromAllSegments -- Examine all segments.
  • FromSelectedElements -- Examine segments from segments of currently selected elements.
  • FromSelectedSegments -- Examine selected segments.
  • FuncScalarFieldInit -- Initialize a scalar field with a function of x and y.
  • FuncThreeVectorFieldInit -- Initialize a three-vector field with a function of x and y.
  • FuncTwoVectorFieldInit -- Initialize a two-vector field with a function of x and y.
  • GMRESSolver -- Generalized Minimal Residual method. An iterative method for non-symmetric matrices.
  • GammaGrayMap -- gray = x^(1/gamma)
  • GeographicQ2T -- Split a quad based on its neighbors.
  • GeometricStrain -- The symmetric derivative of the displacement field.
  • Gray -- A gray color.
  • GrayData8 -- Gray image data.
  • GrayMap -- Linear gray scale.
  • GridSampleSet -- Evaluate data on a rectangular grid of points.
  • HSVColor -- Color specified by Hue, Saturation, and Value.
  • HSVMap -- Varying hue, at fixed saturation and value.
  • HeterogeneousElements -- Modify heterogeneous elements.
  • ICPreconditioner -- Incomplete Cholesky preconditioner. Appropriate only for meshes with symmetric, positive definite stiffness matrices.
  • ILUPreconditioner -- Incomplete LU-factorization
  • IntegrateBdyFlux -- Integrate a Flux along a boundary.
  • IntersectionSubProblem -- Construct a Subproblem from the intersection of two previously defined Subproblems
  • IsotropicRank4TensorBulkShear -- Isotropic rank 4 tensor in terms of bulk and shear moduli.
  • IsotropicRank4TensorCij -- Explicit representation in terms of tensor components.
  • IsotropicRank4TensorEnu -- Isotropic rank 4 tensor in terms of Young's modulus and Poisson's ratio.
  • IsotropicRank4TensorLame -- Isotropic rank 4 tensor in terms of Lame coefficients.
  • JacobiPreconditioner -- A light-weight preconditioner, that simply inverts the diagonal part of the matrix.
  • L2ErrorNorm -- Use the root mean square of the components of the error.
  • LimitedAverageEnergy -- Accepts the change that lowers the average energy AND meets specified conditions on homogeneity and shape energy.
  • LimitedUnconditional -- Accepts any change that meets specified conditions on homogeneity and shape energy.
  • LineSampleSet -- Evaluate data at evenly spaced points on a line.
  • LinearDriver -- linear numerical method to solve system of linear equations associated to finite element mesh
  • LinearProfile -- Boundary condition is a linear function of arclength.
  • Magnitude -- Magnitude of a vector.
  • MaterialSubProblem -- A subproblem defined on all Elements composed of a given Material.
  • MatrixTrace -- Trace of a symmetric tensor.
  • MergeTriangles -- Merge neighboring homogeneous triangles to form quadrilaterals.
  • MeshCenterFillDisplay -- Quick and dirty contour plot.
  • MeshCrossSectionDisplay -- Determine which cross sections are displayed, and how.
  • MeshEdgeDisplay -- Draw the edges of Mesh Elements.
  • MeshElementGroup -- Operate on Mesh elements in a given element group.
  • MeshInfoDisplay -- Set display parameters for the decorations used by the Mesh Info toolbox.
  • MeshMaterialDisplay -- Fill each Element with the color of its assigned Material.
  • MicrostructureMaterialDisplay -- Display the color of the Material assigned to each pixel.
  • MinimumArea -- Only refine elements with area greater than the given threshold.
  • MoveNodeDisplay -- Display the node being moved by the Move Node toolbox.
  • NamedProfile -- Named Profile.
  • NeumannBC -- Set the normal component of a Flux (eg, stress, heat flux) along the boundary.
  • NewtonDriver -- Newton-Raphson solver for the solution of non-linear equations.
  • NodesInGroup -- Try moving only the nodes in a given group
  • OrientationDisplay -- Display the Orientation Property of pixels.
  • OrientationMapDisplay -- Display a Microstructure's Orientation Map, whether or not it's used by Material Properties.
  • PeriodicBC -- Set the values of a component of a field to be equal along two opposite boundaries.
  • PiezoelectricStrain -- Strain induced by electric fields in piezoelectric materials
  • PinnedNodesDisplay -- Display the pinned nodes.
  • PixelGroup -- Use a pixel group as a post-processing domain.
  • PixelGroupSubProblem -- A subproblem containing all elements whose dominant pixel is in a given pixel group.
  • PixelInfoDisplay -- Display a pixel that is being queried.
  • PixelSampleSet -- Evaluate data at the centers of pixels.
  • PlainContourDisplay -- Draw contour lines for the given output data.
  • PointFromElements -- Construct a point boundary surrounding a set of elements.
  • PointFromNodes -- Construct a point boundary from a set of nodes.
  • PointFromSegments -- Construct a point boundary from the endpoints of a set of segments.
  • QuadSkeleton -- A Skeleton of quadrilateral elements.
  • QuadSplit -- Split quadrilaterals with large interior angles.
  • Quaternion -- The Quaternion representation for 3D orientations. e0 is the cosine of the half-angle of the rotation, and e1 through e3 are the x, y, and z components of the rotation axis times the sine of the half-angle. The rotation brings the crystal axes into coincidence with the lab axes.
  • RGBColor -- Color specified as a Red, Green, Blue triplet.
  • RGBData8 -- RGB image data.
  • Rationalize -- Fix badly shaped elements in a Skeleton.
  • ReductionRate -- Iteration stops when the energy reduction rate falls below the given threshold.
  • Refine -- Subdivide elements.
  • Relax -- Improve a skeleton by solving a finite element system where the properties are functions of the underlying homogeneity and shape
  • RemoveBadTriangle -- Remove triangles with extreme interior angles.
  • RemoveMaterial -- Remove a Material explicitly assigned to elements. This *restores* the implicit Material assignments from the Microstructure.
  • RemoveNodes -- Remove a set of nodes from an existing point boundary.
  • RemoveSegments -- Remove a set of segments from an existing boundary.
  • RemoveShortSide -- Eliminate the shortest side of a quadrilateral.
  • ReverseBoundary -- Reverse the direction of an edge boundary.
  • RevertMesh -- Undo adaptive mesh refinement.
  • Rodrigues -- Rodrigues vector representation for 3D orientations. The vector points along the axis of the rotation, and its magnitude is the tangent of half the angle of the rotation. The rotation brings the crystal axes into coincidence with the lab axes.
  • ScalarOtherMeshInit -- Initialize a scalar field from the same field on another mesh.
  • SecondInvariant -- Second invariant of a symmetric tensor.
  • SelectedElements -- Modify selected elements.
  • SelectedMeshElements -- Operate on Mesh elements that are selected in the corresponding Skeleton.
  • SelectedNodes -- Try moving only the selected nodes.
  • SelectedSkeletonBoundaryDisplay -- Display the currently selected boundary.
  • SkeletonBoundaryDisplay -- Display some or all of the boundaries of the Skeleton
  • SkeletonEdgeDisplay -- Draw the edges of Skeleton Elements.
  • SkeletonElementSelectionDisplay -- Display the currently selected elements
  • SkeletonIllegalElementDisplay -- Display illegal elements in a Skeleton
  • SkeletonInfoDisplay -- Set parameters for the decorations used by the Skeleton Info toolbox.
  • SkeletonMaterialDisplay -- Fill each Element with the color of its assigned Material.
  • SkeletonNodeSelectionDisplay -- Display the currently selected nodes.
  • SkeletonQualityDisplay -- Color each element according to its effective energy.
  • SkeletonSegmentSelectionDisplay -- Display the currently selected segments.
  • Smooth -- Move nodes to the average position of their neighbors and accept ones that meet the acceptance criterion.
  • SnapAll -- Snap all nodes.
  • SnapAnneal -- Snap nodes to pixel boundaries and randomly accept the moves that meet the acceptance criterion.
  • SnapHeterogenous -- Snap heterogeneous elements.
  • SnapNodes -- Move nodes directly to pixel boundaries.
  • SnapRefine -- Subdivide elements along pixel boundaries.
  • SnapSelected -- Snap selected elements.
  • SnapSelectedNodes -- Snap selected nodes.
  • SpacedGridSampleSet -- Evaluate data on a rectangular grid of points.
  • SpecificRationalization -- Apply specific tools to fix badly shaped Skeleton elements.
  • SpectralMap -- blue, green, yellow, orange, red
  • SplitQuads -- Split quadrilateral elements into two triangles.
  • SquareBrush -- Brush with a square profile.
  • StatElementSegmentSampleSet -- Evaluate data on line segments within Elements.
  • StatGridSampleSet -- Evaluate data on a rectangular grid of points.
  • StatLineSampleSet -- Evaluate data at evenly spaced points on a line.
  • StatPixelSampleSet -- Evaluate data at the centers of pixels.
  • StatSpacedGridSampleSet -- Evaluate data on a rectangular grid of points.
  • StraightCrossSection -- Cross section defined by two points.
  • SwapEdges -- Rearrange internal edges in pairs of neighboring elements.
  • TequilaSunrise -- It's another Tequila sunrise/Stirrin' slowly 'cross the sky...
  • ThermalMap -- Black to red to yellow to white.
  • ThermalStrain -- Strain induced by thermal expansion
  • ThreeVectorOtherMeshInit -- Initialize a three-vector field from the same field on another mesh.
  • TriSkeleton -- A Skeleton of triangular elements.
  • TrialAndErrorQ2T -- Split a quad along both of its diagonals and choose the better one.
  • Trisection -- Gallia est omnis divisa in partes tres, as are the edges of the elements.
  • TwoVectorOtherMeshInit -- Initialize a two-vector field from the same field on another mesh.
  • UnPreconditioner -- Be bold (or foolhardy) and attempt to solve the mesh without a preconditioner
  • Unconditional -- Unconditionally accept the best change even if it increases the energy.
  • Unconditionally -- Consider all Elements for possible refinement.
  • UnionSubProblem -- Construct a Subproblem from the union of two previously defined Subproblems
  • WeightedL2ErrorNorm -- Use the weighted root mean square of the components of the error.
  • X -- Goldstein's X convention for 3D orientations, using rotations which bring the crystal axes into coincidence with the lab axes, in the order z, x, z.
  • XYZ -- The "aerodynamic" XYZ convention for specifying an orientation. Rotation by phi about x, then theta about y, then psi about z, brings the crystal axes into coincidence with the lab axes.
  • XorSubProblem -- Construct a Subproblem from the exclusive or of two previously defined Subproblems.
  • ZZ_Estimator -- Error estimation by Zienkiewicz and Zhu's superconvergent patch recovery.
Prev  Up  Next
original  Home  Angle2Color

/* OOF home */ /* OOF2 home */ /* Send mail to the OOF Team */