OOF2: The Manual

Name

OOF.Skeleton.New — Create a new Skeleton in a Microstructure.

Synopsis

OOF.Skeleton.New(name, microstructure, x_elements, y_elements, skeleton_geometry)

Details

  • Parent Menu: OOF.Skeleton
  • Callback: function _skeleton_from_mstructure in module ooflib.engine.IO.skeletonmenu
  • Parameters:

    name
    Name of the new skeleton. Type: A character string containing no colons (:), or the value automatic.
    microstructure
    Type: The path to an existing Microstructure object.
    x_elements
    No. of elements in the x-direction. Type: Integer.
    y_elements
    No. of elements in the y-direction. Type: Integer.
    skeleton_geometry
    The shape of the elements. Type: An object of the SkeletonGeometry class.

Description

This command creates a new Skeleton in a Microstructure. The new Skeleton has the same physical height and width as the Microstructure. It's divided into a rectangular array of cells, x_elements by y_elements. The skeleton_geometry parameter determines whether each cell becomes one rectangular Element or two triangular Elements. If they are triangular, an Arrangement object determines how the cells are split. See Arrangement for illustrations.

Since the mesh can be refined and otherwise modified, choosing the optimal values of x_elements and y_elements is not crucial, but it helps to start with reasonable values. They should be set so that the element size is smaller than the largest features that need to be resolved in the Microstructure. In the end, every feature in the Microstructure should contain at least a few elements. Having many more elements is inefficient. Starting with very large elements and refining all of them is less efficient than starting with smaller elements and refining some of them.

See Also