Skip to content

BH.oM.Structure.Results.NodeModalResults

Base class for all Node result classes. Stores all identifier information and how to sort the results in a collection.

Class structure

Implemented interfaces and base types

The NodeModalResults 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
UX double Translational X component of the mode shape in global coordinates. -
UY double Translational Y component of the mode shape in global coordinates. -
UZ double Translational Z component of the mode shape in global coordinates. -
RX double Rotational component about the X-axis of the mode shape in global coordinates. -
RY double Rotational component about the Y-axis of the mode shape in global coordinates. -
RZ double Rotational component about the Z-axis of the mode shape in global coordinates. -
NodalMassX double Nodal modal mass in the X-direction as defined by orientation basis. Proportional amount of the total modal mass that acts in the X-direction at the specific Node. Mass [kg]
NodalMassY double Nodal modal mass in the Y-direction as defined by orientation basis. Proportional amount of the total modal mass that acts in the Y-direction at the specific Node. Mass [kg]
NodalMassZ double Nodal modal mass in the Z-direction as defined by orientation basis. Proportional amount of the total modal mass that acts in the Z-direction at the specific Node. Mass [kg]
NodalRotationalMassX double Nodal modal mass in the X-direction as defined by orientation basis. Proportional amount of the total modal mass that acts around the X-axis at the specific Node. Mass [kg]
NodalRotationalMassY double Nodal modal mass in the Y-direction as defined by orientation basis. Proportional amount of the total modal mass that acts around the X-axis at the specific Node. Mass [kg]
NodalRotationalMassZ double Nodal modal mass in the Z-direction as defined by orientation basis. Proportional amount of the total modal mass that acts around the X-axis at the specific Node. Mass [kg]
NormalisationProcedure ModalResultNormalisation States if the result has been normalised based on the Eigenvector or on the Mass. -

Inherited properties

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

Name Type Description Quantity
ObjectId IComparable Id of the node 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. -
Orientation Basis Defines the directionality of the results. Defaults to global XYZ. -

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
RTotal double Gets the total resolved rotational displacement of the three components of the result. Angle [rad] Structure_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
UTotal double Gets the total resolved translational displacement of the three components of the result. Length [m] Structure_Engine

Code and Schema

C# implementation

C#
public class NodeModalResults : BH.oM.Structure.Results.NodeResult,
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.IObjectResult,
BH.oM.Structure.Results.INodeDisplacement,
BH.oM.Structure.Results.IDisplacement,
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/NodeModalResults.json"
}

The JSON Schema is available on github here: