# Face

A geometry face entity.

## Example

app = cf.GetApplication()
project = app:NewProject()

-- Create geometry which contains faces

cuboid = project.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)

-- Remove some faces from the cuboid

cuboid.Faces["Face1"]:Delete()
cuboid.Faces["Face4"]:Delete()
cuboid.Faces["Face6"]:Delete()

-- Rename the bottom face entity

cuboid.Faces["Face5"].Label = "BottomFace"


## Inheritance

The Face object is derived from the GeometryEntity object.

## Usage locations (object properties)

The following objects have properties using the Face object:

## Property List

BasisFunctionSettings
Local basis function solver settings for the face. (Read only BasisFunctionLocalSolverSettings)
BoundingBox
A box indicating the bounding box of this entity. (Read only Box)
CentreOfGravity
A point indicating the centre of gravity of this entity. (Read only Point)
Coating
The face coating specified by a predefined Layered dielectric medium. An electrically thin coating is applied on both sides of the face, while an electrically thick coating is applied on the normal side of the face. The face should be set up to have free space on at least one of the sides, while the other side can be free space or PEC. Changing this property will set CoatingEnabled to true. (Read/Write Medium)
CoatingEnabled
Specifies if a coating should be applied to the face. (Read/Write boolean)
FaceAbsorbingSettings
The face absorption, reflection and transmission properties with regards to rays. Only applies if the SolutionMethod is set to RLGO. (Read only RLGOFaceAbsorbingSettings)
Faulty
Indicates whether the geometry entity has faults. (Read only boolean)
IntegralEquation
The type of integral equation for perfectly conducting metallic surfaces. Only applies when SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum)
Label
LocalMeshSize
The local mesh size for the face. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write Expression)
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the face. (Read/Write boolean)
Medium
Part
The geometry operator that the face belongs to. (Read only Geometry)
ReferenceDirection
The reference direction used to define the principle direction. Only applies when the Medium is defined as a LayeredAnisotropicDielectric. (Read only ReferenceDirection)
SolutionMethod
The local solution method used for the face. (Read/Write FaceSolutionMethodEnum)
SurfaceCoatingType
The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum)
Suspect
Indicates whether the geometry entity is suspect. (Read only boolean)
Thickness
The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write Expression)
Type
The object type string. (Read only string)
Windscreen
The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to Windscreen. (Read only WindscreenSolutionMethod)

## Method List

Delete ()
Delete the face.
Duplicate ()
Create a duplicate of the face as a new geometry operator. (Returns a Geometry object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
ReverseNormal ()
Reverse the face normal.
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
ShortestDistanceTo (point Point)
Find the shortest distance between this face and the given point. (Returns a number object.)

## Property Details

BasisFunctionSettings
Local basis function solver settings for the face.
Type
BasisFunctionLocalSolverSettings
Access
BoundingBox
A box indicating the bounding box of this entity.
Type
Box
Access
CentreOfGravity
A point indicating the centre of gravity of this entity.
Type
Point
Access
Coating
The face coating specified by a predefined Layered dielectric medium. An electrically thin coating is applied on both sides of the face, while an electrically thick coating is applied on the normal side of the face. The face should be set up to have free space on at least one of the sides, while the other side can be free space or PEC. Changing this property will set CoatingEnabled to true.
Type
Medium
Access
CoatingEnabled
Specifies if a coating should be applied to the face.
Type
boolean
Access
FaceAbsorbingSettings
The face absorption, reflection and transmission properties with regards to rays. Only applies if the SolutionMethod is set to RLGO.
Type
RLGOFaceAbsorbingSettings
Access
Faulty
Indicates whether the geometry entity has faults.
Type
boolean
Access
IntegralEquation
The type of integral equation for perfectly conducting metallic surfaces. Only applies when SolutionMethod is set to None.
Type
IntegralEquationTypeEnum
Access
Label
The object label.
Type
string
Access
LocalMeshSize
The local mesh size for the face. Changing this property will set LocalMeshSizeEnabled to true.
Type
Expression
Access
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the face.
Type
boolean
Access
Medium
The face medium.
Type
Medium
Access
Part
The geometry operator that the face belongs to.
Type
Geometry
Access
ReferenceDirection
The reference direction used to define the principle direction. Only applies when the Medium is defined as a LayeredAnisotropicDielectric.
Type
ReferenceDirection
Access
SolutionMethod
The local solution method used for the face.
Type
FaceSolutionMethodEnum
Access
SurfaceCoatingType
The surface coating type for the face.
Type
SurfaceCoatingTypeEnum
Access
Suspect
Indicates whether the geometry entity is suspect.
Type
boolean
Access
Thickness
The face medium thickness. Only applies when the Medium is defined as a Metallic.
Type
Expression
Access
Type
The object type string.
Type
string
Access
Windscreen
The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to Windscreen.
Type
WindscreenSolutionMethod
Access

## Method Details

Delete ()
Delete the face.
Duplicate ()
Create a duplicate of the face as a new geometry operator.
Return
Geometry
The geometry operator containing the duplicated face.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
ReverseNormal ()
Reverse the face normal.
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.
ShortestDistanceTo (point Point)
Find the shortest distance between this face and the given point.
Input Parameters
point(Point)
The point to query against.
Return
number
The shortest distance between the given point and this face.