BH.oM.Structure.Results.BarStrain¶
Resulting axial strain along the bar in local coordinates.
Class structure¶
Implemented interfaces and base types¶
The BarStrain is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Structure.Results.BarResult
- BH.oM.Structure.Results.IStructuralResult
- BH.oM.Analytical.Results.IObjectIdResult
- BH.oM.Analytical.Results.IResult
- BH.oM.Base.IObject
- IComparable<BH.oM.Analytical.Results.IResult>
- BH.oM.Base.IImmutable
- BH.oM.Analytical.Results.ICasedResult
- BH.oM.Analytical.Results.ITimeStepResult
- BH.oM.Analytical.Results.IElement1DResult
- BH.oM.Analytical.Results.IResultItem
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Axial | double | Axial strain induced by an axial force along the Bar axis. Positive for elongation, negative for contraction. | Strain [-] |
ShearY | double | Shear strain along the local y-axis. Generally minor axis shear strain. | Strain [-] |
ShearZ | double | Shear strain along the local z-axis. Generally major axis shear strain. | Strain [-] |
BendingY_Top | double | Strain induced by bending about the local y-axis at the 'uppermost' extreme fiber. Generally the major axis bending strains in one of the extreme fibers. | Strain [-] |
BendingY_Bot | double | Strain induced by bending about the local y-axis at the 'lowermost' extreme fiber. Generally the major axis bending strains in one of the extreme fibers. | Strain [-] |
BendingZ_Top | double | Strain induced by bending about the local z-axis at the 'uppermost' extreme fiber. Generally the minor axis bending strains in one of the extreme fibers. | Strain [-] |
BendingZ_Bot | double | Strain induced by bending about the local z-axis at the 'lowermost' extreme fiber. Generally the minor axis bending strains in one of the extreme fibers. | Strain [-] |
CombAxialBendingPos | double | Worst case elongation (axial strain) from combined axial and bending in two directions. | Strain [-] |
CombAxialBendingNeg | double | Worst case contraction (axial strain) from combined axial and bending in two directions. | Strain [-] |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
ObjectId | IComparable | Id of the bar that this result belongs to. When extracted from an analysis package, the object id will match the format and value used in that particular package. | - |
ResultCase | IComparable | Identifier for the Loadcase or LoadCombination that the result belongs to. Is generally name or number of the loadcase, depending on the analysis package. | - |
ModeNumber | int | Positive index, starting at one. Only set for cases with modal outputs such as dynamic cases. | - |
TimeStep | double | Time step for time history results. | - |
Position | double | Position on the bar as normalised length, i.e. 0 for start, 1 for end and 0.5 for middle. | - |
Divisions | int | How many division points along the bar was used when extracting this result. This generally means that this many results with the same ObjectId, ResultCase and TimeStep was extracted. | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
Name | Type | Description | Quantity | Engine |
---|---|---|---|---|
AllIdentifierProperties | List<string> | Gets the name of all properties of the result that are of identifier types. This is all properties tagged with any IdentifierAttribute. | - | Results_Engine |
ObjectIdentifierProperties | List<string> | Gets the name of all properties of the result that are of ObjectIdentifier types. This is all properties tagged with the ObjectIdentifierAttribute. | - | Results_Engine |
ResultPropertyKeys | List<string> | Returns the result value carrying properties available for the result type provided. Currently only supported for IResultItem and IResultCollection<IResultItem> type results. | - | Results_Engine |
ScenarioIdentifierProperties | List<string> | Gets the name of all properties of the result that are of Scenario types. This is all properties tagged with the ScenarioIdentifierAttribute. | - | Results_Engine |
Code and Schema¶
C# implementation¶
C#
public class BarStrain : BH.oM.Structure.Results.BarResult,
BH.oM.Structure.Results.IStructuralResult,
BH.oM.Analytical.Results.IObjectIdResult,
BH.oM.Analytical.Results.IResult,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Analytical.Results.IResult>,
BH.oM.Base.IImmutable,
BH.oM.Analytical.Results.ICasedResult,
BH.oM.Analytical.Results.ITimeStepResult,
BH.oM.Analytical.Results.IElement1DResult,
BH.oM.Analytical.Results.IResultItem
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/Results/BarStrain.json"
}
The JSON Schema is available on github here: