`Face`#

class ansys.geometry.core.designer.face.Face(id: str, surface_type: SurfaceType, body: ansys.geometry.core.designer.body.Body, grpc_client: ansys.geometry.core.connection.client.GrpcClient, is_reversed: bool = False)#

Represents a single face of a body within the design assembly.

This class synchronizes to a design within a supporting Geometry service instance.

Parameters:

idstr: Server-defined ID for the body.
surface_typeSurfaceType: Type of surface that the face forms.
bodyBody: Parent body that the face constructs.
grpc_clientGrpcClient: Active supporting Geometry service instance for design modeling.

Overview#

Methods

`normal`	Get the normal direction to the face at certain UV coordinates.
`face_normal`	Get the normal direction to the face at certain UV coordinates.
`point`	Get a point of the face evaluated at certain UV coordinates.
`face_point`	Get a point of the face evaluated at certain UV coordinates.
`create_isoparametric_curves`	Create isoparametic curves at the given proportional parameter.

Properties

`id`	Face ID.
`is_reversed`	Flag indicating if the face is reversed.
`body`	Body that the face belongs to.
`shape`	Underlying trimmed surface of the face.
`surface_type`	Surface type of the face.
`area`	Calculated area of the face.
`edges`	List of all edges of the face.
`loops`	List of all loops of the face.

Import detail#

from ansys.geometry.core.designer.face import Face

Property detail#

property Face.id: str#: Face ID.

property Face.is_reversed: bool#: Flag indicating if the face is reversed.

property Face.body: ansys.geometry.core.designer.body.Body#: Body that the face belongs to.

property Face.shape: ansys.geometry.core.shapes.surfaces.trimmed_surface.TrimmedSurface#

Underlying trimmed surface of the face.

If the face is reversed, its shape is a ReversedTrimmedSurface type, which handles the direction of the normal vector to ensure it is always facing outward.

property Face.surface_type: SurfaceType#: Surface type of the face.

property Face.area: pint.Quantity#: Calculated area of the face.

property Face.edges: beartype.typing.List[ansys.geometry.core.designer.edge.Edge]#: List of all edges of the face.

property Face.loops: beartype.typing.List[FaceLoop]#: List of all loops of the face.

Method detail#

Face.normal(u: float = 0.5, v: float = 0.5) → ansys.geometry.core.math.vector.UnitVector3D#

Get the normal direction to the face at certain UV coordinates.

Parameters:

ufloat, default: 0.5: First coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.
vfloat, default: 0.5: Second coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.

Returns:

UnitVector3D: UnitVector3D object evaluated at the given U and V coordinates. This UnitVector3D object is perpendicular to the surface at the given UV coordinates.

Notes

To properly use this method, you must handle UV coordinates. Thus, you must know how these relate to the underlying Geometry service. It is an advanced method for Geometry experts only.

Face.face_normal(u: float = 0.5, v: float = 0.5) → ansys.geometry.core.math.vector.UnitVector3D#

Get the normal direction to the face at certain UV coordinates.

Parameters:

ufloat, default: 0.5: First coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.
vfloat, default: 0.5: Second coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.

Returns:

UnitVector3D: UnitVector3D object evaluated at the given U and V coordinates. This UnitVector3D object is perpendicular to the surface at the given UV coordinates.

Notes

This method is deprecated. Use the normal method instead.

Face.point(u: float = 0.5, v: float = 0.5) → ansys.geometry.core.math.point.Point3D#

Get a point of the face evaluated at certain UV coordinates.

Parameters:

ufloat, default: 0.5: First coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.
vfloat, default: 0.5: Second coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.

Returns:

Point3D: Point3D object evaluated at the given UV coordinates.

Notes

To properly use this method, you must handle UV coordinates. Thus, you must know how these relate to the underlying Geometry service. It is an advanced method for Geometry experts only.

Face.face_point(u: float = 0.5, v: float = 0.5) → ansys.geometry.core.math.point.Point3D#

Get a point of the face evaluated at certain UV coordinates.

Parameters:

ufloat, default: 0.5: First coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.
vfloat, default: 0.5: Second coordinate of the 2D representation of a surface in UV space. The default is 0.5, which is the center of the surface.

Returns:

Point3D: Point3D object evaluated at the given UV coordinates.

Notes

This method is deprecated. Use the point method instead.

Face.create_isoparametric_curves(use_u_param: bool, parameter: float) → beartype.typing.List[ansys.geometry.core.shapes.curves.trimmed_curve.TrimmedCurve]#

Create isoparametic curves at the given proportional parameter.

Typically, only one curve is created, but if the face has a hole, it is possible that more than one curve is created.

Parameters:

use_u_parambool: Whether the parameter is the u coordinate or v coordinate. If True, it is the u coordinate. If False, it is the v coordinate.
parameterfloat: Proportional [0-1] parameter to create the one or more curves at.

Returns:

List[TrimmedCurve]: List of curves that were created.

Face#

Overview#

Import detail#

Property detail#

Method detail#

`Face`#