BH.oM.MEP.System.FlowSystem¶
A collection of IFlow Objects to be utilised throughout a defined system.
Class structure¶
Implemented interfaces and base types¶
The FlowSystem 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.Dimensional.IElement1D
- BH.oM.Dimensional.IElement
- BH.oM.Dimensional.IElementM
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| FlowObjects | List<IFlow> | A collection of FlowObjects to compile within a specified systemType. | - |
| SystemType | ISystemType | A specific system type to be applied to the flow objects. The system type describes the material conveyed by the system (supply air, cold water), therefore determining the behaviours of the system | - |
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 |
|---|---|---|---|---|
| Bounds | BoundingBox | Queries the IElement1Ds BoundingBox. Acts on the ICurve definition of the IElement1D through the Geometry_Engine. | - | Spatial_Engine |
| Centroid | Point | Queries the centre of weight for a IElement1Ds ICurve representation. | - | Spatial_Engine |
| ControlPoints | List<Point> | Queries the control points of the one dimensional representation of the IElement1D. | - | Spatial_Engine |
| DominantVector | Vector | Gets the the dominant vector (orientation) of an Element1D based on its lines lengths. | - | Spatial_Engine |
| ElementCurves | List<ICurve> | Queries the defining curves of an IElement1D. | - | Spatial_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 |
| ElementVertices | List<Point> | Returns the discontinuity points from the defining ICurve of the IElement1D. | - | Spatial_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 | Queries the area of the geometrical representation of an IElement. | Area [m²] | Spatial_Engine |
| IBounds | BoundingBox | Queries the IElements BoundingBox. Acts on the elements geometrical definition of the IElement through the Geometry_Engine. | - | Spatial_Engine |
| ICentroid | Point | Queries the centre of weight for the homogeneous geometrical representation of an IElement. | - | Spatial_Engine |
| IControlPoints | List<Point> | Queries the control points of the geometrical representation of an IElement. | - | Spatial_Engine |
| IElementCurves | List<ICurve> | Queries the geometricly defining curves of the IElements geometry. | - | Spatial_Engine |
| IElements0D | List<IElement0D> | Queries the IElement0Ds from a IElement1D. Returns null if no IElement0Ds are defined for the type of IElement1D. | - | Spatial_Engine |
| IElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement. | - | Spatial_Engine |
| IGeneralMaterialTakeoff | GeneralMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
| IGeometry | ICurve | Queries the defining geometrical object which all spatial operations will act on. | - | Spatial_Engine |
| IIsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
| IIsSelfIntersecting | bool | Checks if any of the curves defining an IElement is closer to itself than the tolerance at any two points (is self intersecting). In case of IElement2D, does not check for intersections between external and internal curves, or between different internal curves. | - | Spatial_Engine |
| IMaterialComposition | MaterialComposition | Gets the unique Materials along with their relative proportions defining an object's make-up. | - | Matter_Engine |
| IPrimaryPropertyName | string | Returns the name of an elements primary defining property | - | Facade_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 |
| IsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
| IsSelfIntersecting | bool | Checks if the one dimensional representation of the IElement1D is closer to itself than the tolerance at any two points. | - | Spatial_Engine |
| IVolumetricMaterialTakeoff | VolumetricMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
| Length | double | Returns the length of the IElement1Ds curve. | Length [m] | Spatial_Engine |
| Mass | double | Evaluates the mass of an object based its VolumetricMaterialTakeoff and Density. | Mass [kg] | Matter_Engine |
| QuantityTypes | List<QuantityType> | Query the QuantityType values from any IElementM object's MaterialComposition. | - | LifeCycleAssessment_Engine |
Code and Schema¶
C# implementation¶
C#
public class FlowSystem : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Dimensional.IElement1D,
BH.oM.Dimensional.IElement,
BH.oM.Dimensional.IElementM
Assembly: MEP_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/MEP_oM/System/FlowSystem.json"
}
The JSON Schema is available on github here: