An unstructured face is a collection of edge-connected pw::Domain objects that are used to build watertight boundaries of unstructured blocks. Unstructured faces cannot persist without a block.
pw:: | An unstructured face is a collection of edge-connected pw::Domain objects that are used to build watertight boundaries of unstructured blocks. |
Static Actions | |
create | This action creates a new unstructured face object. |
createFromDomains | This command creates new unstructured face objects from the given domains. |
Static Attributes | |
MaximumBendAngle | This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum. |
replaceDomain | This action replaces an existing domain in all unstructured faces with another domain. |
Instance Actions | |
getNormalOrientation | This action gets the orientation of the face normals. |
setNormalOrientation | This action sets the orientation of the face normals. |
getAdjacentDomains | This action gets domains adjacent to a face. |
setBaffle | This action designates the face as a baffle or non-baffle face. |
isBaffle | This action returns true if the face is a baffle face. |
swapDomain | This action replaces an existing domain in the face with another domain that is not in the face. |
pw::FaceUnstructured create
This action creates a new unstructured face object.
none
This action returns a new pw::FaceUnstructured object.
pw::FaceUnstructured createFromDomains ?-single? domains
This command creates new unstructured 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 block is created for each domain. |
domains | This required parameter is a list of pw::Domain 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::FaceUnstructured.create and pw::Face.addDomain commands) to build the face in a controlled manner.
This action returns a list of new pw::FaceUnstructured objects.
pw::FaceUnstructured get/setMaximumBendAngle angle
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
A float in the range [0.0, 180.0).
0.0
pw::FaceUnstructured replaceDomain $olddom $newdom
This action replaces an existing domain in all unstructured faces with another domain. The domains can be of different types.
olddom | This required parameter is expected to be a pw::Domain object that is contained in the face. |
newdom | This required parameter is expected to be a pw::Domain object that is currently not in the face and will replace all occurrences of the old domain in the face. |
This action returns a list of pw::FaceUnstructured objects that were modified.
$face getNormalOrientation
This action gets the orientation of the face normals.
none
This action returns a string with options < In | Out | Unknown >.
$face setNormalOrientation direction
This action sets the orientation of the face normals.
direction | This required parameter is the string direction of the normals with options < In | Out >. |
This action returns the resulting direction.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-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 indicates to restrict results to manifold domains (only 2 domains sharing a common connector). |
-maximumAngle angle | This optional paramter specifies the maximum angle allowed between a domain and the face for the domain to be included. |
-nopoles | This optional flag will exclude any domains that contain pole connectors. |
-type option | This optional parameter indicates to restrict the domain types returned. Valid options are Structured, Unstructured, or Both (default). |
-visibleOnly | This optional flag, if present, restricts the results to only visible domains. |
This action returns a list of pw::Domain adjacent to the face.
$face setBaffle value
This action designates the face as a baffle or non-baffle face.
value | This required boolean parameter sets whether or not the face is a baffle face. |
This action returns nothing.
$face isBaffle
This action returns true if the face is a baffle face.
none
This action returns a boolean value of true if the face is a baffle face or false if the face is a non-baffle face.
$face swapDomain $olddom $newdom
This action replaces an existing domain in the face with another domain that is not in the face. The domains can be of different types.
olddom | This required parameter is expected to be a pw::Domain object that is contained in the face. |
newdom | This requried parameter is expected to be a pw::Domain object that is currently not in the face and will replace all occurrences of the old domain. |
This action returns a boolean set to true if the domain was swapped.
This action creates a new unstructured face object.
pw::FaceUnstructured create
This command creates new unstructured face objects from the given domains.
pw::FaceUnstructured createFromDomains ?-single? domains
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
pw::FaceUnstructured get/setMaximumBendAngle angle
This action replaces an existing domain in all unstructured faces with another domain.
pw::FaceUnstructured replaceDomain $olddom $newdom
This action gets the orientation of the face normals.
$face getNormalOrientation
This action sets the orientation of the face normals.
$face setNormalOrientation direction
This action gets domains adjacent to a face.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-visibleOnly?
This action designates the face as a baffle or non-baffle face.
$face setBaffle value
This action returns true if the face is a baffle face.
$face isBaffle
This action replaces an existing domain in the face with another domain that is not in the face.
$face swapDomain $olddom $newdom
This action adds a face to the block.
$block addFace face
This action adds a domain to this face.
$face addDomain ?-linkage linkage? domain