pw:: FaceStructured

Structured face type

Derives From

pw::Object pw::Face

Summary
Structured face type
This action creates a new structured face object.
This action creates new structured face objects from the given domains.
This action gets the position of a face grid point.
This action gets the position in the defining space of the face at the given index.
This action gets the position of the face in model space at the given index.
This action gets the indices of the given cell.
This action gets domains adjacent to a face.

Static Actions

create

pw::FaceStructured create

This action creates a new structured face object.

Parameters

none

Returns

This action returns a new pw::FaceStructured object.

createFromDomains

pw::FaceStructured createFromDomains ?-single? domains

This action creates new structured face objects from the given domains.

Parameters

-singleIf this optional flag is present, this action tries to combine the domains into a single complete face.  If that is not possible, a face is created for each domain.
domainsThis parameter is a list of pw::DomainStructured objects.

Notes

While this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input domains.  The faces may be created in a different order or may be created with different orientations or topologies.  Use the explicit face building routines (pw::FaceStructured.create and pw::Face.addDomain commands) to build the face in a controlled manner.

Returns

This action returns a list of new pw::FaceStructured objects.

Instance Actions

getPoint

$face getPoint < index | ij_index >

This action gets the position of a face grid point.

Parameters

indexThis parameter is the integer linear index of the grid point to get with the range [1, number of points].
ij_indexThis parameter is the ij index of the grid point to get.

Returns

This action returns a point giving the grid point position (may be in the form “u v dbentity”).

getPosition

$face getPosition ?-index? value

This action gets the position in the defining space of the face at the given index.

Parameters

-indexThis optional parameter indicates to get the position at a grid point; the value is a linear index or an ij index; this is the default option.
valueThis parameter is the value at which to get the position.

Returns

This action returns a point giving the position on the face (may be in the form “u v dbentity”).

getXYZ

$face getXYZ ?-index? value

This action gets the position of the face in model space at the given index.

Parameters

-indexThis optional parameter indicates to get the position at a grid point; the value is a linear index or an ij index; this is the default option.
valueThis parameter is the value at which to get the position.

Returns

This action returns an XYZ vector.

getCell

$face getCell ?-uncollapsed? < index | ij_index >

This action gets the indices of the given cell.

Parameters

-uncollapsedIf this optional flag is specified, degenerate quad cells are returned without coincident grid points collapsed.  By default, degenerate quad cells are collapsed before they are returned (see Notes).  If a quad cell does NOT contain any coincident grid points, this option is ignored and a normal quad cell is returned.
indexThis parameter is the linear index of the cell to get.
ij_indexThis parameter is the ij index of the cell to get.

Returns

This action returns a list of linear point indicies if the index parameter is used, or a list of ij point indicies if the ij_index parameter is used.

Notes

Collaped (degenerate) quad cells are possible if a face contains one or more poles.  A collapsed quad may be returned as a 3-point tri, a 2-point bar, or a single point.

getAdjacentDomains

$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-visibleOnly?

This action gets domains adjacent to a face.

Parameters

-includeSelfThis flag, if present, means to also include domains in the face that are along the edge.
-manifoldThis flag, if present, restricts results to manifold domains (only 2 domains sharing a common connector).
-maximumAngle angleThis optional parameter specifies the maximum bend angle for considering entities as adjacent; float [0, 180]; 180 is the default.
-visibleOnlyThis flag, if present, restricts the results to only visible domains.

Returns

This action returns a list of domains adjacent to the face.

pw::FaceStructured create
This action creates a new structured face object.
pw::FaceStructured createFromDomains ?-single? domains
This action creates new structured face objects from the given domains.
$face getPoint < index | ij_index >
This action gets the position of a face grid point.
$face getPosition ?-index? value
This action gets the position in the defining space of the face at the given index.
$face getXYZ ?-index? value
This action gets the position of the face in model space at the given index.
$face getCell ?-uncollapsed? < index | ij_index >
This action gets the indices of the given cell.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-visibleOnly?
This action gets domains adjacent to a face.
Base type for all glyph types
Structured face type
Structured domain type
$face addDomain ?-linkage linkage? domain
This action adds a domain to this face.
An integer is a whole number.
An index is a list of integer values.