pw::Face
A face is part of a block boundary, consisting of oriented, edge-connected pw::Domain objects.
Derives From
pw::Object
Summary
pw::Face | A face is part of a block boundary, consisting of oriented, edge-connected pw::Domain objects. |
StaticActions | |
getSurfaceEdgeMinimumLength | This action gets the calculated minimum surface edge length based on area of cells in all given faces. |
getSurfaceEdgeMaximumLength | This action gets the calculated maximum surface edge length based on area of cells in all given faces. |
Instance Actions | |
delete | This action deletes the face. |
getState | This action gets the state of this face. |
getDimensions | This action gets the dimensions of this face. |
getPointCount | This action gets the number of points in this face. |
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 domain in model space at the given index. |
getCellCount | This action gets the number of cells in this face. |
getCell | This action gets the indices of the given cell. |
getLinkages | This action gets the possible ways a domain can be added to a face. |
getDomainCount | This action gets the number of domains in this face. |
getDomain | This action gets a domain from this face. |
addDomain | This action adds a domain to this face. |
removeLastDomain | This action removes the last domain added to this face. |
findDomain | This action finds the given domain in this face’s domain list. |
getDomainOrientation | This action gets the orientation of a domain in this face. |
getEdgeCount | This action gets the number of edges in this face. |
getEdge | This action gets an edge from this face. |
getEdges | This action gets all edges from this face. |
findEdge | This action finds the given edge in this face’s edge list. |
joinDomains | This action joins the domains in this face to create a single domain. |
getDomains | This action gets all domains in a face. |
mapLinkage | This action maps a domain linkage to the face edges. |
getSurfaceEdgeMinimumLength
pw::Face getSurfaceEdgeMinimumLength faces |
This action gets the calculated minimum surface edge length based on area of cells in all given faces.
Parameters
faces | This required parameter is a list of pw::Face. |
Returns
This action returns the float minimum surface edge length.
getSurfaceEdgeMaximumLength
pw::Face getSurfaceEdgeMaximumLength faces |
This action gets the calculated maximum surface edge length based on area of cells in all given faces.
Parameters
faces | This required parameter is a list of pw::Face |
Returns
This action returns the float maximum surface edge length.
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.
getState
This action gets the state of this face.
Parameters
none
Returns
This action returns a string with options < Complete | Incomplete | Invalid >.
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.
getPointCount
This action gets the number of points in this face.
Parameters
none
Returns
This action returns the integer number of points.
getPoint
This action gets the position of a face grid point.
Parameters
index | This required parameter is the integer index of the grid point to get with the range [1, number of points]. |
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
-index | This optional flag indicates to get the position at a grid point. The value is an integer index in the range [1, number of points]. This is the default option. |
value | This required parameter is the value at which to get the position. |
Returns
This action returns a point giving the position on the face, which may be in the form “u v dbentity”.
getXYZ
$face getXYZ ?-index? value |
This action gets the position of the domain in model space at the given index.
Parameters
-index | This optional flag indicates to get the position at a grid point. The value is an integer index in the range [1, number of points]. This is the default option. |
value | This required parameter is the value at which to get the position. |
Returns
This action returns an XYZ vector.
getCellCount
This action gets the number of cells in this face.
Parameters
none
Returns
This action returns the integer number of cells.
getCell
This action gets the indices of the given cell.
Parameters
index | This required parameter is the index of the cell to get in the range [1, number of cells]. |
Returns
This action returns a list of indices.
getLinkages
This action gets the possible ways a domain can be added to a face.
Parameters
domain | This required parameter is the pw::Domain object to be checked. |
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.
getDomainCount
This action gets the number of domains in this face.
Parameters
none
Returns
This action returns the integer number of domains.
getDomain
This action gets a domain from this face.
Parameters
index | This required parameter is the integer index of the domain to get in the range [1, number of domains]. |
Returns
This action returns a pw::Domain object.
addDomain
$face addDomain ?-linkage linkage? domain |
This action adds a domain to this face.
Parameters
-linkage linkage | This optional parameter is the linkage to use when adding. The default is the first found. |
domain | This required parameter is the pw::Domain object to add. |
See Also
getLinkages, mapLinkage
Returns
This action returns nothing.
removeLastDomain
This action removes the last domain added to this face.
Parameters
none
Returns
This action returns nothing.
findDomain
This action finds the given domain in this face’s domain list.
Parameters
domain | This required parameter is the pw::Domain object to locate. |
Returns
This action returns the integer index of the domain in the domain list, or 0 if the domain was not found.
getDomainOrientation
$face getDomainOrientation index |
This action gets the orientation of a domain in this face.
Parameters
index | This required parameter is the integer index of the domain of which to get the orientation in the range [1, number of domains]. |
Returns
This action returns a string with options < Same | Opposite >.
getEdgeCount
This action gets the number of edges in this face.
Parameters
none
Returns
This action returns the integer number of edges.
getEdge
This action gets an edge from this face.
Parameters
index | This required parameter is the integer index of the edge to get in the range [1, number of edges]. |
Returns
This action returns a pw::Edge object.
getEdges
This action gets all edges from this face.
Parameters
This action has no parameters.
Returns
This action returns a pw::Edge object list.
findEdge
This action finds the given edge in this face’s edge list.
Parameters
edge | This required parameter is the pw::Edge object to locate. |
Returns
This action returns the integer index of the edge in the edge list, or 0 if the edge was not found.
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).
mapLinkage
$face mapLinkage linkage domain |
This action maps a domain linkage to the face edges.
Parameters
linkage | This required parameter is the linkage array returned by the getLinkages function. |
domain | This required parameter is the pw::Domain for which the linkage is valid. |
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.