BH.oM.Structure.Elements.FEMeshFace¶
Face of an FEMesh. The face is defined by the indices of its nodes in the node list. Geometrical information about position in space is stored on the host FEMesh.
Class structure¶
Implemented interfaces and base types¶
The FEMeshFace is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Analytical.Elements.IFace
- BH.oM.Analytical.IAnalytical
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
NodeListIndices | List<int> | List of which node indices in the host FEMesh node list that this face is connecting. | - |
OrientationAngle | double | Defines the angle that the local x and y axes are rotated around the normal (i.e. local z) of the FEMeshFace. The normal of the FEMeshFace is determined by the curl right hand rule dictated by the order of the node list. Local x is found by projecting the global X to the plane of the FEMeshFace and is then rotated with the OrientationAngle, except for the case when the Normal is parallel with the global X. For this case the local y is instead found by projecting global Y to the plane of the FEMeshFace and is then rotated with the OrientationAngle. The remaining local axis is determined by the right hand rule. |
Angle [rad] |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
CustomData | Dictionary<string, object> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
Geometry | Face | Gets the geometry of a analytical IFace as a geometrical Mesh's Face. A geometrical mesh face only supports 3 and 4 nodes faces, while a FEMeshFace does not have this limitation. For FEMeshFaces with more than 4 nodes or less than 3 this operation is therefore not possible. Method required for automatic display in UI packages. | - | Analytical_Engine |
IsNull | bool | Checks if an FEMeshFace or its defining properties are null and outputs relevant error message. | - | Structure_Engine |
Code and Schema¶
C# implementation¶
C#
public class FEMeshFace : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Analytical.Elements.IFace, BH.oM.Analytical.IAnalytical
Assembly: Structure_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Structure_oM/Elements/FEMeshFace.json"
}
The JSON Schema is available on github here: