BH.oM.Structure.Loads.ContourLoad¶
Load to be applied over a region defined by a closed planar Polyline.
Class structure¶
Implemented interfaces and base types¶
The ContourLoad is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Structure.Loads.ILoad
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| Loadcase | Loadcase | The Loadcase in which the load is applied. | - |
| Axis | LoadAxis | Defines whether the load is applied in local or global coordinates. | - |
| Projected | bool | If true the load is projected to the region. | - |
| Force | Vector | Force per area to be applied to the region. | Pressure [Pa] |
| Contour | Polyline | Closed planar polyline enclosing the region to be loaded. | - |
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 |
|---|---|---|---|---|
| IsNull | bool | Checks if a Load is null and outputs relevant error message. | - | Structure_Engine |
| IVisualize | IEnumerable<IGeometry> | Draws arrows representing the load. Visualisation will depend on the load type. | - | Structure_Engine |
| Visualize | List<ICurve> | Draws arrows representing the load along the edges of the contour of the load. | - | Structure_Engine |
Code and Schema¶
C# implementation¶
C#
public class ContourLoad : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Structure.Loads.ILoad
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/Loads/ContourLoad.json"
}
The JSON Schema is available on github here: