BH.oM.Structure.Elements.Bar¶
1D finite element for structural analysis. Linear 2-noded element defined by a start and end node.For structural conventions and orientation of the bar please see the documentation.
Class structure¶
Implemented interfaces and base types¶
The Bar 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
- BH.oM.Analytical.Elements.ILink<BH.oM.Structure.Elements.Node>
- BH.oM.Analytical.IAnalytical
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Start | Node | Defines the start position of the element. Note that Nodes can contain Supports which should not be confused with Releases. | - |
End | Node | Defines the end position of the element. Note that Nodes can contain Supports which should not be confused with Releases. | - |
SectionProperty | ISectionProperty | Section property of the bar, containing all sectional constants and material as well as profile geometry and dimensions, where applicable. | - |
OrientationAngle | double | Controls the local axis orientation of the bar For non-vertical members the local z is aligned with the global Z and rotated with the orientation angle about the local x. For vertical members the local y is aligned with the global Y and rotated with the orientation angle about the local x. A bar is vertical if its projected length to the horizontal plane is less than 0.0001, i.e. a tolerance of 0.1mm on verticality. For general structural conventions please see the documentation. |
Angle [rad] |
Release | BarRelease | Defines the start and end release of the Bar. The releases defines how the bar is attached to its end nodes. If not set, full fixity will be assumed. | - |
FEAType | BarFEAType | - | - |
Support | Constraint4DOF | Linear support for the bar. Three translational degrees of freedom and one rotational. The rotational DOF defines constraint about the axis of the bar. | - |
Offset | Offset | Offset of the bar as two vectors, one per end node, in bar local coordinates. Defines offsets from centreline to be applied in analysis packages. | - |
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 |
---|---|---|---|---|
AutoLengthOffset | AutoLengthOffset | - | - | ETABS_Engine |
BarAutoMesh | BarAutoMesh | Returns the SAP2000 BarAutoMesh settings for a bar. You can also use the method FindFragment() with the type BarAutoMesh as an argument. | - | SAP2000_Engine |
BarDesignProcedure | BarDesignProcedure | Returns the SAP2000 BarDesignProcedure settings for a bar. You can also use the method FindFragment() with the type BarDesignProcedure as an argument. | - | SAP2000_Engine |
BarInsertionPoint | BarInsertionPointLocation | Returns the SAP2000 BarInsertionPointLocation settings for a bar. You can also use the method FindFragment() with the type BarInsertionPoint as an argument. | - | SAP2000_Engine |
BarModifyStiffnessInsertionPoint | bool | Checks if SAP2000 is set to modify the stiffness of a bar based on its insertion point. You can also use the method FindFragment() with the type BarInsertionPoint as an argument, and check the ModifyStiffness property of that fragment. | - | SAP2000_Engine |
BarSectionTranformation | TransformMatrix | Constructs the transformation matrix needed to move the section curves of the Bar from the default drawing position around the global origin to the start of the Bar and aligned with its tangent. | - | Structure_Engine |
Bounds | BoundingBox | Queries the IElement1Ds BoundingBox. Acts on the ICurve definition of the IElement1D through the Geometry_Engine. | - | Spatial_Engine |
CellularOpeningCurves | List<ICurve> | Distributes a series of cellular openings along the centreline of the bar centreline. Method will fit in as many openings along the curve as it can, starting from the start of the curve. An empty list is returned if the bar does not contain a cellular section. |
- | Structure_Engine |
Centreline | Line | Returns the centreline of the Bar as the line between the StratNode and EndNode. No offsets or similar is accounted for. | - | Structure_Engine |
Centroid | Point | Queries the centre of weight for a IElement1Ds ICurve representation. | - | Spatial_Engine |
CheckFlipBar | bool | Evaluates if the Bar would have its endpoints flipped on Push to ETABS in ETABS16. | - | ETABS_Engine |
ControlPoints | List<Point> | Queries the control points of the one dimensional representation of the IElement1D. | - | Spatial_Engine |
CoordinateSystem | Cartesian | Get the carteseian coordinate system descibring the position and local orientation of the Bar in the global coordinate system where the Bar tangent is the local x-axis and the normal is the local z-axis. | - | Structure_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 |
Extrude | List<IGeometry> | Computes an extrusion of the section along the Bar centreline. | - | Structure_Engine |
Geometry3D | IGeometry | Gets the BH.oM.Geometry.Extrusion out of the Bar as its Geometry3D. | - | Structure_Engine |
HasReinforcement | bool | Returns true if the Bar has a ConcreteSection with BarRebarIntent defined with at least one IBarReinforcement in it. False if the Bar, ConcreteSection or BarRebarIntent is null or the IBarReinforcement count is zero. | - | Structure_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 |
InsertionPoint | BarInsertionPoint | - | - | ETABS_Engine |
IPrimaryPropertyName | string | Returns the name of an elements primary defining property | - | Facade_Engine |
IsNull | bool | Checks if a Bar or its defining properties are null and outputs relevant error message. | - | 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 |
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 |
IsVertical | bool | Checks if a Bar is vertical. A Bar is vertical if its projected length to the horizontal plane is less than 0.0001, i.e. a tolerance of 0.1mm on verticality. For general structural conventions please see the documentation. |
- | Structure_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 | Calculates the mass of a Bar as its solid volume (generally taken as length times section area) times density(ies) of its material. No offsets or similar are taken into account. | Mass [kg] | Structure_Engine |
Mass | double | Evaluates the mass of an object based its VolumetricMaterialTakeoff and Density. | Mass [kg] | Matter_Engine |
MaterialComposition | MaterialComposition | Returns a Bar's homogeneous MaterialComposition. | - | Structure_Engine |
ModifyStiffnessInsertionPoint | bool | - | - | ETABS_Engine |
Normal | Vector | Returns the bars local z-axis, generally the major axis direction of the section of the Bar. For non - vertical members the local z-axis is aligned with the global Z-axis and rotated with the orientation angle around the local x-axis. For vertical members the local y-axis is aligned with the global Y-axis and rotated with the orientation angle around the local x-axis. For this case the normal will be the vector orthogonal to the local x-axis and local y-axis. |
- | Structure_Engine |
QuantityTypes | List<QuantityType> | Query the QuantityType values from any IElementM object's MaterialComposition. | - | LifeCycleAssessment_Engine |
ReinforcementLayout | List<ICurve> | Gets all the reinforcement centrelines in the Bar as a list of Curves. | - | Structure_Engine |
ReinforcingBars | List<IReinforcingBar> | Extract all physical ReinforcingBars from the structural Bar. Only extracts reinforcement for bars owning a ConcreteSection, for other section types, an empty list will be returned. | - | Structure_Engine |
SolidVolume | double | Returns a Bar's solid volume based on its SectionProperty area and the CentreLine length. | Volume [m³] | Structure_Engine |
Tangent | Vector | Gets the tangent Vector of a Bar as the direction Vector from StartNode to EndNode. No offsets or similar are taken into account. | - | Structure_Engine |
Code and Schema¶
C# implementation¶
public class Bar : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Dimensional.IElement1D,
BH.oM.Dimensional.IElement,
BH.oM.Dimensional.IElementM,
BH.oM.Analytical.Elements.ILink<BH.oM.Structure.Elements.Node>,
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.
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Structure_oM/Elements/Bar.json"
}
The JSON Schema is available on github here:
Example JSON instance¶
Example JSON instance of type Bar.
{
"_t": "BH.oM.Structure.Elements.Bar",
"Start": {
"_t": "BH.oM.Structure.Elements.Node",
"Position": {
"_t": "BH.oM.Geometry.Point",
"X": -4.0,
"Y": 1.0,
"Z": 0.0
},
"Orientation": null,
"Support": null,
"BHoM_Guid": "fbee2fad-dc9d-4b72-a99a-a1ac31c1190e",
"Name": ""
},
"End": {
"_t": "BH.oM.Structure.Elements.Node",
"Position": {
"_t": "BH.oM.Geometry.Point",
"X": -1.0,
"Y": 1.0,
"Z": 0.0
},
"Orientation": null,
"Support": null,
"BHoM_Guid": "9794ca28-2d94-405d-8326-407951c07771",
"Name": ""
},
"SectionProperty": {
"_t": "BH.oM.Structure.SectionProperties.ConcreteSection",
"Name": "",
"RebarIntent": null,
"Material": {
"_t": "BH.oM.Structure.MaterialFragments.Concrete",
"Name": "C30/37",
"Density": 2548.5376999999999,
"DampingRatio": 0.0,
"PoissonsRatio": 0.20000000000000001,
"ThermalExpansionCoeff": 1.0000000000000001E-05,
"YoungsModulus": 33000000000.0,
"CylinderStrength": 30000000.0,
"CubeStrength": 37000000.0,
"BHoM_Guid": "647d6ed4-4a60-4f7d-b7a1-4d13fa15b04a"
},
"SectionProfile": {
"_t": "BH.oM.Spatial.ShapeProfiles.CircleProfile",
"Shape": "Circle",
"Diameter": 0.5,
"Edges": [
{
"_t": "BH.oM.Geometry.Circle",
"Centre": {
"_t": "BH.oM.Geometry.Point",
"X": 0.0,
"Y": 0.0,
"Z": 0.0
},
"Normal": {
"_t": "BH.oM.Geometry.Vector",
"X": 0.0,
"Y": 0.0,
"Z": 1.0
},
"Radius": 0.25
}
],
"BHoM_Guid": "4877fe63-23c7-45f2-81b1-f8c7b4894014",
"Name": ""
},
"Area": 0.19634954084936207,
"Rgy": 0.125,
"Rgz": 0.125,
"J": 0.0061359231515425647,
"Iy": 0.0030679615757712823,
"Iz": 0.0030679615757712823,
"Iw": 0.0,
"Wely": 0.012271846303085129,
"Welz": 0.012271846303085129,
"Wply": 0.020833333333333332,
"Wplz": 0.020833333333333332,
"CentreZ": 0.0,
"CentreY": 0.0,
"Vz": 0.25,
"Vpz": 0.25,
"Vy": 0.25,
"Vpy": 0.25,
"Asy": 0.1768018468995684,
"Asz": 0.1768018469014255,
"BHoM_Guid": "c7a0ddf9-af63-482a-8de2-3dc9e906788c"
},
"OrientationAngle": 0.0,
"Release": {
"_t": "BH.oM.Structure.Constraints.BarRelease",
"Name": "FixFix",
"StartRelease": {
"_t": "BH.oM.Structure.Constraints.Constraint6DOF",
"Name": "Fix",
"TranslationalStiffnessX": 0.0,
"TranslationalStiffnessY": 0.0,
"TranslationalStiffnessZ": 0.0,
"RotationalStiffnessX": 0.0,
"RotationalStiffnessY": 0.0,
"RotationalStiffnessZ": 0.0,
"TranslationX": "Fixed",
"TranslationY": "Fixed",
"TranslationZ": "Fixed",
"RotationX": "Fixed",
"RotationY": "Fixed",
"RotationZ": "Fixed",
"BHoM_Guid": "ae2f65d1-a2f2-4c17-8c38-b353e2bba03d"
},
"EndRelease": {
"_t": "BH.oM.Structure.Constraints.Constraint6DOF",
"Name": "Fix",
"TranslationalStiffnessX": 0.0,
"TranslationalStiffnessY": 0.0,
"TranslationalStiffnessZ": 0.0,
"RotationalStiffnessX": 0.0,
"RotationalStiffnessY": 0.0,
"RotationalStiffnessZ": 0.0,
"TranslationX": "Fixed",
"TranslationY": "Fixed",
"TranslationZ": "Fixed",
"RotationX": "Fixed",
"RotationY": "Fixed",
"RotationZ": "Fixed",
"BHoM_Guid": "da939579-bc56-456d-ac2c-987179c64d9b"
},
"BHoM_Guid": "6f72abaa-c583-449d-890b-735c5b1e5b8d"
},
"FEAType": "Flexural",
"Support": null,
"Offset": null,
"BHoM_Guid": "c617ccbc-2c1e-466e-a255-06a1d36f0dc7",
"Name": "Bar Name",
"_bhomVersion": "8.2"
}