Skip to content

BH.oM.Structure.MaterialFragments.IMaterialFragment

Base interface for structural materials used by structural properties or as a fragment of the physical material.

Interface structure

Implemented interfaces and base types

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

Interfaces implementing this interface

The following interfaces are implementing this interface:

Classes implementing this interface

The following classes are implementing this interface:

Properties

Defining properties

The following properties are defined on the interface

Name Type Description Quantity
DampingRatio double Dynamic damping ratio, expressed as a ratio between actual damping and critical damping. For structures, typically taken as 0.02 (i.e. 2%). Ratio [-]

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
DescriptionOrName string Gets the name from a IProperty. If null or empty, a default description name is provided instead. - Structure_Engine
IDescription string Generates a default description for the IProperty, based on its properties. - Structure_Engine
IMaterialType MaterialType Gets the material type from the MaterialFragment. - Structure_Engine
IsNull bool Checks if a MaterialFragment is null and outputs relevant error message. - Structure_Engine

Code and Schema

C# implementation

C#
public interface IMaterialFragment : BH.oM.Base.IFragment,
BH.oM.Base.IObject,
BH.oM.Physical.Materials.IMaterialProperties,
BH.oM.Base.IBHoMObject,
BH.oM.Structure.IProperty,
BH.oM.Physical.Materials.IDensityProvider

Assembly: Structure_oM.dll

The C# interface 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/MaterialFragments/IMaterialFragment.json"
}

The JSON Schema is available on github here: