Skip to content

BH.oM.Structure.Results.GlobalReactions

Total global reactions for a given Loadcase or LoadCombination.

Class structure

Implemented interfaces and base types

The GlobalReactions is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
FX double Total force in the global X-direction. Force [N]
FY double Total force in the global Y-direction. Force [N]
FZ double Total force in the global Z-direction. Force [N]
MX double Total moment about the global X-axis. Moment [N.m]
MY double Total moment about the global Y-axis. Moment [N.m]
MZ double Total moment about the global Z-axis. Moment [N.m]

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
ObjectId IComparable Id of the structure. Unused for many results. -
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. -

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
FTotal double Gets the resolved reaction force of the three components of the result. Force [N] Structure_Engine
MTotal double Gets the resolved reaction moment of the three components of the result. Moment [N.m] Structure_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 GlobalReactions : BH.oM.Structure.Results.StructuralGlobalResult,
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.IResultItem,
BH.oM.Structure.Results.IReaction

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/GlobalReactions.json"
}

The JSON Schema is available on github here: