pw:: Face

pw::Face getSurfaceEdgeMinimumLength faces

This action gets the calculated minimum surface edge length based on area of cells in all given faces.

Parameters

Returns

This action returns the float minimum surface edge length.

pw::Face getSurfaceEdgeMaximumLength faces

This action gets the calculated maximum surface edge length based on area of cells in all given faces.

Parameters

Returns

This action returns the float maximum surface edge length.

$face delete

This action deletes the face.  This can only be done if the face has not been added to a pw::Block.  Calling delete on a face after it has been added to a block will generate an error.

Parameters

none

Returns

This action returns nothing.

$face getState

This action gets the state of this face.

Parameters

none

Returns

This action returns a string with options < Complete | Incomplete | Invalid >.

$face getDimensions

This action gets the dimensions of this face.

Parameters

none

Returns

This action returns a two integer element list of the dimensions of the face.  Unstructured faces have a second dimension of 1.

$face getPointCount

This action gets the number of points in this face.

Parameters

none

Returns

This action returns the integer number of points.

$face getPoint index

This action gets the position of a face grid point.

Parameters

Returns

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.

Parameters

Returns

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

$face getXYZ ?-index? value

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

Parameters

Returns

This action returns an XYZ vector.

$face getCellCount

This action gets the number of cells in this face.

Parameters

none

Returns

This action returns the integer number of cells.

$face getCell index

This action gets the indices of the given cell.

Parameters

Returns

This action returns a list of indices.

$face getLinkages domain

This action gets the possible ways a domain can be added to a face.

Parameters

Returns

This action returns a list of linkages, with each linkage entry consisting of, in order:

• the starting domain edge integer index
• the connector integer index of the starting edge
• the ending domain edge integer index
• the connector integer index of the ending edge
• the starting face edge integer index
• the connector integer index of the starting face edge
• a boolean value specifying whether or not the orientation is reversed.

$face getDomainCount

This action gets the number of domains in this face.

Parameters

none

Returns

This action returns the integer number of domains.

$face getDomain index

This action gets a domain from this face.

Parameters

Returns

This action returns a pw::Domain object.

$face addDomain ?-linkage linkage? domain

This action adds a domain to this face.

Parameters

See Also

getLinkages, mapLinkage

Returns

This action returns nothing.

$face removeLastDomain

This action removes the last domain added to this face.

Parameters

none

Returns

This action returns nothing.

$face findDomain domain

This action finds the given domain in this face’s domain list.

Parameters

Returns

This action returns the integer index of the domain in the domain list, or 0 if the domain was not found.

$face getDomainOrientation index

This action gets the orientation of a domain in this face.

Parameters

Returns

This action returns a string with options < Same | Opposite >.

$face getEdgeCount

This action gets the number of edges in this face.

Parameters

none

Returns

This action returns the integer number of edges.

$face getEdge index

This action gets an edge from this face.

Parameters

Returns

This action returns a pw::Edge object.

$face getEdges

This action gets all edges from this face.

Parameters

This action has no parameters.

Returns

This action returns a pw::Edge object list.

$face findEdge edge

This action finds the given edge in this face’s edge list.

Parameters

Returns

This action returns the integer index of the edge in the edge list, or 0 if the edge was not found.

$face joinDomains

This action joins the domains in this face to create a single domain.

Parameters

none

Returns

This action returns a new pw::DomainStructured or pw::DomainUnstructured object.

$face getDomains

This action gets all domains in a face.

Parameters

none

Returns

This action returns a list of pw::Domain in the face (each domain is only listed once, regardless of the number of times it is used by the face).

$face mapLinkage linkage domain

This action maps a domain linkage to the face edges.

Parameters

Returns

This action returns a list of 4 integers values representing in order:

• the edge integer index of the start of the linkage
• the connector integer index of the start of the linkage
• the edge integer index of the end of the linkage
• the connector integer index of the end of the linkage

The start and end are arranged so that the edge and connector indices increase as you proceed from the start to the end.  Note that for an unstructured face, the will be constrained to a single edge.  This means that if the start connector index is higher than the end connector index, the linkage wraps around on the same edge.