Face
A geometry face entity.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create geometry which contains faces cuboid = project.Contents.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 TopologyEntity object.
Usage locations
The Face object can be accessed from the following locations:
- Properties
- WorkSurface object has property ReferenceFace.
- WaveguidePort object has property Face.
- Methods
- FaceCollection collection has method Item(number).
- FaceCollection collection has method Item(string).
Property List
- BasisFunctionSettings
- Local basis function solver settings for the face. (Read/Write BasisFunctionLocalSolverSettings)
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- CentreOfGravity
- A point indicating the centre of gravity of this entity. (Read only Point)
- CharacterisedSurfaceReferenceDirection
- Reference direction of the coating. (Read/Write ReferenceDirection)
- 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)
- CoatingThickness
- The thickness of the coaitng. (Read/Write ParametricExpression)
- FaceAbsorbingSettings
- The face absorption, reflection and transmission properties with regards to rays. Only applies if the SolutionMethod is set to RLGO. (Read/Write RLGOFaceAbsorbingSettings)
- Faulty
- Indicates whether the geometry entity has faults. (Read only boolean)
- Geometry
- The geometry operator that the region belongs to. (Read only Geometry)
- IntegralEquation
- The type of integral equation for perfectly conducting metallic surfaces. Only applies when SolutionMethod is set to None. (Read/Write IntegralEquationTypeEnum)
- Label
- The object label. (Read/Write string)
- LocalMeshSize
- The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write ParametricExpression)
- LocalMeshSizeEnabled
- Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean)
- Medium
- The face medium. (Read/Write Medium)
- SolutionMethod
- The local solution method used for the face. (Read/Write FaceSolutionMethodEnum)
- SurfaceCoatingType
- The surface coating type for the face. (Read/Write SurfaceCoatingTypeEnum)
- Thickness
- The face medium thickness. Only applies when the Medium is defined as a Metallic. (Read/Write ParametricExpression)
- 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/Write WindscreenSolutionMethod)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object 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.)
- SetProperties (properties Object)
- 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- BasisFunctionSettings
- Local basis function solver settings for the face.
- Type
- BasisFunctionLocalSolverSettings
- Access
- Read/Write
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- CentreOfGravity
- A point indicating the centre of gravity of this entity.
- Type
- Point
- Access
- Read only
- CharacterisedSurfaceReferenceDirection
- Reference direction of the coating.
- Type
- ReferenceDirection
- Access
- Read/Write
- 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
- Read/Write
- CoatingEnabled
- Specifies if a coating should be applied to the face.
- Type
- boolean
- Access
- Read/Write
- CoatingThickness
- The thickness of the coaitng.
- Type
- ParametricExpression
- Access
- Read/Write
- FaceAbsorbingSettings
- The face absorption, reflection and transmission properties with regards to rays. Only applies if the SolutionMethod is set to RLGO.
- Type
- RLGOFaceAbsorbingSettings
- Access
- Read/Write
- Faulty
- Indicates whether the geometry entity has faults.
- Type
- boolean
- Access
- Read only
- Geometry
- The geometry operator that the region belongs to.
- Type
- Geometry
- Access
- Read only
- IntegralEquation
- The type of integral equation for perfectly conducting metallic surfaces. Only applies when SolutionMethod is set to None.
- Type
- IntegralEquationTypeEnum
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalMeshSize
- The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- LocalMeshSizeEnabled
- Specifies if the local mesh size should be used for the wire/edge.
- Type
- boolean
- Access
- Read/Write
- Medium
- The face medium.
- Type
- Medium
- Access
- Read/Write
- SolutionMethod
- The local solution method used for the face.
- Type
- FaceSolutionMethodEnum
- Access
- Read/Write
- SurfaceCoatingType
- The surface coating type for the face.
- Type
- SurfaceCoatingTypeEnum
- Access
- Read/Write
- Thickness
- The face medium thickness. Only applies when the Medium is defined as a Metallic.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Windscreen
- The windscreen solution method settings for the face. Only applies if the SolutionMethod is set to Windscreen.
- Type
- WindscreenSolutionMethod
- Access
- Read/Write
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- 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 table defining the properties.
- SetProperties (properties Object)
- 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(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.