ElementCmd

From Flooxs
Jump to navigation Jump to search

Element

element - extract the grid of a material and return as a list of coordinates

Synopsis

element

Material
( [x.value=<n>][y.val=<n>][z.val=<n>] )

Description

This command will extract the grid for a specified material and return the grid as a list of coordinates. This can be used to plot the grid. Usually this is used with the [BLTPlot.html BLT plot commands] to create the device outline.

The return is a list of lists of coordinates that define the grid. Processing is performed to prevent multiple traversals and to limit the number of distinct lines used. Each of the outer lists make up a continuous line through the grid. Each inner list contains coordinate pairs in order for that line.

Material Description
Please see the material description for information on specifying materials. A material must be specified for this command.
x.value, y.value, z.value
These parameters specify a cut line for the three-dimensional solid, so that a two-dimensional return is provided. They are ignored in one- and two- dimenisions.

Examples

element oxide

This command will return the grid of the oxide material.

Bugs and Missing Features

None.

See Also