ifcopenshell.api.structural.add_structural_load#

Module Contents#

class ifcopenshell.api.structural.add_structural_load.Usecase(file, name=None, ifc_class='IfcStructuralLoadLinearForce')#

Adds a new structural load

Structural loads may be actions or reactions. A simple load might be a static and be linear, planar, or a single point. Alternatively, loads may be defined as a configuration of multiple loads.

Parameters
  • name (str,optional) – The name of the load

  • ifc_class (str) – The subtype of IfcStructuralLoad to create. Consult the IFC documentation to see all the types of loads.

Returns

The newly created load entity, depending on the ifc_class specified.

Return type

ifcopenshell.entity_instance.entity_instance

Example:

# Create a simple linear load
ifcopenshell.api.run("structural.add_structural_load", model)
execute(self)#