BH.oM.Structure.Elements.IAreaElement¶
Base interface for 2D analytical elements such as Panels, FEMeshes and Surfaces to represent, for example, walls and slabs.
Interface structure¶
Implemented interfaces and base types¶
The IAreaElement is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Dimensional.IElementM
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Structure.Elements.FEMesh
- BH.oM.Structure.Elements.PadFoundation
- BH.oM.Structure.Elements.Panel
- BH.oM.Structure.Elements.Surface
Properties¶
Defining properties¶
The following properties are defined on the interface
Name | Type | Description | Quantity |
---|---|---|---|
Property | ISurfaceProperty | Defines the thickness property and material of the Element. | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
ElementEmbodiedCarbon | List<IElementResult<MaterialResult>> | Evaluates the embodied carbon on the provided element based on IStructE methodology of evaluation. If you would like to evaluate other EPD metrics, please use one of the Query.EnvironmentalResults methods. TemplateMaterials can be provided helping with picking the correct EPD corresponding to each material on the element. Please note that this evaluation method only support mass-based EPDs. |
- | LifeCycleAssessment_Engine |
ElementEnvironmentalMetrics | List<List<EnvironmentalMetric>> | Query the Environmental Product Declarations from any IElementM with a MaterialComposition composed of IEPD materials. | - | LifeCycleAssessment_Engine |
ElementEpds | List<EnvironmentalProductDeclaration> | Query the Environmental Product Declarations from any IElementM with a MaterialComposition composed of IEPD materials. | - | LifeCycleAssessment_Engine |
ElementMaterialNames | List<string> | Query the element's MaterialComposition to form a Material Hint to aid in EPD-Material Mapping. | - | LifeCycleAssessment_Engine |
ElementScope | ScopeType | Returns the enumerable type of the scope found on an element. | - | LifeCycleAssessment_Engine |
EnvironmentalResults | List<IElementResult<MaterialResult>> | Evaluates the EnvironmentalMetrics for the provided element and returns an ElementResult for each evaluated metric type. Evaluation is done by extracting the material takeoff for the provided element, giving quantities and Materiality. Each Material in the takeoff is then evaluated by finding the EnvironmentalProductDeclaration (EPD), either stored on the material or from the list of template materials. Each metric, or filtered chosen metrics, on the EPD is then evaluated. Finally, an element result is returned per metric type. Each element result being the sum result of all metrics of the same type. |
- | LifeCycleAssessment_Engine |
IArea | double | Calculates the area of an IAreaElement. | Area [m²] | Structure_Engine |
IEdges | IEnumerable<ICurve> | Extracts all the edge curves from an AreaElement. | - | Structure_Engine |
IGeneralMaterialTakeoff | GeneralMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
IIsNull | bool | Checks if an AreaElement is null and outputs relevant error message. | - | Structure_Engine |
IMaterialComposition | MaterialComposition | Gets the unique Materials along with their relative proportions defining an object's make-up. | - | Matter_Engine |
INormal | Vector | Returns the local z-axis of the IAreaElement. | - | Structure_Engine |
IPointGrid | List<Point> | Generates a rectangular grid of points on an IAreaElement. Used for load visualisation. | - | Structure_Engine |
ISolidVolume | double | Returns an element's solid volume, i.e. the the volume of the element that had any materiality, excluding cavities, openings and voids. | Volume [m³] | Matter_Engine |
IVolumetricMaterialTakeoff | VolumetricMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
Mass | double | Evaluates the mass of an object based its VolumetricMaterialTakeoff and Density. | Mass [kg] | Matter_Engine |
MaterialComposition | MaterialComposition | Returns an AreaElement's homogeneous MaterialComposition. | - | Structure_Engine |
QuantityTypes | List<QuantityType> | Query the QuantityType values from any IElementM object's MaterialComposition. | - | LifeCycleAssessment_Engine |
SolidVolume | double | Returns a IAreaElement's solid volume as the area of the element times the average thickness of its SurfaceProperty. The average thickness is evaluated as if it was applied to an infinite plane. | Volume [m³] | Structure_Engine |
Code and Schema¶
C# implementation¶
C#
public interface IAreaElement : BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Dimensional.IElementM
Assembly: Structure_oM.dll
The C# interface 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/IAreaElement.json"
}
The JSON Schema is available on github here: