Skip to content

BH.oM.Structure.Elements.RetainingWall

Class structure

Implemented interfaces and base types

The RetainingWall 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
Stem Stem Stem of the retaining wall. -
Footing PadFoundation Footing of the retaining wall. -
RetainedHeight double The retained height of soil measured from the bottom of the wall Footing. -
CoverDepth double The distance from top of Footing to finished floor level on the exposed face. -
RetentionAngle double A property of the material being retained measured from the horizontal plane. Angle [rad]
GroundWaterDepth double The distance from the base of the Footing to ground water level. -

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
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
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
Geometry IGeometry Gets the geometry of a RetainingWall. Method required for automatic display in UI packages. - Structure_Engine
Geometry3D IGeometry Gets a CompositeGeometry made of the Stem and Footing of a RetainingWall. - Structure_Engine
IGeneralMaterialTakeoff GeneralMaterialTakeoff Gets the unique Materials along with their volumes defining an object's make-up. - Matter_Engine
IMaterialComposition MaterialComposition Gets the unique Materials along with their relative proportions defining an object's make-up. - Matter_Engine
IsNull bool Checks if a RetainingWall is 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
IsValid bool Checks if a RetainignWall is valid by verifying that the Stem does not intersect the footing. - Structure_Engine
IVolumetricMaterialTakeoff VolumetricMaterialTakeoff Gets the unique Materials along with their volumes defining an object's make-up. - Matter_Engine
Mass double Evaluates the mass of an object based its VolumetricMaterialTakeoff and Density. Mass [kg] Matter_Engine
MaterialComposition MaterialComposition Returns a RetainingWall's homogeneous MaterialComposition based on the Stem and Footing. - Structure_Engine
QuantityTypes List<QuantityType> Query the QuantityType values from any IElementM object's MaterialComposition. - LifeCycleAssessment_Engine
SolidVolume double Returns a RetainingWall's solid volume based on the Stem and Footing volumes. Volume [m³] Structure_Engine

Code and Schema

C# implementation

C#
public class RetainingWall : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Dimensional.IElementM

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

The JSON Schema is available on github here: