pw:: Face

Base class for face types

Derives From

pw::Object

Summary
Base class for face types
This action gets the calculated minimum surface edge length based on area of cells in all given faces.
This action gets the calculated maximum surface edge length based on area of cells in all given faces.
This action deletes the face.
This action gets the state of this face.
This action gets the dimensions of this face.
This action gets the number of points in this face.
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 domain in model space at the given index.
This action gets the number of cells in this face.
This action gets the indices of the given cell.
This action gets the possible ways a domain can be added to a face.
This action gets the number of domains in this face.
This action gets a domain from this face.
This action adds a domain to this face.
This action removes the last domain added to this face.
This action finds the given domain in this face’s domain list.
This action gets the orientation of a domain in this face.
This action gets the number of edges in this face.
This action gets an edge from this face.
This action finds the given edge in this face’s edge list.
This action joins the domains in this face to create a single domain.
This action gets all domains in a face.
This action maps a domain linkage to the face edges.

StaticActions

getSurfaceEdgeMinimumLength

pw::Face getSurfaceEdgeMinimumLength faces

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

Parameters

facesthis parameter is the list of faces

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

facesthis parameter is the list of faces

Returns

This action returns the float maximum surface edge length.

Instance Actions

delete

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

getState

$face getState

This action gets the state of this face.

Parameters

none

Returns

This action returns a string; Complete | Incomplete | Invalid.

getDimensions

$face getDimensions

This action gets the dimensions of this face.

Parameters

none

Returns

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

getPointCount

$face getPointCount

This action gets the number of points in this face.

Parameters

none

Returns

This action returns the number of points.

getPoint

$face getPoint index

This action gets the position of a face grid point.

Parameters

indexThis 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

-indexThis optional flag indicates to get the position at a grid point; the value is an index [1, number of points]; 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, 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

-indexThis optional flag indicates to get the position at a grid point; the value is an index [1, number of points]; this is the default option.
valueThis parameter is the value at which to get the position.

Returns

This action returns an XYZ vector.

getCellCount

$face getCellCount

This action gets the number of cells in this face.

Parameters

none

Returns

This action returns the number of cells.

getCell

$face getCell index

This action gets the indices of the given cell.

Parameters

indexThis parameter is the index of the cell to get; [1, number of cells].

Returns

This action returns a list of indices.

getLinkages

$face getLinkages domain

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

Parameters

domainThis 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 index, the connector index of the starting edge, the ending domain edge index, the connector index of the ending edge, the starting face edge index, the connector index of the starting face edge, and a boolean value specifying whether or not the orientation is reversed.

getDomainCount

$face getDomainCount

This action gets the number of domains in this face.

Parameters

none

Returns

This action returns the number of domains.

getDomain

$face getDomain index

This action gets a domain from this face.

Parameters

indexThis parameter is the index of the domain to get; [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 linkageThis optional parameter is the linkage to use when adding; the default is the first found.
domainThis parameter is the pw::Domain object to add.

Returns

This action returns nothing.

removeLastDomain

$face removeLastDomain

This action removes the last domain added to this face.

Parameters

none

Returns

This action returns nothing.

findDomain

$face findDomain domain

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

Parameters

domainThis parameter is the pw::Domain object to locate.

Returns

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

getDomainOrientation

$edge getDomainOrientation index

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

Parameters

indexThis parameter is the index of the domain of which to get the orientation with the range [1, number of domains].

Returns

This action returns a string; Same | Opposite.

getEdgeCount

$face getEdgeCount

This action gets the number of edges in this face.

Parameters

none

Returns

This action returns the number of edges.

getEdge

$face getEdge index

This action gets an edge from this face.

Parameters

indexThis parameter is the index of the edge to get; [1, number of edges].

Returns

This action returns a pw::Edge object.

findEdge

$face findEdge edge

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

Parameters

edgeThis parameter is the pw::Edge object to locate.

Returns

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

joinDomains

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

getDomains

$face getDomains

This action gets all domains in a face.

Parameters

none

Returns

This action returns a list of the domains 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

linkageThis parameter is the linkage array returned by the getLinkages function.
domainThis parameter is the domain for which the linkage is valid.

Returns

This action returns a list of 4 integers values representing in order: the edge index of the start of the linkage, the connector index of the start of the linkage, the edge index of the end of the linkage, and the connector 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.

pw::Face getSurfaceEdgeMinimumLength faces
This action gets the calculated minimum surface edge length based on area of cells in all given faces.
pw::Face getSurfaceEdgeMaximumLength faces
This action gets the calculated maximum surface edge length based on area of cells in all given faces.
$face delete
This action deletes the face.
$face getState
This action gets the state of this face.
$face getDimensions
This action gets the dimensions of this face.
$face getPointCount
This action gets the number of points in this face.
$face getPoint 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 domain in model space at the given index.
$face getCellCount
This action gets the number of cells in this face.
$face getCell index
This action gets the indices of the given cell.
$face getLinkages domain
This action gets the possible ways a domain can be added to a face.
$face getDomainCount
This action gets the number of domains in this face.
$face getDomain index
This action gets a domain from this face.
$face addDomain ?-linkage linkage? domain
This action adds a domain to this face.
$face removeLastDomain
This action removes the last domain added to this face.
$face findDomain domain
This action finds the given domain in this face’s domain list.
$edge getDomainOrientation index
This action gets the orientation of a domain in this face.
$face getEdgeCount
This action gets the number of edges in this face.
$face getEdge index
This action gets an edge from this face.
$face findEdge edge
This action finds the given edge in this face’s edge list.
$face joinDomains
This action joins the domains in this face to create a single domain.
$face getDomains
This action gets all domains in a face.
$face mapLinkage linkage domain
This action maps a domain linkage to the face edges.
Base type for all glyph types
A float is a fractional number.
Block type
An integer is a whole number.
Domain type
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
Edge type
Structured domain type
Structured domain type