Glyph
Version 7.22.2
About
Base Type
Global Types
General Types
Mode Types
Base Entity Type
Database Entity Types
Grid Entity Types
Source Entity Types
Segment Types
Connector Support Types
Domain Support Types
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: FaceStructured

Structured faces are collections of pw::DomainStructured that represent one of the six nominal sides of a pw::BlockStructured block.  A structured face cannot persist without a block.

Derives From

pw::Object pw::Face

Summary
pw:: FaceStructured
Structured faces are collections of pw::DomainStructured that represent one of the six nominal sides of a pw::BlockStructured block.
Static Actions
create
This action creates a new structured face object.
createFromDomains
This action creates new structured face objects from the given domains.
Instance Actions
getPoint
This action gets the position of a face grid point.
getPosition
This action gets the position in the defining space of the face at the given index.
getXYZ
This action gets the position of the face in model space at the given index.
getCell
This action gets the indices of the given cell.
getAdjacentDomains
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.

See Also

createFromDomains, pw::Block.addFace

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 required 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.

See Also

create, pw::Block.addFace

Instance Actions

getPoint

$face getPoint < index | ij_index >

This action gets the position of a face grid point.

Parameters

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

Information

Either index or ij_index must be specified.

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 integer index or an ij index.  This is the default option.
valueThis required 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 integer index or an ij index.  This is the default option.
valueThis required 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 optional parameter is the linear integer index of the cell to get.
ij_indexThis optional parameter is the ij index of the cell to get.

Information

Either index or ij_index must be specified.

Returns

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

Notes

Collaped (degenerate) quadrilateral cells are possible if a face contains one or more poles.  A collapsed quadrilateral 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 optional flag, if present, means to also include domains in the face that are along the edge.
-manifoldThis optional flag, if present, restricts results to manifold domains (only 2 domains sharing a common connector).
-maximumAngle angleThis optional parameter specifies the float maximum bend angle for considering entities as adjacent in the range [0.0, 180.0].  180.0 is the default.
-visibleOnlyThis optional flag, if present, restricts the results to only visible domains.

Returns

This action returns a list of pw::Domain objects adjacent to the face.
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
A structured domain is a computationally orthogonal surface grid bounded by exactly four edges, any of which can be degenerate in the zero dimension (pole).
A structured block is a computationally orthogonal volume grid, bounded by exactly six pw::FaceStructured faces, any of which can be degenerate in one (line) or zero (pole) dimensions.
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
A face is part of a block boundary, consisting of oriented, edge-connected pw::Domain objects.
Structured faces are collections of pw::DomainStructured that represent one of the six nominal sides of a pw::BlockStructured block.
$block addFace face
This action adds a face to the block.
$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.
A point is a position either in model space or database parameter space.
A vector is a list of float values.
A float is a fractional number.
A domain is a computationally two-dimensional grid entity, bounded by one or more pw::Edges.