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.
pw:: | 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. |
pw::FaceStructured create
This action creates a new structured face object.
none
This action returns a new pw::FaceStructured object.
pw::FaceStructured createFromDomains ?-single? domains
This action creates new structured face objects from the given domains.
-single | If 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. |
domains | This required parameter is a list of pw::DomainStructured objects. |
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.
This action returns a list of new pw::FaceStructured objects.
$face getPoint < index | ij_index >
This action gets the position of a face grid point.
index | This optional parameter is the integer linear index of the grid point to get with the range [1, number of points]. |
ij_index | This optional parameter is the ij index of the grid point to get. |
Either index or ij_index must be specified.
This action returns a point giving the grid point position (may be in the form “u v dbentity”).
$face getPosition ?-index? value
This action gets the position in the defining space of the face at the given index.
-index | This 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. |
value | This required parameter is the value at which to get the position. |
This action returns a point giving the position on the face (may be in the form “u v dbentity”).
$face getXYZ ?-index? value
This action gets the position of the face in model space at the given index.
-index | This 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. |
value | This required parameter is the value at which to get the position. |
This action returns an XYZ vector.
$face getCell ?-uncollapsed? < index | ij_index >
This action gets the indices of the given cell.
-uncollapsed | If 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. |
index | This optional parameter is the linear integer index of the cell to get. |
ij_index | This optional parameter is the ij index of the cell to get. |
Either index or ij_index must be specified.
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.
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.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-visibleOnly?
This action gets domains adjacent to a face.
-includeSelf | This optional flag, if present, means to also include domains in the face that are along the edge. |
-manifold | This optional flag, if present, restricts results to manifold domains (only 2 domains sharing a common connector). |
-maximumAngle angle | This 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. |
-visibleOnly | This optional flag, if present, restricts the results to only visible domains. |
This action returns a list of pw::Domain objects adjacent to the face.
This action creates a new structured face object.
pw::FaceStructured create
This action creates new structured face objects from the given domains.
pw::FaceStructured createFromDomains ?-single? domains
This action gets the position of a face grid point.
$face getPoint < index | ij_index >
This action gets the position in the defining space of the face at the given index.
$face getPosition ?-index? value
This action gets the position of the face in model space at the given index.
$face getXYZ ?-index? value
This action gets the indices of the given cell.
$face getCell ?-uncollapsed? < index | ij_index >
This action gets domains adjacent to a face.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-visibleOnly?
This action adds a face to the block.
$block addFace face
This action adds a domain to this face.
$face addDomain ?-linkage linkage? domain